org.apache.myfaces.component.html.ext
Class HtmlSelectManyCheckbox

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.UISelectMany
                      extended by javax.faces.component.html.HtmlSelectManyCheckbox
                          extended by org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyCheckbox
                              extended by org.apache.myfaces.component.html.ext.HtmlSelectManyCheckbox
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, AltProperty, DataProperties, DisplayValueOnlyAware, EscapeAware, ForceIdAware, UserRoleAware, ExtendedComponentBase, DisplayValueOnlyCapable, EscapeCapable

public class HtmlSelectManyCheckbox
extends AbstractHtmlSelectManyCheckbox


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UISelectMany
INVALID_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
HtmlSelectManyCheckbox()
           
 
Method Summary
 java.lang.String getAlt()
          HTML: Specifies alternative text that can be used by a browser that can't show this element.
 java.lang.String getDatafld()
          Reserved for future use.
 java.lang.String getDataformatas()
          Reserved for future use.
 java.lang.String getDatasrc()
          Reserved for future use.
 java.lang.Boolean getDisplayValueOnly()
          If true, renders only the value of the component, but no input widget.
 java.lang.String getDisplayValueOnlyStyle()
          Style used when displayValueOnly is true.
 java.lang.String getDisplayValueOnlyStyleClass()
          Style class used when displayValueOnly is true.
 java.lang.String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.lang.String getFamily()
           
 java.lang.String getLayoutWidth()
          A integer representing the number of checkbox rows if the layout is lineDirection and checkbox columns if the layout is pageDirection.
 java.lang.String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isEscape()
          Indicates whether rendered markup should be escaped.
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setAlt(java.lang.String alt)
           
 void setDatafld(java.lang.String datafld)
           
 void setDataformatas(java.lang.String dataformatas)
           
 void setDatasrc(java.lang.String datasrc)
           
 void setDisplayValueOnly(java.lang.Boolean displayValueOnly)
           
 void setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)
           
 void setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setEscape(boolean escape)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setLayoutWidth(java.lang.String layoutWidth)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyCheckbox
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlSelectManyCheckbox
getAccesskey, getBorder, getDir, getDisabledClass, getEnabledClass, getLang, getLayout, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setBorder, setDir, setDisabled, setDisabledClass, setEnabledClass, setLang, setLayout, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setTabindex, setTitle
 
Methods inherited from class javax.faces.component.UISelectMany
compareValues, getConvertedValue, getSelectedValues, getValueBinding, setSelectedValues, setValueBinding, validate, validateValue
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, decode, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
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.ValueHolder
getConverter, getLocalValue, setConverter
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlSelectManyCheckbox

public HtmlSelectManyCheckbox()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UISelectMany

getLayoutWidth

public java.lang.String getLayoutWidth()
Description copied from class: AbstractHtmlSelectManyCheckbox
A integer representing the number of checkbox rows if the layout is lineDirection and checkbox columns if the layout is pageDirection.

Specified by:
getLayoutWidth in class AbstractHtmlSelectManyCheckbox

setLayoutWidth

public void setLayoutWidth(java.lang.String layoutWidth)

getDisplayValueOnly

public java.lang.Boolean getDisplayValueOnly()
Description copied from interface: DisplayValueOnlyAware
If true, renders only the value of the component, but no input widget. Default is false.


setDisplayValueOnly

public void setDisplayValueOnly(java.lang.Boolean displayValueOnly)

getDisplayValueOnlyStyle

public java.lang.String getDisplayValueOnlyStyle()
Description copied from interface: DisplayValueOnlyAware
Style used when displayValueOnly is true.


setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public java.lang.String getDisplayValueOnlyStyleClass()
Description copied from interface: DisplayValueOnlyAware
Style class used when displayValueOnly is true.


setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

getAlt

public java.lang.String getAlt()
Description copied from interface: AltProperty
HTML: Specifies alternative text that can be used by a browser that can't show this element.


setAlt

public void setAlt(java.lang.String alt)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.


setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

isEscape

public boolean isEscape()
Description copied from interface: EscapeAware
Indicates whether rendered markup should be escaped. Default: true


setEscape

public void setEscape(boolean escape)

getDatafld

public java.lang.String getDatafld()
Description copied from interface: DataProperties
Reserved for future use.


setDatafld

public void setDatafld(java.lang.String datafld)

getDatasrc

public java.lang.String getDatasrc()
Description copied from interface: DataProperties
Reserved for future use.


setDatasrc

public void setDatasrc(java.lang.String datasrc)

getDataformatas

public java.lang.String getDataformatas()
Description copied from interface: DataProperties
Reserved for future use.


setDataformatas

public void setDataformatas(java.lang.String dataformatas)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.html.HtmlSelectManyCheckbox

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.html.HtmlSelectManyCheckbox


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.