org.alfresco.web.ui.common.component

Class UIActionLink

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.alfresco.web.ui.common.component.UIActionLink

All Implemented Interfaces:

ActionSource, StateHolder

public class UIActionLink
extends UICommand

Author:

kevinr

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Constructors

Constructor and Description
UIActionLink() Default Constructor

Method Summary

Modifier and Type	Method and Description
String	getFamily()
String	getHref()
String	getImage() Return the Image path to use for this actionlink.
String	getOnclick() Returns the onclick handler
int	getPadding() Get the padding value for rendering this component in a table.
Map<String,String>	getParameterMap() Return the current child parameter map for this action link instance.
boolean	getShowLink() Get whether to show the link as well as the image if specified
String	getTarget() Get the target
String	getTooltip() Get the tooltip title text
String	getVerticalAlign()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setHref(String href)
void	setImage(String image) Set the Image path to use for this actionlink.
void	setOnclick(String onclick) Sets the onclick handler
void	setPadding(int padding) Set the padding value for rendering this component in a table.
void	setShowLink(boolean showLink) Set whether to show the link as well as the image if specified
void	setTarget(String target) Set the target
void	setTooltip(String tooltip) Set the tooltip title text
void	setVerticalAlign(String verticalAlign)

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, 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, 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

Constructor Detail

UIActionLink

public UIActionLink()

Default Constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UICommand

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UICommand

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UICommand

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

getParameterMap

public Map<String,String> getParameterMap()

Return the current child parameter map for this action link instance. This map is filled with name/value pairs from any child UIParameter components.

Returns:

Map of name/value pairs

getShowLink

public boolean getShowLink()

Get whether to show the link as well as the image if specified

Returns:

true to show the link as well as the image if specified

setShowLink

public void setShowLink(boolean showLink)

Set whether to show the link as well as the image if specified

Parameters:

showLink - Whether to show the link as well as the image if specified

getPadding

public int getPadding()

Get the padding value for rendering this component in a table.

Returns:

the padding in pixels, if set != 0 then a table will be rendering around the items

setPadding

public void setPadding(int padding)

Set the padding value for rendering this component in a table.

Parameters:

padding - value in pixels, if set != 0 then a table will be rendering around the items

getImage

public String getImage()

Return the Image path to use for this actionlink. If an image is specified, it is shown in additon to the value text unless the 'showLink' property is set to 'false'.

Returns:

the image path to display

setImage

public void setImage(String image)

Set the Image path to use for this actionlink. If an image is specified, it is shown in additon to the value text unless the 'showLink' property is set to 'false'.

Parameters:

image - Image path to display

getHref

public String getHref()

Returns:

Returns the href.

setHref

public void setHref(String href)

Parameters:

href - The href to set.

getTooltip

public String getTooltip()

Get the tooltip title text

Returns:

the tooltip

setTooltip

public void setTooltip(String tooltip)

Set the tooltip title text

Parameters:

tooltip - the tooltip

getTarget

public String getTarget()

Get the target

Returns:

the target

setTarget

public void setTarget(String target)

Set the target

Parameters:

target - the target

getVerticalAlign

public String getVerticalAlign()

Returns:

the verticalAlign

setVerticalAlign

public void setVerticalAlign(String verticalAlign)

Parameters:

verticalAlign - the verticalAlign to set

getOnclick

public String getOnclick()

Returns the onclick handler

Returns:

The onclick handler

setOnclick

public void setOnclick(String onclick)

Sets the onclick handler

Parameters:

onclick - The onclick handler