com.realtime.crossfire.jxclient.knowledge

Class KnowledgeItem

java.lang.Object

com.realtime.crossfire.jxclient.knowledge.KnowledgeItem

public class KnowledgeItem
extends java.lang.Object

Describes a Crossfire spell.

Constructor Summary

Constructors

Constructor and Description
KnowledgeItem(int knowledgeIndex, @NotNull java.lang.String type, @NotNull java.lang.String title, int faceNum) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addKnowledgeItemListener(@NotNull KnowledgeItemListener listener) Adds a KnowledgeItemListener to be notified of changes.
int	getFaceNum() Returns the face number.
int	getKnowledgeIndex() Returns the tag ID.
@NotNull java.lang.String	getKnowledgeTitle() Returns the description.
@NotNull java.lang.String	getTooltipText() Returns a description for this spell to be used in tooltips.
@NotNull java.lang.String	getType() Returns the knowledge's type.
void	removeKnowledgeItemListener(@NotNull KnowledgeItemListener listener) Removes a KnowledgeItemListener to be notified of changes.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeItem

public KnowledgeItem(int knowledgeIndex,
                     @NotNull
                     @NotNull java.lang.String type,
                     @NotNull
                     @NotNull java.lang.String title,
                     int faceNum)

Creates a new instance.

Parameters:

knowledgeIndex - the knowledge identifier

type - the knowledge's type

title - the description

faceNum - the face number

Method Detail

getKnowledgeIndex

public int getKnowledgeIndex()

Returns the tag ID.

Returns:

the tag ID

getKnowledgeTitle

@NotNull
public @NotNull java.lang.String getKnowledgeTitle()

Returns the description.

Returns:

the description

getFaceNum

public int getFaceNum()

Returns the face number.

Returns:

the face number

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTooltipText

@NotNull
public @NotNull java.lang.String getTooltipText()

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

Returns:

the tooltip text

addKnowledgeItemListener

public void addKnowledgeItemListener(@NotNull
                                     @NotNull KnowledgeItemListener listener)

Adds a KnowledgeItemListener to be notified of changes.

Parameters:

listener - the listener to add

removeKnowledgeItemListener

public void removeKnowledgeItemListener(@NotNull
                                        @NotNull KnowledgeItemListener listener)

Removes a KnowledgeItemListener to be notified of changes.

Parameters:

listener - the listener to remove

getType

@NotNull
public @NotNull java.lang.String getType()

Returns the knowledge's type.

Returns:

the type