    All Packages  Class Hierarchy

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

# Index of all Fields and Methods

## A

actionPerformed(ActionEvent). Method in class xm.xm_NodeTypeRegistryListAction
addProgressBar(). Method in class xm.xm_StatusBar
  Add the progress bar to the status bar.
addSpecialNamesTab(). Method in class xm.xm_NodeTypeRegistryDialog
  Add 'Special names' tab to display details about the special XML element names which are currently registered.
addStandardTypesTab(). Method in class xm.xm_NodeTypeRegistryDialog
  Add 'Standard types' tab to display details about the standard XML types currently registered.

## C

checkClassExistence(String, String). Method in class xm.xm_NodeTypeDefaultsElement
  Check that the class exists.
checkClassExistence(String, String). Method in class xm.xm_NodeTypeElement
  Check that the class exists.
checkClassType(Class, String, String). Static method in class xm.xm_Factory
  Check that the InputClass is derived from InputUsualClassName.
clear(). Method in class xm.xm_DocumentModel
  Clear this document, ready to start afresh.
convertToType(String). Static method in class xm.xm_NodeTypeRegistry
  Convert to a type the node type whose name is InputKeywordValue.
createEntity(String, int, String). Static method in class xm.xm_NodeFactory

  Create an entity of the type suitable for the entity whose name is InputNodeName.

createNode(String, int, String). Static method in class xm.xm_NodeFactory

  Create a node of the type suitable for the entity whose name is InputNodeName.

createXmlEngine(String). Static method in class xm.xm_XmlEngineFactory
  Create an XML engine as an instance of the class whose name is InputEngineClassName.
createXmlEngine(xg_AttList). Static method in class xm.xm_XmlEngineFactory
  Create an XML engine of a type defined by the InputEngineAttributes.
CustomizerClassAttName. Static variable in class xm.xm_NodeTypeDefaultsElement
  The name of the attribute which holds the name of the default customizer class.
CustomizerClassAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the name of the customizer class.
CustomizerClassName. Variable in class xm.xm_NodeTypeDefn
  Name of the class used for customizing (on-screen editing of) nodes of this type.

## D

DescriptionAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the description of this entry.
DesiredMaxLineLength. Variable in class xm.xm_SimpleNodeFormatter
  The source line length we would rather not exceed.

## E

endNode(xg_Node, int). Method in class xm.xm_DocumentModel
  The end of a node has been parsed.
endNode(xg_Node, int). Method in interface xm.xm_ParseListener
  The end of a node has been parsed.
endParseSuccessful(). Method in class xm.xm_DocumentModel
  The parse has completed successfully.
endParseSuccessful(). Method in interface xm.xm_ParseListener
  The parse has completed successfully.
endParseUnsuccessful(). Method in class xm.xm_DocumentModel
  The parse has completed, but not successfully.
endParseUnsuccessful(). Method in interface xm.xm_ParseListener
  The parse has completed, but not successfully.
EngineAttList. Variable in class xm.xm_XmlEngine
  List of configuration attributes for this engine.
EngineAttName. Static variable in class xm.xm_XmlEngineFactory
  The name of the attribute in an attribute list whose value is the name of an XML engine's class.
