Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.knowledge.KnowledgeItem Class Reference

Crossfire JXClient, Trunk R20561

Describes a Crossfire spell. More...

Collaboration diagram for com.realtime.crossfire.jxclient.knowledge.KnowledgeItem:

Public Member Functions
void	addKnowledgeItemListener (@NotNull final KnowledgeItemListener listener)
	Adds a KnowledgeItemListener to be notified of changes. More...

int	getFaceNum ()
	Returns the face number. More...

int	getKnowledgeIndex ()
	Returns the tag ID. More...

String	getKnowledgeTitle ()
	Returns the description. More...

String	getTooltipText ()
	Returns a description for this spell to be used in tooltips. More...

String	getType ()
	Returns the knowledge's type. More...

	KnowledgeItem (final int knowledgeIndex, @NotNull final String type, @NotNull final String title, final int faceNum)
	Creates a new instance. More...

void	removeKnowledgeItemListener (@NotNull final KnowledgeItemListener listener)
	Removes a KnowledgeItemListener to be notified of changes. More...

String	toString ()

Private Member Functions
void	fireChanged ()
	Notifies all listeners. More...

Private Attributes
final int	faceNum
	The face number. More...

final int	knowledgeIndex
	The knowledge identifier. More...

final EventListenerList2< KnowledgeItemListener >	listeners = new EventListenerList2<>()
	The KnowledgeListeners to be notified of changes. More...

String	title = ""
	The description. More...

final String	type
	The knowledge's type. More...

Detailed Description

Describes a Crossfire spell.

Author: Lauwenmark

Definition at line 31 of file KnowledgeItem.java.

Constructor & Destructor Documentation

◆ KnowledgeItem()

com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.KnowledgeItem	(	final int	knowledgeIndex,
		@NotNull final String	type,
		@NotNull final String	title,
		final int	faceNum
	)

Creates a new instance.

Parameters

knowledgeIndex	the knowledge identifier
type	the knowledge's type
title	the description
faceNum	the face number

Definition at line 69 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.faceNum, com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.knowledgeIndex, com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.title, and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.type.

Member Function Documentation

◆ addKnowledgeItemListener()

void com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.addKnowledgeItemListener ( @NotNull final KnowledgeItemListener listener )

Adds a KnowledgeItemListener to be notified of changes.

Parameters

listener the listener to add

Definition at line 132 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.util.EventListenerList2< T extends EventListener >.add().

Here is the call graph for this function:

◆ fireChanged()

void com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.fireChanged ( )

private

Notifies all listeners.

Definition at line 122 of file KnowledgeItem.java.

◆ getFaceNum()

int com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getFaceNum ( )

Returns the face number.

Returns: the face number

Definition at line 97 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.faceNum.

Referenced by com.realtime.crossfire.jxclient.items.KnowledgeView.getItem().

Here is the caller graph for this function:

◆ getKnowledgeIndex()

int com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getKnowledgeIndex ( )

Returns the tag ID.

Returns: the tag ID

Definition at line 80 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.knowledgeIndex.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.button1Clicked(), and com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.button2Clicked().

Here is the caller graph for this function:

◆ getKnowledgeTitle()

String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getKnowledgeTitle ( )

Returns the description.

Returns: the description

Definition at line 89 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.title.

Referenced by com.realtime.crossfire.jxclient.items.KnowledgeView.getItem().

Here is the caller graph for this function:

◆ getTooltipText()

String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getTooltipText ( )

Returns a description for this spell to be used in tooltips.

Returns: the tooltip text

Definition at line 115 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.title.

◆ getType()

String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getType ( )

Returns the knowledge's type.

Returns: the type

Definition at line 149 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.type.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.button2Clicked().

Here is the caller graph for this function:

◆ removeKnowledgeItemListener()

void com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.removeKnowledgeItemListener ( @NotNull final KnowledgeItemListener listener )

Removes a KnowledgeItemListener to be notified of changes.

Parameters

listener the listener to remove

Definition at line 140 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.util.EventListenerList2< T extends EventListener >.remove().

Here is the call graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.toString ( )

Definition at line 106 of file KnowledgeItem.java.

References com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.faceNum.

Member Data Documentation

◆ faceNum

final int com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.faceNum

private

The face number.

Definition at line 60 of file KnowledgeItem.java.

Referenced by com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getFaceNum(), com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.KnowledgeItem(), and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.toString().

◆ knowledgeIndex

final int com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.knowledgeIndex

private

The knowledge identifier.

Definition at line 43 of file KnowledgeItem.java.

Referenced by com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getKnowledgeIndex(), and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.KnowledgeItem().

◆ listeners

final EventListenerList2<KnowledgeItemListener> com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.listeners = new EventListenerList2<>()

private

The KnowledgeListeners to be notified of changes.

Definition at line 38 of file KnowledgeItem.java.

◆ title

String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.title = ""

private

The description.

Definition at line 55 of file KnowledgeItem.java.

Referenced by com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getKnowledgeTitle(), com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getTooltipText(), and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.KnowledgeItem().

◆ type

final String com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.type

private

The knowledge's type.

Definition at line 49 of file KnowledgeItem.java.

Referenced by com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.getType(), and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.KnowledgeItem().

The documentation for this class was generated from the following file:

crossfire-code/jxclient/trunk/src/model/src/main/java/com/realtime/crossfire/jxclient/knowledge/KnowledgeItem.java