org.dspace.app.xmlui.wing.element
Class Help

java.lang.Object
  org.dspace.app.xmlui.wing.element.AbstractWingElement
      org.dspace.app.xmlui.wing.element.Container
          org.dspace.app.xmlui.wing.element.TextContainer
              org.dspace.app.xmlui.wing.element.Help

All Implemented Interfaces:

StructuralElement, WingElement

public class Help
extends TextContainer
implements StructuralElement

This class represents help instructions for a single field.

Author:

Scott Phillips

Field Summary

static String

E_HELP The name of the help element

Fields inherited from class org.dspace.app.xmlui.wing.element.Container

contents

Fields inherited from class org.dspace.app.xmlui.wing.element.AbstractWingElement

context

Fields inherited from interface org.dspace.app.xmlui.wing.element.StructuralElement

A_ID, A_NAME, A_RENDER

Constructor Summary

protected

Help(WingContext context) Construct a new field help.

Method Summary

void	toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, NamespaceSupport namespaces) Translate this element and all contained elements into SAX events.

Methods inherited from class org.dspace.app.xmlui.wing.element.TextContainer

addContent, addContent, addContent

Methods inherited from class org.dspace.app.xmlui.wing.element.Container

dispose

Methods inherited from class org.dspace.app.xmlui.wing.element.AbstractWingElement

endElement, endElement, getWingContext, greater, lesser, require, require, requireFalse, requireTrue, restrict, sendCharacters, setWingContext, startElement, startElement

Methods inherited from class java.lang.Object

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

Field Detail

E_HELP

public static final String E_HELP

The name of the help element

See Also:

Constant Field Values

Constructor Detail

Help

protected Help(WingContext context)
        throws WingException

Construct a new field help.

Parameters:

context - (Required) The context this element is contained in

Throws:

WingException

Method Detail

toSAX

public void toSAX(ContentHandler contentHandler,
                  LexicalHandler lexicalHandler,
                  NamespaceSupport namespaces)
           throws SAXException

Translate this element and all contained elements into SAX events. The events should be routed to the contentHandler found in the WingContext.

Specified by:

toSAX in interface WingElement

Overrides:

toSAX in class Container

Parameters:

contentHandler - (Required) The registered contentHandler where SAX events should be routed too.

lexicalHandler - (Required) The registered lexicalHandler where lexical events (such as CDATA, DTD, etc) should be routed too.

namespaces - (Required) SAX Helper class to keep track of namespaces able to determine the correct prefix for a given namespace URI.

Throws:

SAXException