|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXValue
org.apache.myfaces.trinidad.component.UIXEditableValue
org.apache.myfaces.trinidad.component.UIXSelectMany
org.apache.myfaces.trinidad.component.core.input.CoreSelectManyShuttle
public class 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.
Type | Phases | Description |
---|---|---|
javax.faces.event.ValueChangeEvent |
Apply Request Values | The valueChange event is delivered when the value attribute is changed. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Apply Request Values | Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany |
---|
REQUIRED_MESSAGE_ID, UNSUPPORTED_MODEL_TYPE_MESSAGE_ID |
Fields inherited from class org.apache.myfaces.trinidad.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 org.apache.myfaces.trinidad.component.UIXValue |
---|
CONVERTER_KEY, VALUE_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
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()
|
javax.faces.component.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. |
javax.faces.component.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. |
javax.faces.component.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 whether or not the values are passed through to the client. |
void |
setDisabled(boolean disabled)
Sets whether the element is disabled. |
void |
setFilter(javax.faces.component.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(javax.faces.component.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(javax.faces.component.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 whether or not the values are passed through to the client. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany |
---|
compareValues, getRequiredMessageKey, isEmpty, validateValue |
Methods inherited from class org.apache.myfaces.trinidad.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 org.apache.myfaces.trinidad.component.UIXValue |
---|
getConverter, getLocalValue, getValue, setConverter, setValue |
Methods inherited from class javax.faces.component.UIComponent |
---|
getContainerClientId, invokeOnComponent |
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 javax.faces.component.UIComponent getFilter()
public final void setFilter(javax.faces.component.UIComponent filterFacet)
public final javax.faces.component.UIComponent getLeadingFooter()
public final void setLeadingFooter(javax.faces.component.UIComponent leadingFooterFacet)
public final javax.faces.component.UIComponent getTrailingFooter()
public final void setTrailingFooter(javax.faces.component.UIComponent trailingFooterFacet)
public final boolean isValuePassThru()
public final void setValuePassThru(boolean valuePassThru)
valuePassThru
- the new valuePassThru valuepublic final boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
readOnly
- the new readOnly valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final java.lang.String getOnfocus()
public final void setOnfocus(java.lang.String onfocus)
onfocus
- the new onfocus valuepublic final java.lang.String getOnblur()
public final void setOnblur(java.lang.String onblur)
onblur
- the new onblur valuepublic final java.lang.String getOnchange()
public final void setOnchange(java.lang.String onchange)
onchange
- the new onchange valuepublic final java.lang.String getOnclick()
public final void setOnclick(java.lang.String onclick)
onclick
- the new onclick valuepublic final java.lang.String getOndblclick()
public final void setOndblclick(java.lang.String ondblclick)
ondblclick
- the new ondblclick valuepublic final java.lang.String getOnmousedown()
public final void setOnmousedown(java.lang.String onmousedown)
onmousedown
- the new onmousedown valuepublic final java.lang.String getOnmouseup()
public final void setOnmouseup(java.lang.String onmouseup)
onmouseup
- the new onmouseup valuepublic final java.lang.String getOnmouseover()
public final void setOnmouseover(java.lang.String onmouseover)
onmouseover
- the new onmouseover valuepublic final java.lang.String getOnmousemove()
public final void setOnmousemove(java.lang.String onmousemove)
onmousemove
- the new onmousemove valuepublic final java.lang.String getOnmouseout()
public final void setOnmouseout(java.lang.String onmouseout)
onmouseout
- the new onmouseout valuepublic final java.lang.String getOnkeypress()
public final void setOnkeypress(java.lang.String onkeypress)
onkeypress
- the new onkeypress valuepublic final java.lang.String getOnkeydown()
public final void setOnkeydown(java.lang.String onkeydown)
onkeydown
- the new onkeydown valuepublic final java.lang.String getOnkeyup()
public final void setOnkeyup(java.lang.String onkeyup)
onkeyup
- the new onkeyup valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final int getSize()
public final void setSize(int size)
size
- the new size valuepublic final java.lang.String getLeadingHeader()
public final void setLeadingHeader(java.lang.String leadingHeader)
leadingHeader
- the new leadingHeader valuepublic final java.lang.String getTrailingHeader()
public final void setTrailingHeader(java.lang.String trailingHeader)
trailingHeader
- the new trailingHeader valuepublic final boolean isLeadingDescShown()
public final void setLeadingDescShown(boolean leadingDescShown)
leadingDescShown
- the new leadingDescShown valuepublic final boolean isTrailingDescShown()
public final void setTrailingDescShown(boolean trailingDescShown)
trailingDescShown
- the new trailingDescShown valuepublic final java.lang.String getLabel()
public final void setLabel(java.lang.String label)
label
- the new label valuepublic java.lang.String getFamily()
getFamily
in class UIXSelectMany
protected FacesBean.Type getBeanType()
getBeanType
in class UIXSelectMany
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |