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

Crossfire JXClient, Trunk

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

Collaboration graph

Public Member Functions
void	addKnowledgeItemListener (@NotNull final KnowledgeItemListener listener)

int	getFaceNum ()

int	getKnowledgeIndex ()

String	getKnowledgeTitle ()

String	getTooltipText ()

String	getType ()

	KnowledgeItem (final int knowledgeIndex, @NotNull final String type, @NotNull final String title, final int faceNum)

void	removeKnowledgeItemListener (@NotNull final KnowledgeItemListener listener)

String	toString ()

Private Member Functions
void	fireChanged ()

Private Attributes
final int	faceNum

final int	knowledgeIndex

final EventListenerList2< KnowledgeItemListener >	listeners = new EventListenerList2<>()

String	title = ""

final String	type

Detailed Description

Describes a Crossfire spell.

Author: Lauwenmark

Definition at line 32 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 70 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 130 of file KnowledgeItem.java.

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

◆ fireChanged()

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

private

Notifies all listeners.

Definition at line 120 of file KnowledgeItem.java.

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

◆ getFaceNum()

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

Returns the face number.

Returns: the face number

Definition at line 98 of file KnowledgeItem.java.

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

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.getFace(), and 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 81 of file KnowledgeItem.java.

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

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

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 90 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 113 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 147 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 138 of file KnowledgeItem.java.

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

◆ toString()

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

Definition at line 104 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 Data Documentation

◆ faceNum

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

private

The face number.

Definition at line 61 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 44 of file KnowledgeItem.java.

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

◆ listeners

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

private

The KnowledgeListeners to be notified of changes.

Definition at line 39 of file KnowledgeItem.java.

Referenced by com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.addKnowledgeItemListener(), com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.fireChanged(), and com.realtime.crossfire.jxclient.knowledge.KnowledgeItem.removeKnowledgeItemListener().

◆ title

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

private

The description.

Definition at line 56 of file KnowledgeItem.java.

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

◆ type

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

private

The knowledge's type.

Definition at line 50 of file KnowledgeItem.java.

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

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

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