com.infragistics.faces.shared.component
Class Link

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.infragistics.faces.shared.component.Link

All Implemented Interfaces:

javax.faces.component.ActionSource, javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlLink

public class Link

extends javax.faces.component.UICommand

This component can act as a regular link (outputLink) or a link that submit to the server-side (commandLink), depending upon the url property. Note that the target property works in both mode.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Constructor Summary

Link()

Method Summary

javax.faces.convert.Converter	getConverter() Returns the Converter instance registered with this component.
java.lang.String	getFamily()
java.lang.String	getHoverIconUrl() Returns the url of the image to display whenever the mouse cursor moves over the compoennt
java.lang.String	getIconPosition() Returns the alignment of the icon
java.lang.String	getIconUrl() Returns the url of the image to display
java.lang.String	getParameterValue(java.lang.String parameterName) Returns the value of the specified parameter
java.lang.String	getShortcut() Returns the shortcut key (1 character) that is used to give the focus to the component.
java.lang.String	getTooltip() Returns the specified the text of the tooltip
java.lang.Object	getValue() Returns the The current value of this component
boolean	isDisabled() Returns the flag indicating whether the component is disabled or no
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setConverter(javax.faces.convert.Converter converter) Sets the Converter instance registered with this component.
void	setDisabled(boolean disabled) Sets the flag indicating whether the component is disabled or no
void	setHoverIconUrl(java.lang.String hoverIconUrl) Sets the url of the image to display whenever the mouse cursor moves over the compoennt
void	setIconPosition(java.lang.String iconPosition) Sets the alignment of the icon
void	setIconUrl(java.lang.String iconUrl) Sets the url of the image to display
void	setShortcut(java.lang.String shortcut) Sets the shortcut key (1 character) that is used to give the focus to the component.
void	setTooltip(java.lang.String tooltip) Sets the specified the text of the tooltip
void	setValue(java.lang.Object value) Sets the The current value of this component

Methods inherited from class javax.faces.component.UICommand

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

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE

Constructor Detail

Link

public Link()

Method Detail

getFamily

public java.lang.String getFamily()

getConverter

public javax.faces.convert.Converter getConverter()

Returns the Converter instance registered with this component.

Returns:

javax.faces.convert.Converter

isDisabled

public boolean isDisabled()

Returns the flag indicating whether the component is disabled or no

Returns:

boolean

getHoverIconUrl

public java.lang.String getHoverIconUrl()

Returns the url of the image to display whenever the mouse cursor moves over the compoennt

Returns:

java.lang.String

getIconPosition

public java.lang.String getIconPosition()

Returns the alignment of the icon

Returns:

com.infragistics.faces.shared.enumeration.HPosition (left, right)

getIconUrl

public java.lang.String getIconUrl()

Returns the url of the image to display

Returns:

java.lang.String

getParameterValue

public java.lang.String getParameterValue(java.lang.String parameterName)

Returns the value of the specified parameter

Parameters:

parameterName -

Returns:

getShortcut

public java.lang.String getShortcut()

Returns the shortcut key (1 character) that is used to give the focus to the component.

Returns:

java.lang.String

getTooltip

public java.lang.String getTooltip()

Returns the specified the text of the tooltip

Returns:

java.lang.String

getValue

public java.lang.Object getValue()

Returns the The current value of this component

Returns:

java.lang.Object

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Sets the Converter instance registered with this component.

Parameters:

converter - Converter

setDisabled

public void setDisabled(boolean disabled)

Sets the flag indicating whether the component is disabled or no

Parameters:

disabled - boolean

setHoverIconUrl

public void setHoverIconUrl(java.lang.String hoverIconUrl)

Sets the url of the image to display whenever the mouse cursor moves over the compoennt

Parameters:

hoverIconUrl - String

setIconPosition

public void setIconPosition(java.lang.String iconPosition)

Sets the alignment of the icon

Parameters:

iconPosition - String (left, right)

setIconUrl

public void setIconUrl(java.lang.String iconUrl)

Sets the url of the image to display

Parameters:

iconUrl - String

setShortcut

public void setShortcut(java.lang.String shortcut)

Sets the shortcut key (1 character) that is used to give the focus to the component.

Parameters:

shortcut - String

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the specified the text of the tooltip

Parameters:

tooltip - String

setValue

public void setValue(java.lang.Object value)

Sets the The current value of this component

Parameters:

value - Object

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

saveState

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