de.frame4j.graf

Class GrafHelper.MBarFactory

java.lang.Object

de.frame4j.xml.ParseErrorHandler

de.frame4j.xml.SAXHandler

de.frame4j.graf.GrafHelper.MBarFactory

All Implemented Interfaces:

ContentHandler, ErrorHandler

Enclosing interface:

GrafHelper

@MinDoc(copyright="Copyright 2005, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="see enclosing class GrafHelper",
        lastModified="see enclosing class GrafHelper",
        lastModifiedBy="A. Weinert",
        usage="make a (multilingual) XML description for a menubar and produce it",
        purpose="a factory for MenuBars")
public static class GrafHelper.MBarFactory
extends SAXHandler

The menu bar factory.

An object of this class is a SAXHandler, factoring either a MenuBar or a JMenuBar depending on the property swingy). The XML syntax — just five tags as of V.111 — is quite simple. The
example ProzessBuBMb.xml
should be sufficient to explain the syntax.

The properties of the menu elements are specified by parameters of the corresponding tags. Instead of label and shortcut parameter names prefixed by a two letter language code are allowed and evaluated using the application's or platform's set language (named la in some examples below) as a first choice. Example: de.label or pt.shortcut.

For determining menu element properties by tag parameters the following default or replacement rules apply in this sequence:

1. action = parameter action, as a substitute parameter en.label (sic!),
2. id = parameter id, as a substitute action,
3. label = parameter la.label, as a substitute label, as a substitute en.label, as a substitute id, and as last substitute action,
4. shortcut = parameter la.shortCut, as a substitute shortcut.
   If this does not give an one character value, this is interpreted as no shortcut key wanted.

Compared to the Java-Beans-XML-De/Encoder's syntax (available since JDK1.4.0) this SAXHandler's syntax to produce MenuBars or JMenuBars is

• simpler,
• compatible over AWT and the Swing versions (1.4.x / 1.5.x) and
• it provides for the (inter) nationalising of labels and shortcuts within one XML description.

Copyright © 2005 Albrecht Weinert

Version:

like embedding class

Author:

Albrecht Weinert

See Also:

de.frame4j.xml, TextHelper, PropMap

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug Debug outputs.
protected String	la Two letter language code (de, en, fr, etc.).
protected String	laLabel Language specific parameter names.
protected String	laShortcut Language specific parameter names.
protected boolean	swingy Swing, not AWT.

Fields inherited from class de.frame4j.xml.ParseErrorHandler

errorCount, fatalCount, log, name, reThrow, warningCount

Constructor Summary

Constructors

Constructor and Description
MBarFactory(CharSequence name, CharSequence language, boolean swingy, PrintWriter log) Providing the factory.

Method Summary

Modifier and Type	Method and Description
void	endElement(String namespaceURI, String localName, String qName) End of a XML element.
Object	getProduct() Deliver the product of the (ready, successful) parsing.
boolean	isDebug() Debug outputs.
MenuContainer	product() MenuContainer / result.
void	setDebug(boolean debug) Debug outputs.
void	startDocument() Re-initialise the handler.
void	startElement(String namespaceURI, String localName, String qName, Attributes atts) Start of a XML element.

Methods inherited from class de.frame4j.xml.SAXHandler

characters, endDocument, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping

Methods inherited from class de.frame4j.xml.ParseErrorHandler

appRep, error, fatalError, getName, init, report, reportErrors, toString, toStringBuilder, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ErrorHandler

error, fatalError, warning

Field Detail

swingy

protected boolean swingy

Swing, not AWT.

debug

protected boolean debug

Debug outputs.

See Also:

isDebug()

la

protected String la

Two letter language code (de, en, fr, etc.).

See Also:

laLabel, laShortcut

laLabel

protected String laLabel

Language specific parameter names.

Example: "de.label", "en.shortcut".

See Also:

la

laShortcut

protected String laShortcut

Language specific parameter names.

Example: "de.label", "en.shortcut".

See Also:

la

Constructor Detail

MBarFactory

public MBarFactory(CharSequence name,
                   CharSequence language,
                   boolean swingy,
                   PrintWriter log)

Providing the factory.

A SAXHandler inheritor is made. It's name is the parameter value or "...".

Messages and reports use the log supplied.
XML (parser / syntax) errors will stop.

Parameters:

name - the handler's name

language - the preferred language's two letter code, default en

swingy - true: Swing; false: AWT

log - the log

See Also:

ParseErrorHandler.ParseErrorHandler(CharSequence, PrintWriter, boolean)

Method Detail

startDocument

public void startDocument()

Re-initialise the handler.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class SAXHandler

See Also:

ContentHandler.startDocument()

product

public MenuContainer product()

MenuContainer / result.

This method returns the MenuBar or JMenuBar made.

Returns:

a MenuBar, JMenuBar or null.

See Also:

swingy

getProduct

public Object getProduct()

Description copied from class: SAXHandler

Deliver the product of the (ready, successful) parsing.

May or must be overridden in extending (especially anonymous) classes if necessary.

This implementation returns null.

Overrides:

getProduct in class SAXHandler

Returns:

null or object of factory's product type

isDebug

public final boolean isDebug()

Debug outputs.

If true reports on made elements will be output to ParseErrorHandler.log.

setDebug

public void setDebug(boolean debug)

Debug outputs.

See Also:

isDebug()

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Start of a XML element.

This implementation makes either a Swing or an AWT MenuBar, containing Menus with MenuItems, CheckboxMenuItems, separators or (recursively) sub menus.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class SAXHandler

Throws:

SAXException

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String qName)
                throws SAXException

End of a XML element.

For </menubar> and </menubar> this implementation organises a tree structure of sub menus down to a maximum level of three.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class SAXHandler

Throws:

SAXException

See Also:

ContentHandler.endElement(String, String, String)