org.dspace.app.xmlui.wing.element

Class RichTextContainer

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

All Implemented Interfaces:

WingElement

Direct Known Subclasses:

Cell, Highlight, Item, Para, Value

public abstract class RichTextContainer
extends TextContainer

A class representing a character container, such as "p", "hi", "item", or "cell".

This class may not be instantiated on its own; instead you must use one of the extending classes listed above. This abstract class implements the methods common to each of those elements.

Author:

Scott Phillips

Field Summary

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

contents

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

context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RichTextContainer(WingContext context) Construct a new rich text container.

Method Summary

Methods

Modifier and Type	Method and Description
Button	addButton(String name) Add a button input control that when activated by the user will submit the form, including all the fields, back to the server for processing.
Button	addButton(String name, String rend) Add a button input control that when activated by the user will submit the form, including all the fields, back to the server for processing.
CheckBox	addCheckBox(String name) Add a boolean input control which may be toggled by the user.
CheckBox	addCheckBox(String name, String rend) Add a boolean input control which may be toggled by the user.
Composite	addComposite(String name) Add a composite input control.
Composite	addComposite(String name, String rend) Add a composite input control.
Figure	addFigure(String source, String target, String rend) Add a figure element to the character container.
Figure	addFigure(String source, String target, String title, String rend) Add a figure element to the character container.
File	addFile(String name) Add an input control that allows the user to select files to be submitted with the form.
File	addFile(String name, String rend) Add an input control that allows the user to select files to be submitted with the form.
Hidden	addHidden(String name) Add an input control that is not rendered on the screen and hidden from the user.
Hidden	addHidden(String name, String rend) Add an input control that is not rendered on the screen and hidden from the user.
Highlight	addHighlight(String rend) Add highlighted content to the character container.
Password	addPassword(String name) Add a single-line text input control where the input text is rendered in such a way as to hide the characters from the user.
Password	addPassword(String name, String rend) Add a single-line text input control where the input text is rendered in such a way as to hide the characters from the user.
Radio	addRadio(String name) Add a boolean input control which may be toggled by the user.
Radio	addRadio(String name, String rend) Add a boolean input control which may be toggled by the user.
Select	addSelect(String name) Add a menu input control which allows the user to select from a list of available options.
Select	addSelect(String name, String rend) Add a menu input control which allows the user to select from a list of available options.
Text	addText(String name) Add a single-line text input control.
Text	addText(String name, String rend) Add a single-line text input control.
TextArea	addTextArea(String name) Add a multi-line text input control.
TextArea	addTextArea(String name, String rend) Add a multi-line text input control.
Xref	addXref(String target) Add a new reference to the character container.
void	addXref(String target, Message key) Add a new reference to the character container.
void	addXref(String target, Message key, String rend) Add a new reference to the character container.
void	addXref(String target, Message key, String rend, String name) Add a new reference to the character container.
void	addXref(String target, String characters) Add a new reference to the character container.
void	addXref(String target, String characters, String rend) Add a new reference to the character container.
void	addXref(String target, String characters, String rend, String name) Add a new reference to the character container.

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, toSAX

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

Constructor Detail

RichTextContainer

protected RichTextContainer(WingContext context)
                     throws WingException

Construct a new rich text container. This method doesn't do anything but because the inheriting abstract class mandates a constructor for this class to compile it must ensure that the parent constructor is called. Just as implementors of this class must ensure that this constructor is called, thus is the chain of life. :)

Parameters:

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

Throws:

WingException - passed through.

Method Detail

addHighlight

public Highlight addHighlight(String rend)
                       throws WingException

Add highlighted content to the character container.

Parameters:

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

Returns:

A new Highlight

Throws:

WingException - passed through.

addXref

public Xref addXref(String target)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The content will be used as part of the link's visual body.

Parameters:

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

Returns:

the new xref.

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           String characters)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The characters will be used as the visual part of the link's body

Parameters:

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

characters - (May be null) The link's body

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           String characters,
           String rend)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The characters will be used as the visual part of the link's body

Parameters:

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

characters - (May be null) The link's body

rend - (May be null) Special rendering instructions.

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           String characters,
           String rend,
           String name)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The characters will be used as the visual part of the link's body

Parameters:

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

characters - (May be null) The link's body

rend - (May be null) Special rendering instructions.

name - (May be null) local identifier

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           Message key)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The translated i18n key will be used as the visual part of the link's body

Parameters:

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

key - (Required) The link's body

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           Message key,
           String rend)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The translated i18n key will be used as the visual part of the link's body

Parameters:

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

key - (Required) The link's body

rend - (May be null) Special rendering instructions

Throws:

WingException - passed through.

addXref

public void addXref(String target,
           Message key,
           String rend,
           String name)
             throws WingException

Add a new reference to the character container. The xref element is a reference to an external document. The translated i18n key will be used as the visual part of the link's body

Parameters:

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

key - (Required) The link's body

rend - (May be null) Special rendering instructions

name - Name of the link.

Throws:

WingException - passed through.

addFigure

public Figure addFigure(String source,
               String target,
               String rend)
                 throws WingException

Add a figure element to the character container. The figure element is used to embed a reference to an image or a graphic element. The content of a figure will be use as an alternative descriptor or a caption.

Parameters:

source - (Required) The source for the image, using a URL or a pre-defined XML entity.

