org.apache.myfaces.custom.outputlinkdynamic
Class OutputLinkDynamic

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.html.HtmlOutputLink
                  org.apache.myfaces.custom.outputlinkdynamic.AbstractOutputLinkDynamic
                      org.apache.myfaces.custom.outputlinkdynamic.OutputLinkDynamic

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UserRoleAware

public class OutputLinkDynamic
extends AbstractOutputLinkDynamic

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

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

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

OutputLinkDynamic()

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	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
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	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setForceId(boolean forceId)
void	setForceIdIndex(boolean forceIdIndex)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.outputlinkdynamic.AbstractOutputLinkDynamic

getResourceRendererClass, setImageRendererClass

Methods inherited from class javax.faces.component.html.HtmlOutputLink

getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, setAccesskey, setCharset, setCoords, setDir, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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

OutputLinkDynamic

public OutputLinkDynamic()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Description copied from class: AbstractOutputLinkDynamic

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.

Specified by:

getEnabledOnUserRole in interface org.apache.myfaces.component.UserRoleAware

Specified by:

getEnabledOnUserRole in class AbstractOutputLinkDynamic

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

Specified by:

setEnabledOnUserRole in interface org.apache.myfaces.component.UserRoleAware

Specified by:

setEnabledOnUserRole in class AbstractOutputLinkDynamic

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Description copied from class: AbstractOutputLinkDynamic

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.

Specified by:

getVisibleOnUserRole in interface org.apache.myfaces.component.UserRoleAware

Specified by:

getVisibleOnUserRole in class AbstractOutputLinkDynamic

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Specified by:

setVisibleOnUserRole in interface org.apache.myfaces.component.UserRoleAware

Specified by:

setVisibleOnUserRole in class AbstractOutputLinkDynamic

isForceId

public boolean isForceId()

Description copied from class: AbstractOutputLinkDynamic

If true, this component will force the use of the specified id when rendering.

Specified by:

isForceId in interface org.apache.myfaces.component.ForceIdAware

Specified by:

isForceId in class AbstractOutputLinkDynamic

setForceId

public void setForceId(boolean forceId)

Specified by:

setForceId in interface org.apache.myfaces.component.ForceIdAware

Specified by:

setForceId in class AbstractOutputLinkDynamic

isForceIdIndex

public boolean isForceIdIndex()

Description copied from class: AbstractOutputLinkDynamic

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.)

Specified by:

isForceIdIndex in interface org.apache.myfaces.component.ForceIdAware

Specified by:

isForceIdIndex in class AbstractOutputLinkDynamic

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

Specified by:

setForceIdIndex in interface org.apache.myfaces.component.ForceIdAware

Specified by:

setForceIdIndex in class AbstractOutputLinkDynamic

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractOutputLinkDynamic

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 AbstractOutputLinkDynamic