com.ibm.xsp.component.xp
Class XspSelectManyCheckbox

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.UISelectMany
                      com.ibm.xsp.component.UISelectManyEx
                          com.ibm.xsp.component.UISelectManyCheckbox
                              com.ibm.xsp.component.xp.XspSelectManyCheckbox

All Implemented Interfaces:

FacesAttrsObject, FacesInputComponent, FacesDojoComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class XspSelectManyCheckbox
extends UISelectManyCheckbox

A control that displays multiple check boxes.

XPages Core Controls - Check Box Group

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UISelectMany

COMPONENT_FAMILY, INVALID_MESSAGE_ID

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspSelectManyCheckbox()

Method Summary

java.lang.String	getAccesskey() Return the value of the accesskey property.
int	getBorder() Return the value of the border property.
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getDisabledClass() Return the value of the disabledClass property.
java.lang.String	getEnabledClass() Return the value of the enabledClass property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getLayout() Return the value of the layout property.
java.lang.String	getLegend() Return the value of the legend property.
java.lang.String	getOnblur() Return the value of the onblur property.
java.lang.String	getOnchange() Return the value of the onchange property.
java.lang.String	getOnclick() Return the value of the onclick property.
java.lang.String	getOndblclick() Return the value of the ondblclick property.
java.lang.String	getOnfocus() Return the value of the onfocus property.
java.lang.String	getOnkeydown() Return the value of the onkeydown property.
java.lang.String	getOnkeypress() Return the value of the onkeypress property.
java.lang.String	getOnkeyup() Return the value of the onkeyup property.
java.lang.String	getOnmousedown() Return the value of the onmousedown property.
java.lang.String	getOnmousemove() Return the value of the onmousemove property.
java.lang.String	getOnmouseout() Return the value of the onmouseout property.
java.lang.String	getOnmouseover() Return the value of the onmouseover property.
java.lang.String	getOnmouseup() Return the value of the onmouseup property.
java.lang.String	getRole() Return the value of the role 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.
boolean	isDisabled() Return the value of the disabled property.
boolean	isReadonly() Return the value of the readonly property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setBorder(int border) Set the value of the border 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	setDisabledClass(java.lang.String disabledClass) Set the value of the disabledClass property.
void	setEnabledClass(java.lang.String enabledClass) Set the value of the enabledClass property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setLayout(java.lang.String layout) Set the value of the layout property.
void	setLegend(java.lang.String legend) Set the value of the legend property.
void	setOnblur(java.lang.String onblur) Set the value of the onblur property.
void	setOnchange(java.lang.String onchange) Set the value of the onchange property.
void	setOnclick(java.lang.String onclick) Set the value of the onclick property.
void	setOndblclick(java.lang.String ondblclick) Set the value of the ondblclick property.
void	setOnfocus(java.lang.String onfocus) Set the value of the onfocus property.
void	setOnkeydown(java.lang.String onkeydown) Set the value of the onkeydown property.
void	setOnkeypress(java.lang.String onkeypress) Set the value of the onkeypress property.
void	setOnkeyup(java.lang.String onkeyup) Set the value of the onkeyup property.
void	setOnmousedown(java.lang.String onmousedown) Set the value of the onmousedown property.
void	setOnmousemove(java.lang.String onmousemove) Set the value of the onmousemove property.
void	setOnmouseout(java.lang.String onmouseout) Set the value of the onmouseout property.
void	setOnmouseover(java.lang.String onmouseover) Set the value of the onmouseover property.
void	setOnmouseup(java.lang.String onmouseup) Set the value of the onmouseup property.
void	setReadonly(boolean readonly) Set the value of the readonly property.
void	setRole(java.lang.String role) Set the value of the role 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.

Methods inherited from class com.ibm.xsp.component.UISelectManyCheckbox

addAttr, getAttrs, setAttrs

Methods inherited from class com.ibm.xsp.component.UISelectManyEx

addDojoAttribute, encodeBegin, encodeEnd, getDefaultValue, getDojoAttributes, getDojoType, getRequiredMessage, getStyleKitFamily, getValue, isDisableClientSideValidation, isDisableModifiedFlag, isDisableValidators, isRequired, isShowReadonlyAsDisabled, setDefaultValue, setDisableClientSideValidation, setDisableModifiedFlag, setDisableValidators, setDojoAttributes, setDojoType, setRequired, setShowReadonlyAsDisabled, setValueBinding, validate, validateValue

Methods inherited from class javax.faces.component.UISelectMany

compareValues, getFamily, getSelectedValues, getValueBinding, setSelectedValues

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, 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

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, 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.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

XspSelectManyCheckbox

public XspSelectManyCheckbox()

Method Detail

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed

getBorder

public int getBorder()

Return the value of the border property. Contents:

Specifies the pixel width of the border around the table containing the list

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getDisabledClass

public java.lang.String getDisabledClass()

Return the value of the disabledClass property. Contents:

Specifies the CSS style class to apply to the label for the disabled list

getEnabledClass

public java.lang.String getEnabledClass()

Return the value of the enabledClass property. Contents:

Specifies the CSS style class to apply to the label for the enabled list

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getLayout

public java.lang.String getLayout()

Return the value of the layout property. Contents:

Specifies the orientation of the list. Valid values are "pageDirection" (vertical layout), or "lineDirection" (horizontal layout). Defaults to "lineDirection".

getLegend

public java.lang.String getLegend()

Return the value of the legend property. Contents:

A description that appears as text above the group of controls.

getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus

getOnchange

public java.lang.String getOnchange()

Return the value of the onchange property. Contents:

JavaScript code executed when this control loses focus and its value has been modified since gaining focus

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control

getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control

getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus

getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control

getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

isDisabled

public boolean isDisabled()

Return the value of the disabled property. Contents:

Determines whether or not the page can receive focus or be included in page submissions.

isReadonly

public boolean isReadonly()

Return the value of the readonly property. Contents:

Prohibits changes by the user, and value is not saved when submitted. The output is shown at text unless the property showReadonlyAsDisabled is true.

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UISelectManyCheckbox

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UISelectManyCheckbox

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

setBorder

public void setBorder(int border)

Set the value of the border property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

setDisabledClass

public void setDisabledClass(java.lang.String disabledClass)

Set the value of the disabledClass property.

setEnabledClass

public void setEnabledClass(java.lang.String enabledClass)

Set the value of the enabledClass property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setLayout

public void setLayout(java.lang.String layout)

Set the value of the layout property.

setLegend

public void setLegend(java.lang.String legend)

Set the value of the legend property.

setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.

setOnchange

public void setOnchange(java.lang.String onchange)

Set the value of the onchange property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.

setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.

setReadonly

public void setReadonly(boolean readonly)

Set the value of the readonly property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.