Use the AddRemove component when the web application user makes selections from a list and they need to see the currently selected items displayed together, and/or they need to reorder the selected items.
MOVEUP_FUNCTION
Name of the JavaScript function which moves elements up
static java.lang.String
MULTIPLEADDITIONS_FUNCTION
The name of the JavaScript function used to hook up the correct
add and remove functions when the component allows items to be
added to the selected items list more than once
getAddButtonComponent(javax.faces.context.FacesContext context)
Get or create the ADD button.
java.lang.String
getAllValues()
This function returns a String consisting of the String representation of the
values of all the available Options, separated by the separator
String (see getSeparator())
getHeaderComponent()
Gets or creates a component for the "component" list
label.
java.util.Iterator
getListItems(javax.faces.context.FacesContext context,
boolean rulerAtEnd)
Retrieve an Iterator of ListSelector.ListItem representing the available selections only.
getPrimaryElementID(javax.faces.context.FacesContext context)
Implement this method so that it returns the DOM ID of the
HTML element which should receive focus when the component
receives focus, and to which a component label should apply.
getSelectedListItems()
Retrieve an Iterator of ListSelector.ListItem representing the selected selections only.
java.lang.String
getSelectedValues()
This function returns a String consisting of the String representation of the
values of the selected Options, separated by the separator
String
java.lang.String
getSeparator()
Get the separator string that is used to separate the selected values on the client.
markSelectedListItems(java.util.List list,
boolean processed)
Marks options corresponding to objects listed as values of this
components as selected.
protected void
processOptions(javax.faces.context.FacesContext context,
java.text.Collator collator,
java.util.Locale locale,
boolean rulerAtEnd)
Evaluates the list of available Options, creating a ListItem for each
one.
Methods inherited from class com.sun.rave.web.ui.component.AddRemoveBase
public static final java.lang.String MULTIPLEADDITIONS_FUNCTION
The name of the JavaScript function used to hook up the correct
add and remove functions when the component allows items to be
added to the selected items list more than once
Get the separator string that is used to separate the selected values on the client.
The default value is "|". When the AddRemove component is decoded, the
value is taken from a hidden variable whose value is a list of the
values of all the options in the list representing the selected items.
Consider a case where the AddRemove has a list of options including
Assume that these two options are disabled. If the separator
string is set to "|", then the value of the hidden
variable will be |1|2|.
You will only need to set this variable if the string
representation of one of the option values contain the
character "|". If you do need to change from the default,
bear in mind that the value of the hidden component
is sent as part of the body of the HTTP request body.
Make sure to select a character that does not change
the syntax of the request.
Returns:
The separator string.
getSelectedItems
public java.util.Iterator getSelectedItems()
Returns an iterator over the selected items
Returns:
an iterator over the selected items
getAllValues
public java.lang.String getAllValues()
This function returns a String consisting of the String representation of the
values of all the available Options, separated by the separator
String (see getSeparator())
Returns:
eturns a String consisting of the String representation of the
values of all the available Options, separated by the separator
String
getSelectedValues
public java.lang.String getSelectedValues()
This function returns a String consisting of the String representation of the
values of the selected Options, separated by the separator
String
Returns:
a String consisting of the String representation of the
values of the selected Options, separated by the separator
String
getAddButtonComponent
public javax.faces.component.UIComponent getAddButtonComponent(javax.faces.context.FacesContext context)
Get or create the ADD button. Retrieves the component specified by the
addButton facet (if there is one) or creates a new Button component.
Parameters:
context - The FacesContext for the request
Returns:
A UI Component for the Add button
getAddAllButtonComponent
public javax.faces.component.UIComponent getAddAllButtonComponent()
Get or create the ADD button. Retrieves the component specified by the
addButton facet (if there is one) or creates a new Button component.
Returns:
A UI Component for the Add button
getRemoveButtonComponent
public javax.faces.component.UIComponent getRemoveButtonComponent()
Get or create the REMOVE button. Retrieves the component specified by the
removeButton facet (if there is one) or creates a new Button component.
Returns:
A UI Component for the Remove button
getRemoveAllButtonComponent
public javax.faces.component.UIComponent getRemoveAllButtonComponent()
Get or create the REMOVE button. Retrieves the component specified by the
removeButton facet (if there is one) or creates a new Button component.
Returns:
A UI Component for the Remove button
getMoveUpButtonComponent
public javax.faces.component.UIComponent getMoveUpButtonComponent()
Get or create the MOVEUP button. Retrieves the component specified by the
moveUpButton facet (if there is one) or creates a new Button component.
Returns:
A UI Component for the MoveUp button
getMoveDownButtonComponent
public javax.faces.component.UIComponent getMoveDownButtonComponent()
Get or create the MOVEDOWN button. Retrieves the component specified by the
moveDownButton facet (if there is one) or creates a new Button component.
Returns:
A UI Component for the MoveDown button
getAvailableLabelComponent
public javax.faces.component.UIComponent getAvailableLabelComponent()
Gets or creates a component for the "available" list
label. Retrieves the availableLabel facet if one was
specified, or creates a new label component.
Returns:
A UIComponent for the list label
getSelectedLabelComponent
public javax.faces.component.UIComponent getSelectedLabelComponent()
Gets or creates a component for the "selected" list
label. Retrieves the selectedLabel facet if one was
specified, or creates a new label component.
Returns:
A UIComponent for the list label
getHeaderComponent
public javax.faces.component.UIComponent getHeaderComponent()
Gets or creates a component for the "component" list
label. Retrieves the componentLabel facet if one was
specified, or creates a new label component.
Returns:
A UIComponent for the list label
getPrimaryElementID
public java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
Implement this method so that it returns the DOM ID of the
HTML element which should receive focus when the component
receives focus, and to which a component label should apply.
Usually, this is the first element that accepts input.
public java.util.Iterator getListItems(javax.faces.context.FacesContext context,
boolean rulerAtEnd)
throws javax.faces.FacesException
Retrieve an Iterator of ListSelector.ListItem representing the available selections only.
This method is used by the renderer, to create the options of
the list of available items.
rulerAtEnd - If true, a disabled list item with a blank label is appended at
the end of the options. The role of the blank
item is to guarantee that the width of the lists
do not change when items are moved from one to the
other.
Evaluates the list of available Options, creating a ListItem for each
one.
Parameters:
context - The FacesContext
rulerAtEnd - the end of the options. The role of the blank
item is to guarantee that the width of the lists
do not change when items are moved from one to the
other.
getSelectedListItems
public java.util.Iterator getSelectedListItems()
Retrieve an Iterator of ListSelector.ListItem representing the selected selections only.
This method is used by the renderer, to create the options of
the list of selected items. It is also used when calculating a string
representation of the value of the component.
list - A list representation of the selected values
processed - If true, compare the values object by
object (this is done if we compare the value of the object with
with the list items). If false, perform a string comparison of
the string representation of the submitted value of the
component with the string representation of the value from the
list items (this is done if we compare the submitted values
with the list items).
javax.faces.component.UIComponent