org.apache.myfaces.custom.checkbox
Class HtmlCheckbox

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.checkbox.AbstractHtmlCheckbox
              org.apache.myfaces.custom.checkbox.HtmlCheckbox

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, UserRoleAware

public class HtmlCheckbox
extends AbstractHtmlCheckbox

Nested Class Summary

protected static class

HtmlCheckbox.PropertyKeys

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 org.apache.myfaces.custom.checkbox.AbstractHtmlCheckbox

FOR_ATTR, INDEX_ATTR

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlCheckbox()

Method Summary

java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getFor() id of the referenced extended selectManyCheckbox component
int	getIndex() n-th SelectItem of referenced UISelectMany starting with 0.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setFor(java.lang.String forParam)
void	setIndex(int index)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

HtmlCheckbox

public HtmlCheckbox()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getFor

public java.lang.String getFor()

Description copied from class: AbstractHtmlCheckbox

id of the referenced extended selectManyCheckbox component

Specified by:

getFor in class AbstractHtmlCheckbox

setFor

public void setFor(java.lang.String forParam)

getIndex

public int getIndex()

Description copied from class: AbstractHtmlCheckbox

n-th SelectItem of referenced UISelectMany starting with 0.

Specified by:

getIndex in class AbstractHtmlCheckbox

setIndex

public void setIndex(int index)

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)