| java.lang.Object
 org.dspace.app.xmlui.wing.element.AbstractWingElement
org.dspace.app.xmlui.wing.element.List
| Constructor Summary | |
| protected | List(WingContext context, String name, String type, String rend)
Construct a new list.
Parameters:
context - (Required) The context this element is contained in, such aswhere to route SAX events and what i18n catalogue to use.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. |
| Method Summary | |
| public Item | addItem()
Add an empty unnamed item. | | public Item | addItem(String name, String rend)
Add an item element, which serves a dual purpose. | | public void | addItem(String characters)
Add an item element that contains only character content. | | public void | addItem(Message key)
Add an item element that contains only translated content. | | public void | addItemXref(String target, String characters)
Add an item to the list that contains a link. | | public void | addItemXref(String target, Message key)
Add an item to the list that contains a link. | | public Label | addLabel(String name, String rend)
Add a 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. | | public void | addLabel(String characters)
Add a 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. | | public void | addLabel()
Add a 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. | | public void | addLabel(Message key)
Add a 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. | | public List | addList(String name, String type, String rend)
Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. | | public List | addList(String name, String type)
Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. | | public List | addList(String name)
Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings. | | public void | dispose()
| | public Attributes | merge(Attributes attributes)
Inform this list that it is being merged with an existing element. | | public WingMergeableElement | mergeChild(String namespace, String localName, String qName, Attributes attributes)
Merge the given SAX startElement event into this list's child. | | public boolean | mergeEqual(String namespace, String localName, String qName, Attributes attributes)
Determine if the given SAX startElement event is equivalent to this list. | | public Head | setHead()
Set the head element which is the label associated with this list. | | public void | setHead(String characters)
Set the head element which is the label associated with this list. | | public void | setHead(Message key)
Set the head element which is the label associated with this list. | | public void | toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, NamespaceSupport namespaces)
Translate this element and all contained elements into SAX events. |
| A_TYPE | | final public static String A_TYPE(Code) | | The name of the type attribute
|
| E_LIST | | final public static String E_LIST(Code) | | The name of the list element
|
| TYPES | | final public static String[] TYPES(Code) | | All the possible list types collected into one array
|
| TYPE_SIMPLE | | final public static String TYPE_SIMPLE(Code) | | The possible list types *
|
| List | | protected List(WingContext context, String name, String type, String rend) throws WingException(Code) | | Construct a new list.
Parameters:
context - (Required) The context this element is contained in, such aswhere to route SAX events and what i18n catalogue to use.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. If this is blank thelist type is inferred from the context and use.
Parameters:
rend - (May be null) a rendering hint used to override the defaultdisplay of the element. There are a set of predefinedrendering values, see the class documentation above. |
| addItem | | public Item addItem(String name, String rend) throws WingException(Code) | | Add an item element, which serves a dual purpose. It can contain other
lists, allowing for hierarchies and recursive lists. Alternatively it can
serve as a character container to display textual data, possibly enhanced
with hyperlinks, emphasized blocks of text, images and form fields. An
item cannot be both a character container and contain a list.
Parameters:
name - (May be null) a local identifier used to differentiate theelement from its siblings.
Parameters:
rend - (May be null) a rendering hint used to override the defaultdisplay of the element. * a new Item |
| addItem | | public void addItem(String characters) throws WingException(Code) | | Add an item element that contains only character content.
Parameters:
characters - (Required) Untranslated character data to be included. |
| addItem | | public void addItem(Message key) throws WingException(Code) | | Add an item element that contains only translated content.
Parameters:
key - (Required) Key to the i18n catalogue to translate the contentinto the language preferred by the user. |
| addItemXref | | public void addItemXref(String target, String characters) throws WingException(Code) | | Add an item to the list that contains a link. The link will consist of
the given content and linked to the given target.
Parameters:
target - (Required) The link target.
Parameters:
characters - (Required) Untranslated character data to be included as thelink's body. |
| addItemXref | | public void addItemXref(String target, Message key) throws WingException(Code) | | Add an item to the list that contains a link. The link will consist of
the given content and linked to the given target.
Parameters:
target - (Required) The link target.
Parameters:
key - (Required) i18n key for translating content into the user'spreferred language. |
| addLabel | | public Label addLabel(String name, String rend) throws WingException(Code) | | Add a 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.
Parameters:
name - (May be null) a local identifier used to differentiate theelement from its siblings.
Parameters:
rend - (May be null) a rendering hint used to override the defaultdisplay of the element. |
| addLabel | | public void addLabel(String characters) throws WingException(Code) | | Add a 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.
Parameters:
characters - (Required) Untranslated character data to be included. |
| addLabel | | public void addLabel() throws WingException(Code) | | Add a 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. This version of label provides no textual label but may be used
to indicate some implicit labeling such as ordered lists.
|
| addLabel | | public void addLabel(Message key) throws WingException(Code) | | Add a 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.
Parameters:
key - (Required) Key to the i18n catalogue to translate the contentinto the language preferred by the user. |
| addList | | public List addList(String name, String type, String rend) throws WingException(Code) | | Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. If this is blank thelist type is inferred from the context and use.
Parameters:
rend - (May be null) a rendering hint used to override the defaultdisplay of the element. A new sub list. |
| addList | | public List addList(String name, String type) throws WingException(Code) | | Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings.
Parameters:
type - (May be null) determines the list type. If this is blank thelist type is inferred from the context and use. A new sub list. |
| addList | | public List addList(String name) throws WingException(Code) | | Add a new sublist to this list.
Parameters:
name - (Required) a local identifier used to differentiate theelement from its siblings. A new sub list. |
| dispose | | public void dispose()(Code) | | dispose
|
| merge | | public Attributes merge(Attributes attributes) throws SAXException, WingException(Code) | | Inform this list that it is being merged with an existing element.
Practically this means that when this method is being transformed to SAX
it should assume that the element's SAX events have all ready been sent.
In this case the element would only need to transform to SAX the children
of this element.
Further more if the element needs to add any attributes to the SAX
startElement event it may modify the attributes object passed to make
changes.
The attributes for this merged element |
| mergeChild | | public WingMergeableElement mergeChild(String namespace, String localName, String qName, Attributes attributes) throws SAXException, WingException(Code) | | Merge the given SAX startElement event into this list's child. If this
SAX event matches a child element of this list then it should be removed
from the internal book keep of this element and returned. Typically this
is accomplished by looping through all children elements and returned the
first one that returns true for the mergeEqual method.
Parameters:
namespace - The element's name space
Parameters:
localName - The local, unqualified, name for this element *
Parameters:
qName - The qualified name for this element
Parameters:
attributes - The element's attributes The child element |
| mergeEqual | | public boolean mergeEqual(String namespace, String localName, String qName, Attributes attributes)(Code) | | Determine if the given SAX startElement event is equivalent to this list.
Parameters:
namespace - The element's name space
Parameters:
localName - The local, unqualified, name for this element
Parameters:
qName - The qualified name for this element
Parameters:
attributes - The element's attributes True if this list is equivalent to the given SAX Event. |
| setHead | | public Head setHead() throws WingException(Code) | | Set the head element which is the label associated with this list. This
method should be called before any other elements have been added to the
list.
Parameters:
characters - (May be null) Untranslated character data to be included asthe list's head. |
| setHead | | public void setHead(String characters) throws WingException(Code) | | Set the head element which is the label associated with this list. This
method should be called before any other elements have been added to the
list.
Parameters:
characters - (Required) Untranslated character data to be included as thelist's head. |
| setHead | | public void setHead(Message key) throws WingException(Code) | | Set the head element which is the label associated with this list. This
method should be called before any other elements have been added to the
list.
Parameters:
key - (Required) Key to the i18n catalogue to translate the contentinto the language preferred by the user. |
| toSAX | | public void toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, NamespaceSupport namespaces) throws SAXException(Code) | | Translate this element and all contained elements into SAX events. The
events should be routed to the contentHandler found in the WingContext.
Parameters:
contentHandler - (Required) The registered contentHandler where SAX eventsshould be routed too.
Parameters:
lexicalHandler - (Required) The registered lexicalHandler where lexical events (such as CDATA, DTD, etc) should be routed too.
Parameters:
namespaces - (Required) SAX Helper class to keep track of namespaces ableto determine the correct prefix for a given namespace URI. |
| Methods inherited from org.dspace.app.xmlui.wing.element.AbstractWingElement | public void dispose()(Code)(Java Doc)
protected void endElement(ContentHandler contentHandler, NamespaceSupport namespaces, String name) throws SAXException(Code)(Java Doc)
protected void endElement(ContentHandler contentHandler, NamespaceSupport namespaces, Namespace namespace, String name) throws SAXException(Code)(Java Doc)
protected WingContext getWingContext()(Code)(Java Doc)
protected void greater(int parameter, int greater, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void lesser(int parameter, int lesser, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void require(String parameter, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void require(Message parameter, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void requireFalse(boolean test, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void requireTrue(boolean test, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void restrict(String parameter, String[] options, String message) throws WingInvalidArgument(Code)(Java Doc)
protected void sendCharacters(ContentHandler contentHandler, String characters) throws SAXException(Code)(Java Doc)
protected void setWingContext(WingContext context)(Code)(Java Doc)
protected void startElement(ContentHandler contentHandler, NamespaceSupport namespaces, String name, AttributeMap attributes) throws SAXException(Code)(Java Doc)
protected void startElement(ContentHandler contentHandler, NamespaceSupport namespaces, Namespace namespace, String name, AttributeMap attributes) throws SAXException(Code)(Java Doc)
|
|
|