target - (May be null) The target reference for the image if the image is to operate as a link.

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

Returns:

the new Figure.

Throws:

WingException - passed through.

addFigure

public Figure addFigure(String source,
               String target,
               String title,
               String rend)
                 throws WingException

Add a figure element to the character container. The figure element is used to embed a reference to an image or a graphic element. The content of a figure will be use as an alternative descriptor or a caption.

Parameters:

source - (Required) The source for the image, using a URL or a pre-defined XML entity.

target - (May be null) The target reference for the image if the image is to operate as a link.

title - Title for the figure.

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

Returns:

the new Figure.

Throws:

WingException - passed through.

addButton

public Button addButton(String name,
               String rend)
                 throws WingException

Add a button input control that when activated by the user will submit the form, including all the fields, back to the server for processing.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

A new button field.

Throws:

WingException - passed through.

addButton

public Button addButton(String name)
                 throws WingException

Add a button input control that when activated by the user will submit the form, including all the fields, back to the server for processing.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new button field

Throws:

WingException - passed through.

addCheckBox

public CheckBox addCheckBox(String name,
                   String rend)
                     throws WingException

Add a boolean input control which may be toggled by the user. A checkbox may have several fields which share the same name and each of those fields may be toggled independently. This is distinct from a radio button where only one field may be toggled.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

a new checkbox field

Throws:

WingException - passed through.

addCheckBox

public CheckBox addCheckBox(String name)
                     throws WingException

Add a boolean input control which may be toggled by the user. A checkbox may have several fields which share the same name and each of those fields may be toggled independently. This is distinct from a radio button where only one field may be toggled.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

A new checkbox field

Throws:

WingException - passed through.

addComposite

public Composite addComposite(String name,
                     String rend)
                       throws WingException

Add a composite input control. Composite controls are composed of multiple individual input controls that combine to form a single value. Example, a composite field might be used to represent a name which is broken up into first and last names. In this case there would be a composite field that consists of two text fields.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division.

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

Returns:

a new composite field.

Throws:

WingException - passed through.

addComposite

public Composite addComposite(String name)
                       throws WingException

Add a composite input control. Composite controls are composed of multiple individual input controls that combine to form a single value. Example, a composite field might be used to represent a name which is broken up into first and last names. In this case there would be a composite field that consists of two text fields.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division.

Returns:

a new composite field.

Throws:

WingException - passed through.

addFile

public File addFile(String name,
           String rend)
             throws WingException

Add an input control that allows the user to select files to be submitted with the form. Note that a form which uses a file field must use the multipart method.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

A new file field

Throws:

WingException - passed through.

addFile

public File addFile(String name)
             throws WingException

Add an input control that allows the user to select files to be submitted with the form. Note that a form which uses a file field must use the multipart method.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new file field

Throws:

WingException - passed through.

addHidden

public Hidden addHidden(String name,
               String rend)
                 throws WingException

Add an input control that is not rendered on the screen and hidden from the user.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

a new hidden field

Throws:

WingException - passed through.

addHidden

public Hidden addHidden(String name)
                 throws WingException

Add an input control that is not rendered on the screen and hidden from the user.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new hidden field.

Throws:

WingException - passed through.

addPassword

public Password addPassword(String name,
                   String rend)
                     throws WingException

Add a single-line text input control where the input text is rendered in such a way as to hide the characters from the user.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

A new password field

Throws:

WingException - passed through.

addPassword

public Password addPassword(String name)
                     throws WingException

Add a single-line text input control where the input text is rendered in such a way as to hide the characters from the user.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new password field

Throws:

WingException - passed through.

addRadio

public Radio addRadio(String name,
             String rend)
               throws WingException

Add a boolean input control which may be toggled by the user. Multiple radio button fields may share the same name. When this occurs only one field may be selected to be true. This is distinct from a checkbox where multiple fields may be toggled.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

a new radio field.

Throws:

WingException - passed through.

addRadio

public Radio addRadio(String name)
               throws WingException

Add a boolean input control which may be toggled by the user. Multiple radio button fields may share the same name. When this occurs only one field may be selected to be true. This is distinct from a checkbox where multiple fields may be toggled.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new radio field

Throws:

WingException - passed through.

addSelect

public Select addSelect(String name,
               String rend)
                 throws WingException

Add a menu input control which allows the user to select from a list of available options.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

a new select field

Throws:

WingException - passed through.

addSelect

public Select addSelect(String name)
                 throws WingException

Add a menu input control which allows the user to select from a list of available options.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new select field

Throws:

WingException - passed through.

addText

public Text addText(String name,
           String rend)
             throws WingException

Add a single-line text input control.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

A new text field

Throws:

WingException - passed through.

addText

public Text addText(String name)
             throws WingException

Add a single-line text input control.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new text field

Throws:

WingException - passed through.

addTextArea

public TextArea addTextArea(String name,
                   String rend)
                     throws WingException

Add a multi-line text input control.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

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

Returns:

a new text area field

Throws:

WingException - passed through.

addTextArea

public TextArea addTextArea(String name)
                     throws WingException

Add a multi-line text input control.

Parameters:

name - (Required) a non-unique local identifier used to differentiate the element from its siblings within an interactive division. This is the name of the field use when data is submitted back to the server.

Returns:

a new text area field

Throws:

WingException - passed through.