jgnash.ui.util.builder
Class ActionParser

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by jgnash.ui.util.builder.ActionParser
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public final class ActionParser
extends org.xml.sax.helpers.DefaultHandler

Parses an XML file and builds JMenuBar and JToolBar UI objects

Ideas borrowed from: http://www.javadesktop.org/articles/actions/index.html

Version:
$Id$
Author:
Craig Cavanaugh

Nested Class Summary
(package private) static class ActionParser.ActionAttributes
          A simple class that holds the parsed XML Attributes.
(package private) static class ActionParser.ActionNode
           
(package private) static class ActionParser.ReflectiveAction
          AbstractAction that uses reflection to implement actionPerformed
 
Field Summary
private static java.lang.String ACCEL_ATTRIBUTE
           
private static int ACCEL_INDEX
           
private static java.lang.String ACTION_ELEMENT
           
private static java.lang.String ACTION_NODE_ELEMENT
           
private  java.util.ArrayList<ActionParser.ActionAttributes> actionList
          A list of all defined ActionAttributes
private  java.util.HashMap<java.lang.String,javax.swing.Action> actionMap
           
private  java.util.HashMap<java.lang.String,ActionParser.ActionNode> actionTrees
           
private  java.util.HashMap<java.lang.String,javax.swing.ButtonGroup> buttonGroups
           
private  ActionParser.ActionNode currentNode
           
private static java.lang.String DESC_ATTRIBUTE
           
private static int DESC_INDEX
           
private static java.lang.String EMPTY_ELEMENT
           
private static java.lang.String GROUP_ATTRIBUTE
           
private static java.lang.String ICON_ATTRIBUTE
           
private static int ICON_INDEX
           
private static java.lang.String ID_ATTRIBUTE
           
private static int ID_INDEX
           
private static java.lang.String IDREF_ATTRIBUTE
           
private  java.util.logging.Logger log
           
private  java.util.HashMap<java.lang.String,javax.swing.JMenuItem> menuItemMap
          A map of all generated JMenuItems
private static java.lang.String METHOD_ATTRIBUTE
           
private static int METHOD_INDEX
           
private static java.lang.String MNEMONIC_ATTRIBUTE
           
private static int MNEMONIC_INDEX
           
private static java.lang.String NAME_ATTRIBUTE
           
private static int NAME_INDEX
           
private  Resource rb
           
private static java.lang.String SMICON_ATTRIBUTE
           
private static int SMICON_INDEX
           
private  java.lang.Object target
          Object to invoke methods on
private static java.lang.String TYPE_ATTRIBUTE
           
private static int TYPE_INDEX
           
 
Constructor Summary
ActionParser(java.lang.Object target, Resource rb)
           
 
Method Summary
(package private)  void createActions()
          Generates ReflectiveActions
private  javax.swing.JButton createButton(ActionParser.ActionNode node)
           
 javax.swing.JMenuBar createMenuBar(java.lang.String id)
           
private  javax.swing.JMenuItem createMenuItem(ActionParser.ActionNode node)
           
 javax.swing.JToolBar createToolBar(java.lang.String id)
           
 void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
           
 javax.swing.Action getAction(java.lang.String id)
           
 javax.swing.JMenuItem getJMenuItem(java.lang.String idref)
           
(package private)  void loadFile(java.io.InputStream stream)
          Adds the set of actions and action-lists from an action-set document into the ActionManager.
 void loadFile(java.lang.String fileName)
           
 void preLoadAction(java.lang.String id, javax.swing.Action action)
           
 void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
           
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
characters, endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_ELEMENT

private static final java.lang.String ACTION_ELEMENT
See Also:
Constant Field Values

ACTION_NODE_ELEMENT

private static final java.lang.String ACTION_NODE_ELEMENT
See Also:
Constant Field Values

EMPTY_ELEMENT

private static final java.lang.String EMPTY_ELEMENT
See Also:
Constant Field Values

ACCEL_ATTRIBUTE

private static final java.lang.String ACCEL_ATTRIBUTE
See Also:
Constant Field Values

