|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.icefaces.ace.component.selectmenu.SelectMenuBase
public class SelectMenuBase
For more information, see the SelectMenu Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
SelectMenuBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME |
Fields inherited from class javax.faces.component.UIComponent |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
SelectMenuBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.lang.String |
getDir()
Return the value of the dir property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
int |
getHeight()
Return the value of the height property. |
java.lang.String |
getHideEffect()
Return the value of the hideEffect property. |
int |
getHideEffectLength()
Return the value of the hideEffectLength property. |
java.lang.String |
getIndicatorPosition()
Return the value of the indicatorPosition property. |
java.lang.Object |
getItemDisabled()
Return the value of the itemDisabled property. |
java.util.List |
getItemList()
Return the value of the itemList property. |
java.lang.Object |
getItemValue()
Return the value of the itemValue property. |
java.lang.String |
getLabel()
Return the value of the label property. |
java.lang.String |
getLabelPosition()
Return the value of the labelPosition property. |
java.lang.String |
getLang()
Return the value of the lang property. |
java.util.List |
getListValue()
Return the value of the listValue property. |
java.lang.String |
getListVar()
Return the value of the listVar property. |
java.lang.String |
getOptionalIndicator()
Return the value of the optionalIndicator property. |
java.lang.String |
getRequiredIndicator()
Return the value of the requiredIndicator property. |
java.lang.String |
getShowEffect()
Return the value of the showEffect property. |
int |
getShowEffectLength()
Return the value of the showEffectLength property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getTabindex()
Return the value of the tabindex property. |
java.lang.String |
getTitle()
Return the value of the title property. |
int |
getWidth()
Return the value of the width property. |
boolean |
isDisabled()
Return the value of the disabled property. |
boolean |
isReadonly()
Return the value of the readonly property. |
void |
setDir(java.lang.String dir)
Set the value of the dir property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setHeight(int height)
Set the value of the height property. |
void |
setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect property. |
void |
setHideEffectLength(int hideEffectLength)
Set the value of the hideEffectLength property. |
void |
setIndicatorPosition(java.lang.String indicatorPosition)
Set the value of the indicatorPosition property. |
void |
setItemDisabled(java.lang.Object itemDisabled)
Set the value of the itemDisabled property. |
void |
setItemList(java.util.List itemList)
Set the value of the itemList property. |
void |
setItemValue(java.lang.Object itemValue)
Set the value of the itemValue property. |
void |
setLabel(java.lang.String label)
Set the value of the label property. |
void |
setLabelPosition(java.lang.String labelPosition)
Set the value of the labelPosition property. |
void |
setLang(java.lang.String lang)
Set the value of the lang property. |
void |
setListValue(java.util.List listValue)
Set the value of the listValue property. |
void |
setListVar(java.lang.String listVar)
Set the value of the listVar property. |
void |
setOptionalIndicator(java.lang.String optionalIndicator)
Set the value of the optionalIndicator property. |
void |
setReadonly(boolean readonly)
Set the value of the readonly property. |
void |
setRequiredIndicator(java.lang.String requiredIndicator)
Set the value of the requiredIndicator property. |
void |
setShowEffect(java.lang.String showEffect)
Set the value of the showEffect property. |
void |
setShowEffectLength(int showEffectLength)
Set the value of the showEffectLength property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTabindex(java.lang.String tabindex)
Set the value of the tabindex property. |
void |
setTitle(java.lang.String title)
Set the value of the title property. |
void |
setWidth(int width)
Set the value of the width property. |
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue |
Methods inherited from class javax.faces.component.UIOutput |
---|
getConverter, getLocalValue, getValue, setConverter |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Methods inherited from interface javax.faces.component.ValueHolder |
---|
getConverter, getLocalValue, getValue, setConverter |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public SelectMenuBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
public void setDir(java.lang.String dir)
Set the value of the dir
property.
Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
setDir
in interface ISelectMenu
public java.lang.String getDir()
Return the value of the dir
property.
Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
getDir
in interface ISelectMenu
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".
setDisabled
in interface ISelectMenu
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". Default = 'false'.
isDisabled
in interface ISelectMenu
public void setHeight(int height)
Set the value of the height
property.
Contents: Maximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches).
setHeight
in interface ISelectMenu
public int getHeight()
Return the value of the height
property.
Contents: Maximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches).
getHeight
in interface ISelectMenu
public void setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect
property.
Contents: Effect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'.
setHideEffect
in interface ISelectMenu
public java.lang.String getHideEffect()
Return the value of the hideEffect
property.
Contents: Effect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'. Default = 'fade'.
getHideEffect
in interface ISelectMenu
public void setHideEffectLength(int hideEffectLength)
Set the value of the hideEffectLength
property.
Contents: Length of time in milliseconds the hide effect will last for.
setHideEffectLength
in interface ISelectMenu
public int getHideEffectLength()
Return the value of the hideEffectLength
property.
Contents: Length of time in milliseconds the hide effect will last for. Default = '150'.
getHideEffectLength
in interface ISelectMenu
public void setIndicatorPosition(java.lang.String indicatorPosition)
Set the value of the indicatorPosition
property.
Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
setIndicatorPosition
in interface ISelectMenu
public java.lang.String getIndicatorPosition()
Return the value of the indicatorPosition
property.
Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
getIndicatorPosition
in interface ISelectMenu
public void setItemDisabled(java.lang.Object itemDisabled)
Set the value of the itemDisabled
property.
Contents: ValueExpression that specifies the property of the data object to use for checking whether the item should be disabled or not. It must evaluate to a boolean value. This only applies when listvar is used and the rendering is done by means of a facet. When using f:selectItem(s), the disabled property on that object/tag is used for the same effect.
setItemDisabled
in interface ISelectMenu
public java.lang.Object getItemDisabled()
Return the value of the itemDisabled
property.
Contents: ValueExpression that specifies the property of the data object to use for checking whether the item should be disabled or not. It must evaluate to a boolean value. This only applies when listvar is used and the rendering is done by means of a facet. When using f:selectItem(s), the disabled property on that object/tag is used for the same effect.
getItemDisabled
in interface ISelectMenu
public void setItemValue(java.lang.Object itemValue)
Set the value of the itemValue
property.
Contents: ValueExpression that specifies the property of the data object to use as the value of the item for this component if it gets selected. This only applies when listvar is used and the rendering is done by means of a facet.
setItemValue
in interface ISelectMenu
public java.lang.Object getItemValue()
Return the value of the itemValue
property.
Contents: ValueExpression that specifies the property of the data object to use as the value of the item for this component if it gets selected. This only applies when listvar is used and the rendering is done by means of a facet.
getItemValue
in interface ISelectMenu
public void setLabel(java.lang.String label)
Set the value of the label
property.
Contents: A localized user presentable name for this component.
setLabel
in interface ISelectMenu
public java.lang.String getLabel()
Return the value of the label
property.
Contents: A localized user presentable name for this component.
getLabel
in interface ISelectMenu
public void setLabelPosition(java.lang.String labelPosition)
Set the value of the labelPosition
property.
Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
setLabelPosition
in interface ISelectMenu
public java.lang.String getLabelPosition()
Return the value of the labelPosition
property.
Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
getLabelPosition
in interface ISelectMenu
public void setLang(java.lang.String lang)
Set the value of the lang
property.
Contents: Code describing the language used in the generated markup for this component.
setLang
in interface ISelectMenu
public java.lang.String getLang()
Return the value of the lang
property.
Contents: Code describing the language used in the generated markup for this component.
getLang
in interface ISelectMenu
public void setListValue(java.util.List listValue)
Set the value of the listValue
property.
Contents: When rendering via a facet, this attribute specifies the list of data objects that contains all possible options.
setListValue
in interface ISelectMenu
public java.util.List getListValue()
Return the value of the listValue
property.
Contents: When rendering via a facet, this attribute specifies the list of data objects that contains all possible options.
getListValue
in interface ISelectMenu
public void setListVar(java.lang.String listVar)
Set the value of the listVar
property.
Contents: Variable name to use for referencing each data object in the list when rendering via a facet.
setListVar
in interface ISelectMenu
public java.lang.String getListVar()
Return the value of the listVar
property.
Contents: Variable name to use for referencing each data object in the list when rendering via a facet.
getListVar
in interface ISelectMenu
public void setOptionalIndicator(java.lang.String optionalIndicator)
Set the value of the optionalIndicator
property.
Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.
setOptionalIndicator
in interface ISelectMenu
public java.lang.String getOptionalIndicator()
Return the value of the optionalIndicator
property.
Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.
getOptionalIndicator
in interface ISelectMenu
public void setReadonly(boolean readonly)
Set the value of the readonly
property.
Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly".
setReadonly
in interface ISelectMenu
public boolean isReadonly()
Return the value of the readonly
property.
Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". Default = 'false'.
isReadonly
in interface ISelectMenu
public void setRequiredIndicator(java.lang.String requiredIndicator)
Set the value of the requiredIndicator
property.
Contents: Indicator indicating that the user is required to provide a submitted value for this input component.
setRequiredIndicator
in interface ISelectMenu
public java.lang.String getRequiredIndicator()
Return the value of the requiredIndicator
property.
Contents: Indicator indicating that the user is required to provide a submitted value for this input component.
getRequiredIndicator
in interface ISelectMenu
public void setShowEffect(java.lang.String showEffect)
Set the value of the showEffect
property.
Contents: Effect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'.
setShowEffect
in interface ISelectMenu
public java.lang.String getShowEffect()
Return the value of the showEffect
property.
Contents: Effect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'. Default = 'fade'.
getShowEffect
in interface ISelectMenu
public void setShowEffectLength(int showEffectLength)
Set the value of the showEffectLength
property.
Contents: Length of time in milliseconds the show effect will last for.
setShowEffectLength
in interface ISelectMenu
public int getShowEffectLength()
Return the value of the showEffectLength
property.
Contents: Length of time in milliseconds the show effect will last for. Default = '150'.
getShowEffectLength
in interface ISelectMenu
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style class name of the container element.
setStyle
in interface ISelectMenu
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style class name of the container element.
getStyle
in interface ISelectMenu
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class name of the container element.
setStyleClass
in interface ISelectMenu
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class name of the container element.
getStyleClass
in interface ISelectMenu
public void setTabindex(java.lang.String tabindex)
Set the value of the tabindex
property.
Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
setTabindex
in interface ISelectMenu
public java.lang.String getTabindex()
Return the value of the tabindex
property.
Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
getTabindex
in interface ISelectMenu
public void setTitle(java.lang.String title)
Set the value of the title
property.
Contents: Advisory title information about markup elements generated for this component.
setTitle
in interface ISelectMenu
public java.lang.String getTitle()
Return the value of the title
property.
Contents: Advisory title information about markup elements generated for this component.
getTitle
in interface ISelectMenu
public void setWidth(int width)
Set the value of the width
property.
Contents: The width of the text input field, in pixels.
setWidth
in interface ISelectMenu
public int getWidth()
Return the value of the width
property.
Contents: The width of the text input field, in pixels. Default = '200'.
getWidth
in interface ISelectMenu
public void setItemList(java.util.List itemList)
Set the value of the itemList
property.
setItemList
in interface ISelectMenu
public java.util.List getItemList()
Return the value of the itemList
property.
getItemList
in interface ISelectMenu
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |