|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.faces.component.UIComponent
oracle.adf.view.faces.component.UIXComponent
oracle.adf.view.faces.component.UIXComponentBase
oracle.adf.view.faces.component.UIXValue
oracle.adf.view.faces.component.UIXEditableValue
oracle.adf.view.faces.component.UIXSelectMany
oracle.adf.view.faces.component.core.input.CoreSelectManyShuttle
The selectManyShuttle component provides a mechanism for selecting multiple values from a list of values by allowing the user to move items between two lists. The "value" attribute of the selectManyShuttle, like any other selectMany component, must be a List or array of values that correspond to a value of one of the contained SelectItems. If a value of one of the SelectItems is in the List or array, that item will appear in the trailing list. Looked at another way, you can change a selectManyListbox directly into a selectManyShuttle; instead of the "value" driving which items are selected in the listbox, it affects which items appear in the trailing list of the shuttle.
The selectManyShuttle does not allow for reordering; the selectOrderShuttle component adds this functionality to selectManyShuttle. selectManyShuttle also does not include automatic messaging support, unlike most other ADF messaging components.
Each list in the shuttle has a header, the text of which can be set as the "leadingHeader" attribute and the "trailingHeader" attribute.
Each container in the shuttle can have an area to display item
descriptions below the list. To indicate whether or not
a container should have such an area set the attributes
"leadingDescShown" attribute
and the "trailingDescShown" attribute.
To control the display size(number of items) of the lists, the size attribute has to be specified. The size specified must be between 10 and 20 items. If the attribute is not set or has a value less than 10, the size would have a default or minimum value of 10. If the attribute value specified is more than 20 items, the size would have the maximum value of 20.
The shuttle allows the user to place components - typically,
buttons or icons - below each of the lists. These
buttons or icons will take up only one row below the lists
(no wrapping), and should have a maximum height of 26 pixels
if the layout of the shuttle is to remain consistent. The
buttons and icons should be placed within the
shuttle as the leadingFooter
or the trailingFooter facet,
depending on which list the buttons should go under.
Leave the appropriate facet empty if no footer is
required under a list. These buttons and icons can be
used to perform operations upon the shuttle using a
ShuttleProxy as described below.
The shuttle allows the user to place a filter above the
list in the leading container. The filter is added as the
filter facet. The filter can be used to
perform operations upon the shuttle using a ShuttleProxy as
described below.
In some cases, developers will need to use JavaScript to manipulate or use the contents of the lists. This may be required as actions for the buttons or icons in the shuttle footers or outside the shuttle all together. Thus, a set of Javascript utility methods are available that operate on the lists. These are located in the shuttle.js Javascript library, which is automatically loaded if you use the shuttle.
These methods can be accessed by creating a
ShuttleProxy instance based on the
shuttle client ID and form.
// create the proxy object
var proxy2 = new ShuttleProxy("testShuttle2", "testForm2");
Once the proxy is created, you can use it to gain information about the lists or to manipulate the lists in the shuttle. The proxy provides the following functions:
move(fromLeadingList, allItems) : moves items from
one list to the other. If fromLeadingList is true, the items
move from the leading list to the trailing list. If
fromLeadingList is false, the items move the opposite
direction. If allItems is true, all the items are moved,
otherwise only the selected items are moved.reorderList(down, allTheWay, leadingList) : reorders
a list. If down is true, the items move down in the list,
otherwise they move up. If allTheWay is true, the items move
all the way to the top or bottom of the list depending on the value of
down. If leadingList is true, the leading list
is reordered, otherwise the trailing list is reordered.getItems(leadingList) : returns an array of
option objects that make up a list. If leadingList
is true, the array has the leading list's options, otherwise the items
are from the trailing list. Note that the array will not include the
horizontal bar at the end of the lists.getSelectedItems(leadingList) : returns an array of
option objects that are selected in a list. If
leadingList is true, the array has the leading list's options,
otherwise the items are from the trailingList. Note that the array will not
include the horizontal bar at the end of the lists.getItemCount(leadingList) : returns the number of
items in a list. If leadingList is true, the number returned
is the number of items in the leading list. Otherwise, the number returned
is the number of items in the trailing list. Note that the horizontal bar
at the end of the lists is not included in this count -- you only get the
number of actual items.getSelectedItemCount(leadingList) : returns the number
of selected items in a list. If leadingList is true, the
number returned is the number of selected items in the leading list.
Otherwise, the number returned is the number of selected items in the
trailing list. Note that the horizontal bar at the end of the lists is not
included in this count -- you only get the number of actual items.addItem(leadingList, index, text, value, description) : adds an item
at the given index to a list. The item is added to the leading list if
leadingList is true, otherwise it is added to the trailing list.
The index should be 0 based. Thus, to insert an item at
the end of a list, set index to
shuttleProxy.getItemCount(leadinglist). The text
parameter specifies the display text for the item, while the
value parameter specifies the value that represents this item
upon form submission. The description parameter specifies a
description of the item. The description parameter can be omitted.deleteItemByValue(leadingList, value) :
deletes an item
from a list. The item is deleted from the leading list if
leadingList is true, otherwise it is deleted from the trailing
list. The item deleted is the first item with the value (not text) of
value.deleteSelectedItems(leadingList) : deletes items
from a list. The items are deleted from the leading list if
leadingList is true, otherwise they are deleted from the
trailing list. The items deleted are the items that are selected in the
appropriate list.reset() : reset the shuttle
to its initial state.
<af:selectManyShuttle value="#{bean.valueList}">
<f:selectItem itemLabel="Option1" itemValue="1"/>
<f:selectItem itemLabel="Option1" itemValue="2"/>
<f:selectItem itemLabel="Option1" itemValue="3"/>
</af:selectManyShuttle> *This bean is not supported on the following agent types: pda, phone, voice.
| Type | Phases | Description |
|---|---|---|
javax.faces.event.ValueChangeEvent |
Process Validations Apply Request Values |
Event delivered when a new value is entered by a user. |
| Fields inherited from class oracle.adf.view.faces.component.UIXSelectMany |
REQUIRED_MESSAGE_ID, UNSUPPORTED_MODEL_TYPE_MESSAGE_ID |
| Fields inherited from class oracle.adf.view.faces.component.UIXEditableValue |
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, SUBMITTED_VALUE_KEY, VALID_KEY, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY |
| Fields inherited from class oracle.adf.view.faces.component.UIXValue |
CONVERTER_KEY, VALUE_KEY |
| Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase |
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
| Constructor Summary | |
|
CoreSelectManyShuttle()
Construct an instance of the CoreSelectManyShuttle. |
protected |
CoreSelectManyShuttle(java.lang.String rendererType)
Construct an instance of the CoreSelectManyShuttle. |
| Method Summary | |
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
UIComponent |
getFilter()
the filter above the leading list. |
java.lang.String |
getInlineStyle()
Gets the inline CSS style for this element |
java.lang.String |
getLabel()
Gets the label for the shuttle that is used to identify the component only when displaying error messages. |
UIComponent |
getLeadingFooter()
the footer of buttons/images under the leading list. |
java.lang.String |
getLeadingHeader()
Gets the header of the leading list of the shuttle. |
java.lang.String |
getOnblur()
Gets the event handler for when the element loses focus. |
java.lang.String |
getOnchange()
Gets event handler for when the value is changed. |
java.lang.String |
getOnclick()
Gets an onclick Javascript handler. |
java.lang.String |
getOndblclick()
Gets an ondblclick Javascript handler. |
java.lang.String |
getOnfocus()
Gets the event handler for when the element receives focus. |
java.lang.String |
getOnkeydown()
Gets an onkeydown Javascript handler. |
java.lang.String |
getOnkeypress()
Gets an onkeypress Javascript handler. |
java.lang.String |
getOnkeyup()
Gets an onkeyup Javascript handler. |
java.lang.String |
getOnmousedown()
Gets an onmousedown Javascript handler. |
java.lang.String |
getOnmousemove()
Gets an onmousemove Javascript handler. |
java.lang.String |
getOnmouseout()
Gets an onmouseout Javascript handler. |
java.lang.String |
getOnmouseover()
Gets an onmouseover Javascript handler. |
java.lang.String |
getOnmouseup()
Gets an onmouseup Javascript handler. |
java.lang.String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc()
Gets the short description of the bean. |
int |
getSize()
Gets the display size(number of items) of the lists. |
java.lang.String |
getStyleClass()
Gets the CSS style class of the bean. |
UIComponent |
getTrailingFooter()
the footer of buttons/images under the trailing list. |
java.lang.String |
getTrailingHeader()
Gets the header of the trailing list of the shuttle. |
boolean |
isDisabled()
Gets whether the element is disabled. |
boolean |
isLeadingDescShown()
Gets whether or not the leading list has an area to display descriptions. |
boolean |
isReadOnly()
Gets whether the element is read-only. |
boolean |
isTrailingDescShown()
Gets whether or not the trailing list has an area to display descriptions. |
boolean |
isValuePassThru()
Gets pass the value through to the client. |
void |
setDisabled(boolean disabled)
Sets whether the element is disabled. |
void |
setFilter(UIComponent filterFacet)
the filter above the leading list. |
void |
setInlineStyle(java.lang.String inlineStyle)
Sets the inline CSS style for this element |
void |
setLabel(java.lang.String label)
Sets the label for the shuttle that is used to identify the component only when displaying error messages. |
void |
setLeadingDescShown(boolean leadingDescShown)
Sets whether or not the leading list has an area to display descriptions. |
void |
setLeadingFooter(UIComponent leadingFooterFacet)
the footer of buttons/images under the leading list. |
void |
setLeadingHeader(java.lang.String leadingHeader)
Sets the header of the leading list of the shuttle. |
void |
setOnblur(java.lang.String onblur)
Sets the event handler for when the element loses focus. |
void |
setOnchange(java.lang.String onchange)
Sets event handler for when the value is changed. |
void |
setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler. |
void |
setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler. |
void |
setOnfocus(java.lang.String onfocus)
Sets the event handler for when the element receives focus. |
void |
setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler. |
void |
setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler. |
void |
setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler. |
void |
setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler. |
void |
setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler. |
void |
setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler. |
void |
setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler. |
void |
setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler. |
void |
setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. |
void |
setReadOnly(boolean readOnly)
Sets whether the element is read-only. |
void |
setShortDesc(java.lang.String shortDesc)
Sets the short description of the bean. |
void |
setSize(int size)
Sets the display size(number of items) of the lists. |
void |
setStyleClass(java.lang.String styleClass)
Sets the CSS style class of the bean. |
void |
setTrailingDescShown(boolean trailingDescShown)
Sets whether or not the trailing list has an area to display descriptions. |
void |
setTrailingFooter(UIComponent trailingFooterFacet)
the footer of buttons/images under the trailing list. |
void |
setTrailingHeader(java.lang.String trailingHeader)
Sets the header of the trailing list of the shuttle. |
void |
setValuePassThru(boolean valuePassThru)
Sets pass the value through to the client. |
| Methods inherited from class oracle.adf.view.faces.component.UIXSelectMany |
compareValues, getRequiredMessageKey, isEmpty, validateValue |
| Methods inherited from class oracle.adf.view.faces.component.UIXEditableValue |
addValidator, addValueChangeListener, broadcast, getConvertedValue, getRequiredMessageDetail, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, updateModel, validate |
| Methods inherited from class oracle.adf.view.faces.component.UIXValue |
getConverter, getLocalValue, getValue, setConverter, setValue |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.faces.component.ValueHolder |
getConverter, getLocalValue, getValue, setConverter, setValue |
| Field Detail |
public static final FacesBean.Type TYPE
public static final PropertyKey VALUE_PASS_THRU_KEY
public static final PropertyKey READ_ONLY_KEY
public static final PropertyKey DISABLED_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONFOCUS_KEY
public static final PropertyKey ONBLUR_KEY
public static final PropertyKey ONCHANGE_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey SIZE_KEY
public static final PropertyKey LEADING_HEADER_KEY
public static final PropertyKey TRAILING_HEADER_KEY
public static final PropertyKey LEADING_DESC_SHOWN_KEY
public static final PropertyKey TRAILING_DESC_SHOWN_KEY
public static final PropertyKey LABEL_KEY
public static final java.lang.String FILTER_FACET
public static final java.lang.String LEADING_FOOTER_FACET
public static final java.lang.String TRAILING_FOOTER_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
| Constructor Detail |
public CoreSelectManyShuttle()
protected CoreSelectManyShuttle(java.lang.String rendererType)
| Method Detail |
public final UIComponent getFilter()
public final void setFilter(UIComponent filterFacet)
public final UIComponent getLeadingFooter()
public final void setLeadingFooter(UIComponent leadingFooterFacet)
public final UIComponent getTrailingFooter()
public final void setTrailingFooter(UIComponent trailingFooterFacet)
public final boolean isValuePassThru()
public final void setValuePassThru(boolean valuePassThru)
public final boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
public final boolean isDisabled()
public final void setDisabled(boolean disabled)
public final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
public final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
public final java.lang.String getOnfocus()
public final void setOnfocus(java.lang.String onfocus)
public final java.lang.String getOnblur()
public final void setOnblur(java.lang.String onblur)
public final java.lang.String getOnchange()
public final void setOnchange(java.lang.String onchange)
public final java.lang.String getOnclick()
public final void setOnclick(java.lang.String onclick)
public final java.lang.String getOndblclick()
public final void setOndblclick(java.lang.String ondblclick)
public final java.lang.String getOnmousedown()
public final void setOnmousedown(java.lang.String onmousedown)
public final java.lang.String getOnmouseup()
public final void setOnmouseup(java.lang.String onmouseup)
public final java.lang.String getOnmouseover()
public final void setOnmouseover(java.lang.String onmouseover)
public final java.lang.String getOnmousemove()
public final void setOnmousemove(java.lang.String onmousemove)
public final java.lang.String getOnmouseout()
public final void setOnmouseout(java.lang.String onmouseout)
public final java.lang.String getOnkeypress()
public final void setOnkeypress(java.lang.String onkeypress)
public final java.lang.String getOnkeydown()
public final void setOnkeydown(java.lang.String onkeydown)
public final java.lang.String getOnkeyup()
public final void setOnkeyup(java.lang.String onkeyup)
public final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
public final int getSize()
public final void setSize(int size)
public final java.lang.String getLeadingHeader()
public final void setLeadingHeader(java.lang.String leadingHeader)
public final java.lang.String getTrailingHeader()
public final void setTrailingHeader(java.lang.String trailingHeader)
public final boolean isLeadingDescShown()
public final void setLeadingDescShown(boolean leadingDescShown)
public final boolean isTrailingDescShown()
public final void setTrailingDescShown(boolean trailingDescShown)
public final java.lang.String getLabel()
public final void setLabel(java.lang.String label)
public java.lang.String getFamily()
getFamily in class UIXSelectManyprotected FacesBean.Type getBeanType()
getBeanType in class UIXSelectMany
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||