org.dspace.app.xmlui.wing.element

Class Label

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.Label

All Implemented Interfaces:

StructuralElement, WingElement

public class Label
extends TextContainer
implements StructuralElement

This class represents a list's label element, they are associated with an item and annotates that item with a number, a textual description of some sort, or a simple bullet.

Author:

Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
static String	E_LABEL The name of the label 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

Constructors

Modifier	Constructor and Description
protected	Label(WingContext context, String name, String rend) Construct a new label.

Method Summary

Modifier and Type	Method and Description
void	toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, org.xml.sax.helpers.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_LABEL

public static final String E_LABEL

The name of the label element

See Also:

Constant Field Values

Constructor Detail

Label

protected Label(WingContext context,
                String name,
                String rend)
         throws WingException

Construct a new label.

Parameters:

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

name - (May be null) The label's name

rend - (May be null) a rendering hint used to override the default display of the element.

Throws:

WingException - passed through.

Method Detail

toSAX

public void toSAX(ContentHandler contentHandler,
                  LexicalHandler lexicalHandler,
                  org.xml.sax.helpers.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 - passed through.