org.dspace.app.xmlui.wing.element

Class Xref

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

All Implemented Interfaces:

StructuralElement, WingElement

public class Xref
extends TextContainer
implements StructuralElement

This class represents a xref link to an external document. The text within the tag itself will be used as part of the link's visual body.

Author:

Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	A_TARGET The name of the target attribute
static java.lang.String	E_XREF The name of the xref 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	Xref(WingContext context, java.lang.String target) Construct a new xref link.
protected	Xref(WingContext context, java.lang.String target, java.lang.String rend) Construct a new xref link.
protected	Xref(WingContext context, java.lang.String target, java.lang.String rend, java.lang.String name) Construct a new xref link.

Method Summary

Methods

Modifier and Type	Method and Description
void	toSAX(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.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_XREF

public static final java.lang.String E_XREF

The name of the xref element

See Also:

Constant Field Values

A_TARGET

public static final java.lang.String A_TARGET

The name of the target attribute

See Also:

Constant Field Values

Constructor Detail

Xref

protected Xref(WingContext context,
    java.lang.String target,
    java.lang.String rend,
    java.lang.String name)
        throws WingException

Construct a new xref link.

Parameters:

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

target - (Required) A target URL for the references a destination for the xref.

rend - (May be null) A special rendering instruction for this xref.

name - (May be null) a local identifier used to differentiate the element from its siblings.

Throws:

WingException

Xref

protected Xref(WingContext context,
    java.lang.String target,
    java.lang.String rend)
        throws WingException

Construct a new xref link.

Parameters:

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

target - (Required) A target URL for the references a destination for the xref.

rend - (May be null) A special rendering instruction for this xref.

Throws:

WingException

Xref

protected Xref(WingContext context,
    java.lang.String target)
        throws WingException

Construct a new xref link.

Parameters:

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

target - (Required) A target URL for the references a destination for the xref.

Throws:

WingException

Method Detail

toSAX

public void toSAX(org.xml.sax.ContentHandler contentHandler,
         org.xml.sax.ext.LexicalHandler lexicalHandler,
         org.xml.sax.helpers.NamespaceSupport namespaces)
           throws org.xml.sax.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:

org.xml.sax.SAXException