DESC_ATTRIBUTE

private static final java.lang.String DESC_ATTRIBUTE
See Also:
Constant Field Values

ICON_ATTRIBUTE

private static final java.lang.String ICON_ATTRIBUTE
See Also:
Constant Field Values

ID_ATTRIBUTE

private static final java.lang.String ID_ATTRIBUTE
See Also:
Constant Field Values

IDREF_ATTRIBUTE

private static final java.lang.String IDREF_ATTRIBUTE
See Also:
Constant Field Values

MNEMONIC_ATTRIBUTE

private static final java.lang.String MNEMONIC_ATTRIBUTE
See Also:
Constant Field Values

NAME_ATTRIBUTE

private static final java.lang.String NAME_ATTRIBUTE
See Also:
Constant Field Values

SMICON_ATTRIBUTE

private static final java.lang.String SMICON_ATTRIBUTE
See Also:
Constant Field Values

TYPE_ATTRIBUTE

private static final java.lang.String TYPE_ATTRIBUTE
See Also:
Constant Field Values

METHOD_ATTRIBUTE

private static final java.lang.String METHOD_ATTRIBUTE
See Also:
Constant Field Values

GROUP_ATTRIBUTE

private static final java.lang.String GROUP_ATTRIBUTE
See Also:
Constant Field Values

ACCEL_INDEX

private static final int ACCEL_INDEX
See Also:
Constant Field Values

DESC_INDEX

private static final int DESC_INDEX
See Also:
Constant Field Values

ICON_INDEX

private static final int ICON_INDEX
See Also:
Constant Field Values

ID_INDEX

private static final int ID_INDEX
See Also:
Constant Field Values

MNEMONIC_INDEX

private static final int MNEMONIC_INDEX
See Also:
Constant Field Values

NAME_INDEX

private static final int NAME_INDEX
See Also:
Constant Field Values

SMICON_INDEX

private static final int SMICON_INDEX
See Also:
Constant Field Values

TYPE_INDEX

private static final int TYPE_INDEX
See Also:
Constant Field Values

METHOD_INDEX

private static final int METHOD_INDEX
See Also:
Constant Field Values

actionList

private java.util.ArrayList<ActionParser.ActionAttributes> actionList
A list of all defined ActionAttributes


actionTrees

private java.util.HashMap<java.lang.String,ActionParser.ActionNode> actionTrees

actionMap

private java.util.HashMap<java.lang.String,javax.swing.Action> actionMap

menuItemMap

private java.util.HashMap<java.lang.String,javax.swing.JMenuItem> menuItemMap
A map of all generated JMenuItems


currentNode

private ActionParser.ActionNode currentNode

buttonGroups

private java.util.HashMap<java.lang.String,javax.swing.ButtonGroup> buttonGroups

target

private java.lang.Object target
Object to invoke methods on


rb

private Resource rb

log

private java.util.logging.Logger log
Constructor Detail

ActionParser

public ActionParser(java.lang.Object target,
                    Resource rb)
Method Detail

loadFile

void loadFile(java.io.InputStream stream)
Adds the set of actions and action-lists from an action-set document into the ActionManager.

Parameters:
stream - InputStream containing an actionSet document

loadFile

public void loadFile(java.lang.String fileName)

preLoadAction

public void preLoadAction(java.lang.String id,
                          javax.swing.Action action)

getAction

public javax.swing.Action getAction(java.lang.String id)

getJMenuItem

public javax.swing.JMenuItem getJMenuItem(java.lang.String idref)

createMenuBar

public javax.swing.JMenuBar createMenuBar(java.lang.String id)

createToolBar

public javax.swing.JToolBar createToolBar(java.lang.String id)

createButton

private javax.swing.JButton createButton(ActionParser.ActionNode node)

createMenuItem

private javax.swing.JMenuItem createMenuItem(ActionParser.ActionNode node)

createActions

void createActions()
Generates ReflectiveActions


endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
namespaceURI - name space
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
namespaceURI - name space
See Also:
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)