org.apache.myfaces.custom.radio
Class HtmlRadio

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.radio.AbstractHtmlRadio
              org.apache.myfaces.custom.radio.HtmlRadio

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, AccesskeyProperty, AlignProperty, AltProperty, ChangeSelectProperties, DisabledClassEnabledClassProperties, EventAware, FocusBlurProperties, StyleAware, TabindexProperty, UniversalProperties, UserRoleAware

public class HtmlRadio
extends AbstractHtmlRadio

Nested Class Summary

protected static class

HtmlRadio.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.radio.AbstractHtmlRadio

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

HtmlRadio()

Method Summary

java.lang.String	getAccesskey() HTML: Sets the access key for this element.
java.lang.String	getAlign() HTML: Specifies the horizontal alignment of this element.
java.lang.String	getAlt() HTML: Specifies alternative text that can be used by a browser that can't show this element.
java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.lang.String	getDisabledClass() The CSS class assigned to the label element for enabled choices.
java.lang.String	getEnabledClass() The CSS class assigned to the label element for enabled choices.
java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getFor() The id of the referenced extended selectOneRadio component.
int	getIndex() The index of the corresponding SelectItem, where 0 represents the first SelectItem.
java.lang.String	getLang() HTML: The base language of this document.
java.lang.String	getOnblur() HTML: Specifies a script to be invoked when the element loses focus.
java.lang.String	getOnchange() HTML: Specifies a script to be invoked when the element is modified.
java.lang.String	getOnclick() HTML: Script to be invoked when the element is clicked.
java.lang.String	getOndblclick() HTML: Script to be invoked when the element is double-clicked.
java.lang.String	getOnfocus() HTML: Specifies a script to be invoked when the element receives focus.
java.lang.String	getOnkeydown() HTML: Script to be invoked when a key is pressed down over this element.
java.lang.String	getOnkeypress() HTML: Script to be invoked when a key is pressed over this element.
java.lang.String	getOnkeyup() HTML: Script to be invoked when a key is released over this element.
java.lang.String	getOnmousedown() HTML: Script to be invoked when the pointing device is pressed over this element.
java.lang.String	getOnmousemove() HTML: Script to be invoked when the pointing device is moved while it is in this element.
java.lang.String	getOnmouseout() HTML: Script to be invoked when the pointing device is moves out of this element.
java.lang.String	getOnmouseover() HTML: Script to be invoked when the pointing device is moved into this element.
java.lang.String	getOnmouseup() HTML: Script to be invoked when the pointing device is released over this element.
java.lang.String	getOnselect() HTML: Specifies a script to be invoked when the element is selected.
java.lang.String	getStyle() HTML: CSS styling instructions.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getTabindex() HTML: Specifies the position of this element within the tab order of the document.
java.lang.String	getTitle() HTML: An advisory title for this element.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
boolean	isRenderLogicalId() If this property is set to true, the id generated for the input html markup will be the logical id composed from the clientId of the associated selectOneRadio and the index of this component (for example 'myComp:2').
void	setAccesskey(java.lang.String accesskey)
void	setAlign(java.lang.String align)
void	setAlt(java.lang.String alt)
void	setDir(java.lang.String dir)
void	setDisabledClass(java.lang.String disabledClass)
void	setEnabledClass(java.lang.String enabledClass)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setFor(java.lang.String forParam)
void	setIndex(int index)
void	setLang(java.lang.String lang)
void	setOnblur(java.lang.String onblur)
void	setOnchange(java.lang.String onchange)
void	setOnclick(java.lang.String onclick)
void	setOndblclick(java.lang.String ondblclick)
void	setOnfocus(java.lang.String onfocus)
void	setOnkeydown(java.lang.String onkeydown)
void	setOnkeypress(java.lang.String onkeypress)
void	setOnkeyup(java.lang.String onkeyup)
void	setOnmousedown(java.lang.String onmousedown)
void	setOnmousemove(java.lang.String onmousemove)
void	setOnmouseout(java.lang.String onmouseout)
void	setOnmouseover(java.lang.String onmouseover)
void	setOnmouseup(java.lang.String onmouseup)
void	setOnselect(java.lang.String onselect)
void	setRenderLogicalId(boolean renderLogicalId)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTabindex(java.lang.String tabindex)
void	setTitle(java.lang.String title)
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

