story.scheherazade.virgil.help
Class Icon

java.lang.Object
  story.scheherazade.virgil.help.Icon

public class Icon
extends java.lang.Object

The purpose of this class is to represent the Scheherazade Icon data structure. The structure consists of an ID (name), a keyword, and a statement about this keyword

Author:

Marshall

Field Summary

static java.lang.String	I_ID
static java.lang.String	KEYWORD
static java.lang.String	STATEMENT

Constructor Summary

Icon(org.w3c.dom.Node node)
Constructor for creating an Icon object from a node

Icon(java.lang.String ID, java.lang.String keyword, java.lang.String statement)
Constructor to explicitly create an Icon Object

Method Summary

java.lang.String	getID() Returns the ID of the Icon
java.lang.String	getKeyword() Returns the KEYWORD of the Icon
java.lang.String	getStatement() Returns the STATEMENT of the Icon

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

I_ID

public static final java.lang.String I_ID

See Also:

Constant Field Values

KEYWORD

public static final java.lang.String KEYWORD

See Also:

Constant Field Values

STATEMENT

public static final java.lang.String STATEMENT

See Also:

Constant Field Values

Constructor Detail

Icon

public Icon(java.lang.String ID,
            java.lang.String keyword,
            java.lang.String statement)

Constructor to explicitly create an Icon Object

Parameters:

the - ID of the Icon

The - button name

The - description of the button

Icon

public Icon(org.w3c.dom.Node node)
     throws java.lang.Exception

Constructor for creating an Icon object from a node

Parameters:

node - a Icon represented as a Node data structure that has children in the form of a Keyword and a Statement

Throws:

java.lang.Exception

Method Detail

getID

public java.lang.String getID()

Returns the ID of the Icon

Returns:

the ID of the Icon

getKeyword

public java.lang.String getKeyword()

Returns the KEYWORD of the Icon

Returns:

the KEYWORD of the Icon

getStatement

public java.lang.String getStatement()

Returns the STATEMENT of the Icon

Returns:

the STATEMENT of the Icon