org.icefaces.ace.component.linkbutton

Class LinkButtonBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.icefaces.ace.component.linkbutton.LinkButtonBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, ILinkButton

Direct Known Subclasses:

LinkButton

public abstract class LinkButtonBase
extends javax.faces.component.UICommand
implements ILinkButton, IceClientBehaviorHolder

The Link Button is a component that functions like an HTML link.

For more information, see the LinkButton Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LinkButtonBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY

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

Constructor Summary

Constructors

Constructor and Description
LinkButtonBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getHref() Return the value of the href property.
java.lang.String	getHrefLang() Return the value of the hrefLang property.
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.Integer	getTabindex() Return the value of the tabindex property.
java.lang.String	getTarget() Return the value of the target property.
java.lang.String	getType() Return the value of the type property.
java.lang.Object	getValue() Return the value of the value property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setHref(java.lang.String href) Set the value of the href property.
void	setHrefLang(java.lang.String hrefLang) Set the value of the hrefLang 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.Integer tabindex) Set the value of the tabindex property.
void	setTarget(java.lang.String target) Set the value of the target property.
void	setType(java.lang.String type) Set the value of the type property.
void	setValue(java.lang.Object value) Set the value of the value property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, 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.behavior.ClientBehaviorHolder

getClientBehaviors

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

LinkButtonBase

public LinkButtonBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

setAccesskey in interface ILinkButton

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

getAccesskey in interface ILinkButton

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: If true, clicking the button does not send a request to the server, and also no page is loaded if href attribute was specified.

Specified by:

setDisabled in interface ILinkButton

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: If true, clicking the button does not send a request to the server, and also no page is loaded if href attribute was specified. Default = 'false'.

Specified by:

isDisabled in interface ILinkButton

setHref

public void setHref(java.lang.String href)

Set the value of the href property.

Contents: Href attribute of the anchor element. If specified and actionListener is absent, linkButton works as a normal anchor. If specified and actionListener is present, linkButton works as AJAX event source, but href may be opened in a new tab or window.

Specified by:

setHref in interface ILinkButton

getHref

public java.lang.String getHref()

Return the value of the href property.

Contents: Href attribute of the anchor element. If specified and actionListener is absent, linkButton works as a normal anchor. If specified and actionListener is present, linkButton works as AJAX event source, but href may be opened in a new tab or window.

Specified by:

getHref in interface ILinkButton

setHrefLang

public void setHrefLang(java.lang.String hrefLang)

Set the value of the hrefLang property.

Contents: Standard HTML href language attribute.

Specified by:

setHrefLang in interface ILinkButton

getHrefLang

public java.lang.String getHrefLang()

Return the value of the hrefLang property.

Contents: Standard HTML href language attribute.

Specified by:

getHrefLang in interface ILinkButton

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

setStyle in interface ILinkButton

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

getStyle in interface ILinkButton

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

setStyleClass in interface ILinkButton

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

getStyleClass in interface ILinkButton

setTabindex

public void setTabindex(java.lang.Integer tabindex)

Set the value of the tabindex property.

Contents: Tabindex of the component.

Specified by:

setTabindex in interface ILinkButton

getTabindex

public java.lang.Integer getTabindex()

Return the value of the tabindex property.

Contents: Tabindex of the component.

Specified by:

getTabindex in interface ILinkButton

setTarget

public void setTarget(java.lang.String target)

Set the value of the target property.

Contents: If the link is a traditional anchor then this is the traditional target attribute.

Specified by:

setTarget in interface ILinkButton

getTarget

public java.lang.String getTarget()

Return the value of the target property.

Contents: If the link is a traditional anchor then this is the traditional target attribute.

Specified by:

getTarget in interface ILinkButton

setType

public void setType(java.lang.String type)

Set the value of the type property.

Contents: Specifies the button type. The possible values are 'button', 'clear' and 'reset'. The 'button' type is the original and standard mode, where the button submits the form when activated or opens a link. If the type is 'clear', the component acts in a special way: the button will act in a client-side mode, clearing all fields and components in the form it is contained in. If the type is 'reset', the component will reset all the input elements and components to their original values at the time they were loaded. The button will not submit the form in the 'clear' and 'reset' modes, unless the component has a listener or an ajax event attached to it.

Specified by:

setType in interface ILinkButton

getType

public java.lang.String getType()

Return the value of the type property.

Contents: Specifies the button type. The possible values are 'button', 'clear' and 'reset'. The 'button' type is the original and standard mode, where the button submits the form when activated or opens a link. If the type is 'clear', the component acts in a special way: the button will act in a client-side mode, clearing all fields and components in the form it is contained in. If the type is 'reset', the component will reset all the input elements and components to their original values at the time they were loaded. The button will not submit the form in the 'clear' and 'reset' modes, unless the component has a listener or an ajax event attached to it. Default = 'button'.

Specified by:

getType in interface ILinkButton

setValue

public void setValue(java.lang.Object value)

Set the value of the value property.

Contents: This property defines the link text visible in the component.

Specified by:

setValue in interface ILinkButton

Overrides:

setValue in class javax.faces.component.UICommand

getValue

public java.lang.Object getValue()

Return the value of the value property.

Contents: This property defines the link text visible in the component. Default = 'Default Anchor Label'.

Specified by:

getValue in interface ILinkButton

Overrides:

getValue in class javax.faces.component.UICommand

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.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.UIComponentBase