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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.alfresco.web.ui.common.component.UIActionLink
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class UIActionLink
extends javax.faces.component.UICommand


Field Summary
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
UIActionLink()
          Default Constructor
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getHref()
           
 java.lang.String getImage()
          Return the Image path to use for this actionlink.
 java.lang.String getOnclick()
          Returns the onclick handler
 int getPadding()
          Get the padding value for rendering this component in a table.
 java.util.Map 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
 java.lang.String getTarget()
          Get the target
 java.lang.String getTooltip()
          Get the tooltip title text
 java.lang.String getVerticalAlign()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setHref(java.lang.String href)
           
 void setImage(java.lang.String image)
          Set the Image path to use for this actionlink.
 void setOnclick(java.lang.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(java.lang.String target)
          Set the target
 void setTooltip(java.lang.String tooltip)
          Set the tooltip title text
 void setVerticalAlign(java.lang.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 java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand
See Also:
UIComponent.getFamily()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UICommand
See Also:
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UICommand
See Also:
StateHolder.saveState(javax.faces.context.FacesContext)

getParameterMap

public java.util.Map 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 java.lang.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(java.lang.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 java.lang.String getHref()
Returns:
Returns the href.

setHref

public void setHref(java.lang.String href)
Parameters:
href - The href to set.

getTooltip

public java.lang.String getTooltip()
Get the tooltip title text

Returns:
the tooltip

setTooltip

public void setTooltip(java.lang.String tooltip)
Set the tooltip title text

Parameters:
tooltip - the tooltip

getTarget

public java.lang.String getTarget()
Get the target

Returns:
the target

setTarget

public void setTarget(java.lang.String target)
Set the target

Parameters:
target - the target

getVerticalAlign

public java.lang.String getVerticalAlign()
Returns:
the verticalAlign

setVerticalAlign

public void setVerticalAlign(java.lang.String verticalAlign)
Parameters:
verticalAlign - the verticalAlign to set

getOnclick

public java.lang.String getOnclick()
Returns the onclick handler

Returns:
The onclick handler

setOnclick

public void setOnclick(java.lang.String onclick)
Sets the onclick handler

Parameters:
onclick - The onclick handler


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.