ensureInitialised(). Static method in class xm.xm_NodeTypeRegistry
  Ensure the hashtables of the keywords are initialised with their definitions (ie.

## F

FixedPrecedingWhitespace. Variable in class xm.xm_SimpleNodeFormatter
  The piece of whitespace which always precedes a node (except the top-level node).
format(xg_Node). Method in class xm.xm_NodeFormatter
  Format the given node, and its children.
format(xg_Node, int). Method in class xm.xm_AttToChildConverter
  Convert the given node, and its children.
format(xg_Node, int). Method in class xm.xm_NodeFormatter
  Format the given node, and its children.
format(xg_Node, int). Method in class xm.xm_SimpleNodeFormatter
  Format the given node, and its children.
formatChildren(xg_Node, int). Method in class xm.xm_NodeFormatter
  Format the children of the given node, and its children.

## G

getAttList(). Method in class xm.xm_XmlEngine
  Get this engine's attributes.
getColumnNum(). Method in class xm.xm_ParseException
  Get the number of the source column at which the exception occurred.
getCurrentDocument(). Method in class xm.xm_DocumentModel
  Get the last XML document which was parsed.
getCustomizerClassName(). Method in class xm.xm_NodeTypeDefn
  Get the name of the class used to customize nodes of this type.
getDefaultCustomizerClassName(). Static method in class xm.xm_NodeTypeRegistry
  Get the default name of the class used to customize nodes.
getDefaultParserClassName(). Static method in class xm.xm_NodeTypeRegistry
  Get the default name of the class used to parse nodes.
getDefaultRootElement(). Method in class xm.xm_DocumentModel
  Get the default root element.
getDefaultViewClassName(). Static method in class xm.xm_NodeTypeRegistry
  Get the default name of the class used to display nodes.
getDefn(int). Static method in class xm.xm_NodeTypeRegistry
  Get the node type definition of the node whose type is InputNodeTypeName.
getDefn(String). Static method in class xm.xm_NodeTypeRegistry
  Get the node type definition of the node whose name is InputNodeTypeName.
getDefn(String, int). Static method in class xm.xm_NodeTypeRegistry
  Get the node type definition of the node whose name is InputNodeTypeName.
getDesiredMaxLineLength(). Method in class xm.xm_SimpleNodeFormatter
  Get the source line length we would rather not exceed.
getDocumentModel(). Method in class xm.xm_NodeTypeEditDialog
  Retrieve the document model into which we placed the analysed structure of the database.
getDocumentModel(). Method in class xm.xm_NodeTypeRegistryDialog
  Retrieve the document model into which we placed the analysed structure of the database.
getDocumentTreeModel(). Method in class xm.xm_DocumentModel
  Get the tree model of the current document.
getFixedPrecedingWhitespace(). Method in class xm.xm_SimpleNodeFormatter
  Get the piece of whitespace which always precedes a node.
getFont(AttributeSet). Method in class xm.xm_DocumentModel
  Get the font from an attribute set.
getForeground(AttributeSet). Method in class xm.xm_DocumentModel
  Get the color to be used for the foreground, based on the value of the 'color' attribute in the InputAttributeSet.
getLastSignificantPosition(). Method in class xm.xm_ParseException
  Get the position in the source at which the last significant item occurred.
getLineNum(). Method in class xm.xm_ParseException
  Get the number of the source line at which the exception occurred.
getMessage2(). Method in class xm.xm_ParseException
  Get a string representation of this exception.
getName(). Method in class xm.xm_NodeTypeDefn
  Get the name of the node.
getNodeClassName(). Method in class xm.xm_NodeTypeDefn
  Get the name of the class used to represent nodes of this type.
getParsePosition(). Method in class xm.xm_ParseException
  Get the position in the source (number of characters) when the exception occurred.
getParserClassName(). Method in class xm.xm_NodeTypeDefn
  Get the name of the class used to parse nodes of this type.
getParseStatsText(long). Method in class xm.xm_XmlEngine
  Prepare and return a string describing how much was parsed, and how fast.
getPerLevelPrecedingWhitespace(). Method in class xm.xm_SimpleNodeFormatter
  Get the piece of whitespace to precede a node for each level deep the node is in its hierarchy.
getPrependParentNameFlag(). Method in class xm.xm_AttToChildConverter
  Get the value of the flag which determines whether elements generated from attributes have their parent's type prepended.
getProgressBar(). Method in class xm.xm_StatusBar
  Get the progress bar.
getRootElements(). Method in class xm.xm_DocumentModel
  Get all the root elements which are defined.
getSourceString(). Method in class xm.xm_DocumentModel
  Get the current source in the form of a string.
getStatusBar(). Method in class xm.xm_DocumentModel
  Get the status bar.
getStatusMessage(). Method in class xm.xm_XmlEngine
  Get a text message explaining the last status message which was set.
getStyledEditModeFlag(). Method in class xm.xm_DocumentModel
  Get the styled edit mode flag.
getSummaryString(). Method in class xm.xm_NodeTypeDefaultsElement
  Get a summary descriptive string suitable for display in the tree view or elsewhere.
getSummaryString(). Method in class xm.xm_NodeTypeElement
  Get a summary descriptive string suitable for display in the tree view or elsewhere.
getType(). Method in class xm.xm_NodeTypeDefn
  Get the node type.
getTypeString(). Method in class xm.xm_NodeTypeDefn
  Get the string representation of the type of the node type.
getValidateFlag(). Method in class xm.xm_XmlEngine
  Get the flag to control whether to validate the document.
getVerifyFlag(). Method in class xm.xm_XmlEngine
  Get the flag to control whether to verify the document.
getViewClassName(). Method in class xm.xm_NodeTypeDefn
  Get the name of the class used to display nodes of this type.
getXmlEngine(). Method in class xm.xm_DocumentModel
  Get the XML processor.

## I

initialise(). Static method in class xm.xm_NodeTypeRegistry
  Initialise the hashtables of the keywords with their definitions.
initScreen(). Method in class xm.xm_NodeTypeEditDialog
  Initialise the screen.
initScreen(). Method in class xm.xm_NodeTypeRegistryDialog
  Initialise the screen.

## L

listHashtableToDebug(Hashtable). Static method in class xm.xm_NodeTypeRegistry
  Output a list of all the registered node types in the given hash table to debug.
listToDebug(). Method in class xm.xm_NodeTypeDefn
  Output this node type definition to debug.
listToDebug(). Static method in class xm.xm_NodeTypeRegistry
  Output a list of all registered node types to debug.
LOAD. Static variable in class xm.xm_ParseThread
  We will load the source file into the source string.
LOAD_AND_PARSE_STRING. Static variable in class xm.xm_ParseThread
  We will load the source file into the source string and then parse it.

## N

NameAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the name of the node to which this registry entry relates.
NodeClassAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the name of the node class.
NodeClassName. Variable in class xm.xm_NodeTypeDefn
  Name of the class used to represent nodes of this type.
NodeName. Variable in class xm.xm_NodeTypeDefn
  The name of this type of node.
NodeType. Variable in class xm.xm_NodeTypeDefn
  The type of this node.
NodeTypeString. Variable in class xm.xm_NodeTypeDefn
  A string representation of the type of this node (for display purposes only).

## P

PARSE_FILE. Static variable in class xm.xm_ParseThread
  We will parse the source file directly, without loading it into the source string.
PARSE_STRING. Static variable in class xm.xm_ParseThread
  We will parse the source string.
parseFile(String). Method in class xm.xm_XmlEngine
  Parse the file represented by InputFileName.
parseFile(String, xg_Document). Method in class xm.xm_XmlEngine
  Parse the file represented by InputFileName.
ParserClassAttName. Static variable in class xm.xm_NodeTypeDefaultsElement
  The name of the attribute which holds the name of the default parser class.
ParserClassAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the name of the parser class.
ParserClassName. Variable in class xm.xm_NodeTypeDefn
  Name of the class used to parse nodes of this type.
parseSource(Reader, xg_Document). Method in class xm.xm_XmlEngine
  Parse the source supplied by the InputSourceReader.
parseString(String). Method in class xm.xm_XmlEngine
  Parse an XML source which is held in string InputSourceString.
parseString(String, xg_Document). Method in class xm.xm_XmlEngine
  Parse an XML source which is held in string InputSourceString.
PerLevelPrecedingWhitespace. Variable in class xm.xm_SimpleNodeFormatter
  The piece of whitespace to precede a node for each level deep the node is in its hierarchy.
prepareProgressBar(int, int, String). Method in class xm.xm_Thread
  Add a progress bar to the status bar (if there is a status bar), and display a message on the status bar.

## R

register(int, String, String, String, String, String). Static method in class xm.xm_NodeTypeRegistry
  Register a node type - without a node name.
register(String, int, String, String, String, String, String). Static method in class xm.xm_NodeTypeRegistry
  Register a node type.
register(String, String). Static method in class xm.xm_NodeTypeRegistry
  Register a node name.
register(String, String, String). Static method in class xm.xm_NodeTypeRegistry
  Register a node name.
register(String, String, String, String, String). Static method in class xm.xm_NodeTypeRegistry
  Register a node name.
RegisteredName. Static variable in class xm.xm_NodeTypeDefaultsElement
  The element type name normally used in XML for this sort of element.
RegisteredName. Static variable in class xm.xm_NodeTypeElement
  The element type name normally used in XML for this sort of element.
removeProgressBar(). Method in class xm.xm_StatusBar
  Remove the progress bar from the status bar.
removeProgressBar(int, String). Method in class xm.xm_Thread
  Remove the progress bar from the status bar (if there is a status bar).
run(). Method in class xm.xm_FileLoader
  Run the thread - to be overridden in derived classes.
run(). Method in class xm.xm_ParseThread
  Load the file and/or execute the parse (depending on mode).
run(). Method in class xm.xm_Thread
  Run the thread - to be overridden in derived classes.

## S

save(String). Method in class xm.xm_DocumentModel
  Save this document to the named file.
saveFromSource(String). Method in class xm.xm_DocumentModel
  Save the source of this document to the named file.
setAttList(xg_AttList). Method in class xm.xm_XmlEngine
  Give this engine a set of attributes.
setCustomizerClassName(String). Method in class xm.xm_NodeTypeDefn
  Set the name of the class used to customize nodes of this type.
setDefaultCustomizerClassName(String). Static method in class xm.xm_NodeTypeRegistry
  Set the default name of the class used to customize nodes.
setDefaultParserClassName(String). Static method in class xm.xm_NodeTypeRegistry
  Set the default name of the class used to parse nodes.
setDefaultViewClassName(String). Static method in class xm.xm_NodeTypeRegistry
  Set the default name of the class used to display nodes.
setDesiredMaxLineLength(int). Method in class xm.xm_SimpleNodeFormatter
  Set the source line length we would rather not exceed.
setDocumentModel(xm_DocumentModel). Method in class xm.xm_NodeTypeEditDialog
  Pass in the document model into which we are to place the analysed structure of the database.
setDocumentModel(xm_DocumentModel). Method in class xm.xm_NodeTypeRegistryDialog
  Pass in the document model into which we are to place the analysed structure of the database.
setFixedPrecedingWhitespace(String). Method in class xm.xm_SimpleNodeFormatter
  Set the piece of whitespace which always precedes a node.
setName(String). Method in class xm.xm_NodeTypeDefn
  Set the name of this node.
setNodeClassName(String). Method in class xm.xm_NodeTypeDefn
  Set the name of the class used to represent nodes of this type.
setParseListener(xm_ParseListener). Method in class xm.xm_XmlEngine
  Set the parse listener which is to be informed of parse events.
setParserClassName(String). Method in class xm.xm_NodeTypeDefn
  Set the name of the class used to parse nodes of this type.
setPerLevelPrecedingWhitespace(String). Method in class xm.xm_SimpleNodeFormatter
  Set the piece of whitespace to precede a node for each level deep the node is in its hierarchy.
setPrependParentNameFlag(boolean). Method in class xm.xm_AttToChildConverter
  Set the value of the flag which determines whether elements generated from attributes have their parent's type prepended.
setStatusBar(xm_StatusBar). Method in class xm.xm_DocumentModel
  Set the status bar for displaying parse progress.
setStyledEditModeFlag(boolean). Method in class xm.xm_DocumentModel
  Set the styled edit mode flag.
setText(int, String). Method in class xm.xm_StatusBar
  Set the text in the status bar.
setText(String). Method in class xm.xm_StatusBar
  Set the text in the status bar.
setThreadMode(int). Method in class xm.xm_ParseThread
  Set this thread's mode, which defines which actions it will take.
setType(int). Method in class xm.xm_NodeTypeDefn
  Set the node type.
setTypeString(String). Method in class xm.xm_NodeTypeDefn
  Set the string representation of this node type.
setValidateFlag(boolean). Method in class xm.xm_XmlEngine
  Set the flag to control whether to validate the document.
setVerifyFlag(boolean). Method in class xm.xm_XmlEngine
  Set the flag to control whether to verify the document.
setViewClassName(String). Method in class xm.xm_NodeTypeDefn
  Set the name of the class used to display nodes of this type.
setXmlEngine(xm_XmlEngine). Method in class xm.xm_DocumentModel
  Set the XML processor to be used to process this document.
SourceReader. Variable in class xm.xm_XmlEngine
  The origin of the XML source being parsed.
startNode(xg_Node, int). Method in class xm.xm_DocumentModel
  The start of a node has been parsed.
startNode(xg_Node, int). Method in interface xm.xm_ParseListener
  The start of a node has been parsed.
StatusMessage. Variable in class xm.xm_XmlEngine
  A textual explanation of the most recent parse status.

## T

toString(). Method in class xm.xm_NodeTypeDefaultsElement
  Return a string representation of the element (intended for use as debug output).
toString(). Method in class xm.xm_NodeTypeDefn
  Return a string representation of this node type definition - mainly to be used for debug purposes.
toString(). Method in class xm.xm_NodeTypeElement
  Return a string representation of the element (intended for use as debug output).
toString(int). Static method in class xm.xm_NodeTypeRegistry
  Convert to a string the node type definition whose type is InputNodeType.

## U

UNKNOWN. Static variable in class xm.xm_NodeTypeRegistry
  Unknown keyword type

## V

validateContainerHierarchy(). Method in class xm.xm_StatusBar
  Validate from the top of the containment hierarchy.
validateContainerHierarchy(). Method in class xm.xm_Thread
  Validate from the top of the containment hierarchy.
ValidateFlag. Variable in class xm.xm_XmlEngine
  Flag to specify whether the document should be validated (if a validating parser is being used).
verify(). Method in class xm.xm_NodeTypeDefaultsElement

  Verify that this node is correct (ie.

verify(). Method in class xm.xm_NodeTypeElement

  Verify that this node is correct (ie.

VerifyFlag. Variable in class xm.xm_XmlEngine
  Flag to specify whether the document should be verified (if a parser supporting verification is being used).
ViewClassAttName. Static variable in class xm.xm_NodeTypeDefaultsElement
  The name of the attribute which holds the name of the default view class.
ViewClassAttName. Static variable in class xm.xm_NodeTypeElement
  The name of the attribute which holds the name of the view class.
ViewClassName. Variable in class xm.xm_NodeTypeDefn
  Name of the class used for displaying nodes of this type (in a JEditorPane).

## X

xm_AttToChildConverter(). Constructor for class xm.xm_AttToChildConverter
xm_DocumentModel(xm_XmlEngine). Constructor for class xm.xm_DocumentModel
  Constructor.
xm_Factory(). Constructor for class xm.xm_Factory
xm_FileLoader(String, Document, xm_StatusBar). Constructor for class xm.xm_FileLoader
  Constructor.
xm_NodeFactory(). Constructor for class xm.xm_NodeFactory
xm_NodeFormatter(). Constructor for class xm.xm_NodeFormatter
xm_NodeTypeDefaultsElement(). Constructor for class xm.xm_NodeTypeDefaultsElement
  Construct a node type defaults element with no name.
xm_NodeTypeDefaultsElement(String). Constructor for class xm.xm_NodeTypeDefaultsElement
  Construct a node type defaults element with a name.
xm_NodeTypeDefn(String, int, String, String, String, String, String). Constructor for class xm.xm_NodeTypeDefn
  Construct a node type definition.
xm_NodeTypeEditDialog(Frame). Constructor for class xm.xm_NodeTypeEditDialog
  Constructor.
xm_NodeTypeEditDialog(Frame, xm_DocumentModel). Constructor for class xm.xm_NodeTypeEditDialog
  Constructor.
xm_NodeTypeElement(). Constructor for class xm.xm_NodeTypeElement
  Construct a node type registry entry element with no name.
xm_NodeTypeElement(String). Constructor for class xm.xm_NodeTypeElement
  Construct a node type registry entry element with a name.
xm_NodeTypeRegistry(). Constructor for class xm.xm_NodeTypeRegistry
xm_NodeTypeRegistryDialog(Frame). Constructor for class xm.xm_NodeTypeRegistryDialog
  Constructor.
xm_NodeTypeRegistryDialog(Frame, xm_DocumentModel). Constructor for class xm.xm_NodeTypeRegistryDialog
  Constructor.
xm_NodeTypeRegistryListAction(). Constructor for class xm.xm_NodeTypeRegistryListAction
  Default constructor.
xm_ParseException(String). Constructor for class xm.xm_ParseException
  Constructor.
xm_ParseException(String, int, int). Constructor for class xm.xm_ParseException
  Constructor.
xm_ParseException(String, int, int, int, int). Constructor for class xm.xm_ParseException
  Constructor.
xm_ParseThread(int, String, xm_DocumentModel, JTextArea). Constructor for class xm.xm_ParseThread
  Constructor.
xm_ParseThread(xm_DocumentModel, JTextArea). Constructor for class xm.xm_ParseThread
  Constructor, omitting file pathname.
xm_SimpleNodeFormatter(). Constructor for class xm.xm_SimpleNodeFormatter
xm_StatusBar(). Constructor for class xm.xm_StatusBar
  Constructor.
xm_Thread(xm_StatusBar). Constructor for class xm.xm_Thread
  Constructor.
xm_XmlEngine(). Constructor for class xm.xm_XmlEngine
  Constructor.
xm_XmlEngineFactory(). Constructor for class xm.xm_XmlEngineFactory