HtmlRadio

public HtmlRadio()

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: AbstractHtmlRadio

The id of the referenced extended selectOneRadio component. This value is resolved to the particular component using the standard UIComponent.findComponent() searching algorithm.

Specified by:

getFor in class AbstractHtmlRadio

setFor

public void setFor(java.lang.String forParam)

getIndex

public int getIndex()

Description copied from class: AbstractHtmlRadio

The index of the corresponding SelectItem, where 0 represents the first SelectItem.

Specified by:

getIndex in class AbstractHtmlRadio

setIndex

public void setIndex(int index)

isRenderLogicalId

public boolean isRenderLogicalId()

Description copied from class: AbstractHtmlRadio

If this property is set to true, the id generated for the input html markup will be the logical id composed from the clientId of the associated selectOneRadio and the index of this component (for example 'myComp:2').

NOTE: This is provided only for backward compatibility with tomahawk 1.2. Activate this behavior will make client behaviors added to t:selectOneRadio like f:ajax or others fail, because the logical id has no counterpart in the component tree.

Specified by:

isRenderLogicalId in class AbstractHtmlRadio

Returns:

setRenderLogicalId

public void setRenderLogicalId(boolean renderLogicalId)

getOnclick

public java.lang.String getOnclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is clicked.

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is double-clicked.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed down over this element.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed over this element.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is released over this element.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getOnmousedown

public java.lang.String getOnmousedown()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is pressed over this element.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

getOnmousemove

public java.lang.String getOnmousemove()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved while it is in this element.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

getOnmouseout

public java.lang.String getOnmouseout()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moves out of this element.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

getOnmouseover

public java.lang.String getOnmouseover()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved into this element.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

getOnmouseup

public java.lang.String getOnmouseup()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is released over this element.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

getOnblur

public java.lang.String getOnblur()

Description copied from interface: FocusBlurProperties

HTML: Specifies a script to be invoked when the element loses focus.

setOnblur

public void setOnblur(java.lang.String onblur)

getOnfocus

public java.lang.String getOnfocus()

Description copied from interface: FocusBlurProperties

HTML: Specifies a script to be invoked when the element receives focus.

setOnfocus

public void setOnfocus(java.lang.String onfocus)

getAccesskey

public java.lang.String getAccesskey()

Description copied from interface: AccesskeyProperty

HTML: Sets the access key for this element.

setAccesskey

public void setAccesskey(java.lang.String accesskey)

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)

getDisabledClass

public java.lang.String getDisabledClass()

Description copied from interface: DisabledClassEnabledClassProperties

The CSS class assigned to the label element for enabled choices.

setDisabledClass

public void setDisabledClass(java.lang.String disabledClass)

getEnabledClass

public java.lang.String getEnabledClass()

Description copied from interface: DisabledClassEnabledClassProperties

The CSS class assigned to the label element for enabled choices.

setEnabledClass

public void setEnabledClass(java.lang.String enabledClass)

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)

getTabindex

public java.lang.String getTabindex()

Description copied from interface: TabindexProperty

HTML: Specifies the position of this element within the tab order of the document.

setTabindex

public void setTabindex(java.lang.String tabindex)

getDir

public java.lang.String getDir()

Description copied from interface: UniversalProperties

HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()

Description copied from interface: UniversalProperties

HTML: The base language of this document.

setLang

public void setLang(java.lang.String lang)

getTitle

public java.lang.String getTitle()

Description copied from interface: UniversalProperties

HTML: An advisory title for this element. Often used by the user agent as a tooltip.

setTitle

public void setTitle(java.lang.String title)

getOnchange

public java.lang.String getOnchange()

Description copied from interface: ChangeSelectProperties

HTML: Specifies a script to be invoked when the element is modified.

setOnchange

public void setOnchange(java.lang.String onchange)

getOnselect

public java.lang.String getOnselect()

Description copied from interface: ChangeSelectProperties

HTML: Specifies a script to be invoked when the element is selected.

setOnselect

public void setOnselect(java.lang.String onselect)

getStyle

public java.lang.String getStyle()

Description copied from interface: StyleAware

HTML: CSS styling instructions.

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: StyleAware

The CSS class for this element. Corresponds to the HTML 'class' attribute.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getAlign

public java.lang.String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(java.lang.String align)