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

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

All Implemented Interfaces:

StructuralElement, WingElement

public class Figure
extends TextContainer
implements StructuralElement

This class represents a figure element used to embed a reference to an image or graphic element. Any text within the element will be used as an alternative descriptor or a caption.

Author:

Scott Phillips

Field Summary

static String	A_SOURCE The name of the source attribute
static String	A_TARGET The name of the target attribute
static String	E_FIGURE The name of the figure 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

Figure(WingContext context, String source, String target, String rend) Construct a new figure.

Method Summary

void	dispose() dispose
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.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_FIGURE

public static final String E_FIGURE

The name of the figure element

See Also:

Constant Field Values

A_SOURCE

public static final String A_SOURCE

The name of the source attribute

See Also:

Constant Field Values

A_TARGET

public static final String A_TARGET

The name of the target attribute

See Also:

Constant Field Values

Constructor Detail

Figure

protected Figure(WingContext context,
                 String source,
                 String target,
                 String rend)
          throws WingException

Construct a new figure.

Parameters:

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

Source - (Required) The figure's image source.

target - (May be null) The figure's external reference, if present then the figure is also a link.

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

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

dispose

public void dispose()

dispose

Specified by:

dispose in interface WingElement

Overrides:

dispose in class Container