| java.lang.Object
 org.dspace.app.xmlui.wing.element.AbstractWingElement
org.dspace.app.xmlui.wing.element.Field
All known Subclasses: org.dspace.app.xmlui.wing.element.TextArea, org.dspace.app.xmlui.wing.element.Select, org.dspace.app.xmlui.wing.element.Text, org.dspace.app.xmlui.wing.element.CheckBox, org.dspace.app.xmlui.wing.element.File, org.dspace.app.xmlui.wing.element.Password, org.dspace.app.xmlui.wing.element.Radio, org.dspace.app.xmlui.wing.element.Hidden, org.dspace.app.xmlui.wing.element.Button, org.dspace.app.xmlui.wing.element.Composite,
| Method Summary | |
| public Error | addError()
The error elements denotes that the fields value is invalid for the given
context. | | public void | addError(String characters)
The error elements denotes that the fields value is invalid for the given
context. | | public void | addError(Message message)
The error elements denotes that the fields value is invalid for the given
context. | | public void | dispose()
| | protected void | removeValueOfType(String removeType)
Private function to remove all values of a particular type. | | public void | setDisabled()
Set this field to be disabled. | | public void | setDisabled(boolean disabled)
Set this field to either be disabled or enabled as determined by the
disabled parameter. | | public Help | setHelp()
The help element provides help instructions to assist the user in using
this field. | | public void | setHelp(String characters)
The help element provides help instructions to assist the user in using
this field. | | public void | setHelp(Message message)
The help element provides help instructions to assist the user in using
this field. | | public Label | setLabel()
The help element provides help instructions to assist the user in using
this field. | | public void | setLabel(String characters)
The help element provides help instructions to assist the user in using
this field. | | public void | setLabel(Message message)
The help element provides help instructions to assist the user in using
this field. | | public void | setRequired()
Set this field as required. | | public void | setRequired(boolean required)
Set this field to either be required or not required as determined by the
required parameter. | | public void | toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, NamespaceSupport namespaces)
Translate this element and all contained elements into SAX events. |
| A_DISABLED | | final public static String A_DISABLED(Code) | | The name of the disabled attribute
|
| A_FIELD_TYPE | | final public static String A_FIELD_TYPE(Code) | | The name of the field type attribute
|
| A_REQUIRED | | final public static String A_REQUIRED(Code) | | The name of the required attribute
|
| E_FIELD | | final public static String E_FIELD(Code) | | The name of the field element
|
| OPERATION_ADD | | final public static String OPERATION_ADD(Code) | | Possible field behavioral operations
|
| OPERATION_DELETE | | final public static String OPERATION_DELETE(Code) | | |
| TYPES | | final public static String[] TYPES(Code) | | All the possible field types collected into one array.
|
| TYPE_BUTTON | | final public static String TYPE_BUTTON(Code) | | The possible field types
|
| TYPE_COMPOSITE | | final public static String TYPE_COMPOSITE(Code) | | |
| disabled | | protected boolean disabled(Code) | | Weather this field is disabled
|
| fields | | protected List<Field> fields(Code) | | All sub fields contained within a composite field
|
| help | | protected Help help(Code) | | Help instructions for this field
|
| params | | protected Params params(Code) | | Additional field parameters
|
| rend | | protected String rend(Code) | | Any special rendering instructions
|
| required | | protected boolean required(Code) | | Weather this field is required
|
| type | | protected String type(Code) | | The type of field, see TYPES above
|
| Field | | protected Field(WingContext context, String name, String type, String rend) throws WingException(Code) | | Construct a new field.
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 non-unique local identifier used to differentiatethe element from its siblings within an interactive division.This is the name of the field use when data is submitted backto the server.
Parameters:
type - (Required) Specify the type of field, must be one of the fieldtypes defined in the static variable TYPES.
Parameters:
rend - (May be null) a rendering hint used to override the defaultdisplay of the element. |
| addError | | public Error addError() throws WingException(Code) | | The error elements denotes that the fields value is invalid for the given
context. The message contained within the error message will provide
assistance to the user in correcting the problem.
|
| addError | | public void addError(String characters) throws WingException(Code) | | The error elements denotes that the fields value is invalid for the given
context. The message contained within the error message will provide
assistance to the user in correcting the problem.
Parameters:
characters - (May be null) Direct content or a dictionary tag to beinserted into the element. |
| addError | | public void addError(Message message) throws WingException(Code) | | The error elements denotes that the fields value is invalid for the given
context. The message contained within the error message will provide
assistance to the user in correcting the problem.
Parameters:
message - (Required) A key into the i18n catalogue for translation intothe user's preferred language. |
| dispose | | public void dispose()(Code) | | Dispose
|
| removeValueOfType | | protected void removeValueOfType(String removeType)(Code) | | Private function to remove all values of a particular type.
Parameters:
removeType - The type to be removed. |
| setDisabled | | public void setDisabled()(Code) | | Set this field to be disabled.
|
| setDisabled | | public void setDisabled(boolean disabled)(Code) | | Set this field to either be disabled or enabled as determined by the
disabled parameter.
Parameters:
disabled - Determine if the field is required or not. |
| setHelp | | public Help setHelp() throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
|
| setHelp | | public void setHelp(String characters) throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
Parameters:
characters - (May be null) Direct content or a dictionary tag to beinserted into the element. |
| setHelp | | public void setHelp(Message message) throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
Parameters:
message - (Required) A key into the i18n catalogue for translation intothe user's preferred language. |
| setLabel | | public Label setLabel() throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
|
| setLabel | | public void setLabel(String characters) throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
Parameters:
characters - (May be null) Direct content or a dictionary tag to beinserted into the element. |
| setLabel | | public void setLabel(Message message) throws WingException(Code) | | The help element provides help instructions to assist the user in using
this field.
Parameters:
message - (Required) A key into the i18n catalogue for translation intothe user's preferred language. |
| setRequired | | public void setRequired()(Code) | | Set this field as required.
|
| setRequired | | public void setRequired(boolean required)(Code) | | Set this field to either be required or not required as determined by the
required parameter.
Parameters:
requeired - Determine if the field is required or not. |
| 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)
|
|
|