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

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.html.HtmlOutputLabel
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlOutputLabel
                      extended by org.apache.myfaces.component.html.ext.HtmlOutputLabel
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ForceIdAware, UserRoleAware

public class HtmlOutputLabel
extends AbstractHtmlOutputLabel


Nested Class Summary
protected static class HtmlOutputLabel.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
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
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlOutputLabel()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getDir()
           
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getLang()
           
 String getOnblur()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnfocus()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTitle()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isEscape()
           
 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 setAccesskey(String accesskey)
           
 void setDir(String dir)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setEscape(boolean escape)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setLang(String lang)
           
 void setOnblur(String onblur)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnfocus(String onfocus)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlOutputLabel
getClientId, isRendered
 
Methods inherited from class javax.faces.component.html.HtmlOutputLabel
getEventNames, getFor, setFor
 
Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
 
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, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

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

HtmlOutputLabel

public HtmlOutputLabel()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlOutputLabel

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlOutputLabel

getEnabledOnUserRole

public 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(String enabledOnUserRole)

getVisibleOnUserRole

public 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(String visibleOnUserRole)

isForceId

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

Returns:

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)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlOutputLabel

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlOutputLabel

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlOutputLabel

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlOutputLabel

isEscape

public boolean isEscape()
Overrides:
isEscape in class javax.faces.component.html.HtmlOutputLabel

setEscape

public void setEscape(boolean escape)
Overrides:
setEscape in class javax.faces.component.html.HtmlOutputLabel

getTabindex

public String getTabindex()
Overrides:
getTabindex in class javax.faces.component.html.HtmlOutputLabel

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class javax.faces.component.html.HtmlOutputLabel

getOnblur

public String getOnblur()
Overrides:
getOnblur in class javax.faces.component.html.HtmlOutputLabel

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class javax.faces.component.html.HtmlOutputLabel

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class javax.faces.component.html.HtmlOutputLabel

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class javax.faces.component.html.HtmlOutputLabel

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class javax.faces.component.html.HtmlOutputLabel

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class javax.faces.component.html.HtmlOutputLabel

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlOutputLabel

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlOutputLabel

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlOutputLabel

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlOutputLabel

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlOutputLabel

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlOutputLabel

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlOutputLabel

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlOutputLabel

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlOutputLabel

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlOutputLabel

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlOutputLabel

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlOutputLabel

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlOutputLabel

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlOutputLabel

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlOutputLabel

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlOutputLabel

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlOutputLabel

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlOutputLabel

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlOutputLabel

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlOutputLabel

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlOutputLabel

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlOutputLabel

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlOutputLabel

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlOutputLabel

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlOutputLabel

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlOutputLabel

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlOutputLabel

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlOutputLabel


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