org.dspace.app.xmlui.wing.element

Class Text

java.lang.Object

org.dspace.app.xmlui.wing.element.AbstractWingElement

org.dspace.app.xmlui.wing.element.Field

org.dspace.app.xmlui.wing.element.Text

All Implemented Interfaces:

StructuralElement, WingElement

public class Text
extends Field

Field Summary

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

A_DISABLED, A_FIELD_TYPE, A_REQUIRED, disabled, E_FIELD, errors, fields, help, instances, label, name, OPERATION_ADD, OPERATION_DELETE, OPERATIONS, options, params, rend, required, type, TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMPOSITE, TYPE_FILE, TYPE_HIDDEN, TYPE_PASSWORD, TYPE_RADIO, TYPE_SELECT, TYPE_TEXT, TYPE_TEXTAREA, TYPES, values

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	Text(WingContext context, String name, String rend) Construct a new field.

Method Summary

Modifier and Type	Method and Description
Instance	addInstance() Add a field instance
void	enableAddOperation() Enable the add operation for this field.
void	enableDeleteOperation() Enable the delete operation for this field.
Value	setAuthorityValue() Set the authority value of the field removing any previous authority values.
Value	setAuthorityValue(String characters, String confidence) Set the authority value of the field removing any previous authority values.
void	setSize(int size) Set the size of the text field.
void	setSize(int size, int maxLength) Set the size and maximum size of the text field.
Value	setValue() Set the raw value of the field removing any previous raw values.
void	setValue(Message message) Set the raw value of the field removing any previous raw values.
void	setValue(String characters) Set the raw value of the field removing any previous raw values.

Methods inherited from class org.dspace.app.xmlui.wing.element.Field

addError, addError, addError, dispose, removeValueOfType, setAuthorityControlled, setAuthorityControlled, setAuthorityRequired, setAuthorityRequired, setAutofocus, setChoices, setChoicesClosed, setChoicesClosed, setChoicesPresentation, setDisabled, setDisabled, setHelp, setHelp, setHelp, setLabel, setLabel, setLabel, setRequired, setRequired, 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

Text

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

Construct a new field.

Parameters:

context - (Required) The context this element is contained in, such as where to route SAX events and what i18n catalogue to use.

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.

Throws:

WingException - passed through.

Method Detail

setSize

public void setSize(int size)

Set the size of the text field.

Parameters:

size - (May be zero for no defined value) he default size for a field.

setSize

public void setSize(int size,
                    int maxLength)

Set the size and maximum size of the text field.

Parameters:

size - (May be zero for no defined value) he default size for a field.

maxLength - (May be zero for no defined value) The maximum length that the theme should accept for form input.

enableAddOperation

public void enableAddOperation()
                        throws WingException

Enable the add operation for this field. When this is enabled the front end will add a button to add more items to the field.

Throws:

WingException - passed through.

enableDeleteOperation

public void enableDeleteOperation()
                           throws WingException

Enable the delete operation for this field. When this is enabled then the front end will provide a way for the user to select fields (probably checkboxes) along with a submit button to delete the selected fields.

Throws:

WingException - passed through.

setValue

public Value setValue()
               throws WingException

Set the raw value of the field removing any previous raw values.

Returns:

the new value.

Throws:

WingException - passed through.

setValue

public void setValue(String characters)
              throws WingException

Set the raw value of the field removing any previous raw values.

Parameters:

characters - (May be null) Field value as a string

Throws:

WingException - passed through.

setValue

public void setValue(Message message)
              throws WingException

Set the raw value of the field removing any previous raw values.

Parameters:

message - (Required) A key into the i18n catalogue for translation into the user's preferred language.

Throws:

WingException - passed through.

setAuthorityValue

public Value setAuthorityValue()
                        throws WingException

Set the authority value of the field removing any previous authority values. Initialized to an empty value.

Returns:

the new value.

Throws:

WingException - passed through.

setAuthorityValue

public Value setAuthorityValue(String characters,
                               String confidence)
                        throws WingException

Set the authority value of the field removing any previous authority values. Initialized to an empty value.

Parameters:

characters - new value.

confidence - confidence in this value

Returns:

the new value.

Throws:

WingException - passed through.

addInstance

public Instance addInstance()
                     throws WingException

Add a field instance

Returns:

instance

Throws:

WingException - passed through.