    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xm.xm_NodeTypeDefn

    java.lang.Object
       |
       +----xm.xm_NodeTypeDefn

public class xm_NodeTypeDefn
extends Object

The full definition of a particular type of XML node. It can be used for both 'built in' types and special types.

##

CustomizerClassName
  Name of the class used for customizing (on-screen editing of) nodes of this type.
NodeClassName
  Name of the class used to represent nodes of this type.
NodeName
  The name of this type of node.
NodeType
  The type of this node.
NodeTypeString
  A string representation of the type of this node (for display purposes only).
ParserClassName
  Name of the class used to parse nodes of this type.
ViewClassName
  Name of the class used for displaying nodes of this type (in a JEditorPane).

##

xm_NodeTypeDefn(String, int, String, String, String, String, String)
  Construct a node type definition.

##

getCustomizerClassName()
  Get the name of the class used to customize nodes of this type.
getName()
  Get the name of the node.
getNodeClassName()
  Get the name of the class used to represent nodes of this type.
getParserClassName()
  Get the name of the class used to parse nodes of this type.
getType()
  Get the node type.
getTypeString()
  Get the string representation of the type of the node type.
getViewClassName()
  Get the name of the class used to display nodes of this type.
listToDebug()
  Output this node type definition to debug.
setCustomizerClassName(String)
  Set the name of the class used to customize nodes of this type.
setName(String)
  Set the name of this node.
setNodeClassName(String)
  Set the name of the class used to represent nodes of this type.
setParserClassName(String)
  Set the name of the class used to parse nodes of this type.
setType(int)
  Set the node type.
setTypeString(String)
  Set the string representation of this node type.
setViewClassName(String)
  Set the name of the class used to display nodes of this type.
toString()
  Return a string representation of this node type definition - mainly to be used for debug purposes.

##

NodeName

     protected String NodeName

  The name of this type of node. For elements, this can be used for the element name.

NodeType

     protected int NodeType

  The type of this node. Only the fixed, pre-defined XML types should be used here.

NodeTypeString

     protected String NodeTypeString

  A string representation of the type of this node (for display purposes only).

NodeClassName

     protected String NodeClassName

  Name of the class used to represent nodes of this type.

ParserClassName

     protected String ParserClassName

  Name of the class used to parse nodes of this type.

CustomizerClassName

     protected String CustomizerClassName

  Name of the class used for customizing (on-screen editing of) nodes of this type.

ViewClassName

     protected String ViewClassName

  Name of the class used for displaying nodes of this type (in a JEditorPane). Classes named here must be derived from swing.text.View.

##

xm_NodeTypeDefn

     public xm_NodeTypeDefn(String InputNodeName,
                            int InputNodeType,
                            String InputNodeTypeString,
                            String InputNodeClassName,
                            String InputParserClassName,
                            String InputCustomizerClassName,
                            String InputViewClassName)

  Construct a node type definition.

  Parameters:
    InputNodeName - The name of this node type
    InputNodeType - Type of the node
    InputNodeTypeString - String representation of the node type
    InputNodeClassName - Name of the class used to represent nodes of this type
    InputParserClassName - Name of the class used to parse nodes of this type
    InputCustomizerClassName - Name of the class used to customize nodes of this type
    InputViewClassName - Name of the class used to display nodes of this type

##

getName

     public String getName()

  Get the name of the node.

  Returns:
    The name of the node

getType

     public int getType()

  Get the node type.

  Returns:
    The node type

getTypeString

     public String getTypeString()

  Get the string representation of the type of the node type.

  Returns:
    String representation of the node type

getNodeClassName

     public String getNodeClassName()

  Get the name of the class used to represent nodes of this type.

  Returns:
    The node class name

getParserClassName

     public String getParserClassName()

  Get the name of the class used to parse nodes of this type.

  Returns:
    The parser class name

getCustomizerClassName

     public String getCustomizerClassName()

  Get the name of the class used to customize nodes of this type.

  Returns:
    The customizer class name

getViewClassName

     public String getViewClassName()

  Get the name of the class used to display nodes of this type.

  Returns:
    The view class name

toString

     public String toString()

  Return a string representation of this node type definition - mainly to be used for debug purposes.

  Returns:
    String representation of this node type definition
  Overrides:
    toString in class Object

setName

     public void setName(String InputNodeName)

  Set the name of this node.

  Parameters:
    InputNodeName - Name of this node

setType

     public void setType(int InputNodeType)

  Set the node type.

  Parameters:
    InputNodeType - The node type

setTypeString

     public void setTypeString(String InputNodeTypeString)

  Set the string representation of this node type.

  Parameters:
    InputNodeTypeString - String representation of this node type

setNodeClassName

     public void setNodeClassName(String InputNodeClassName)

  Set the name of the class used to represent nodes of this type.

  Parameters:
    InputNodeClassName - Name of node class

setParserClassName

     public void setParserClassName(String InputParserClassName)

  Set the name of the class used to parse nodes of this type.

  Parameters:
    InputParserClassName - Name of parser class

setCustomizerClassName

     public void setCustomizerClassName(String InputCustomizerClassName)

  Set the name of the class used to customize nodes of this type.

  Parameters:
    InputCustomizerClassName - Name of customizer class

setViewClassName

     public void setViewClassName(String InputViewClassName)

  Set the name of the class used to display nodes of this type.

  Parameters:
    InputViewClassName - Name of view class

listToDebug

     public void listToDebug()

  Output this node type definition to debug.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index