org.apache.click.extras.control
Class ExternalLink

java.lang.Object
  extended by org.apache.click.control.AbstractControl
      extended by org.apache.click.control.AbstractLink
          extended by org.apache.click.extras.control.ExternalLink
All Implemented Interfaces:
Serializable, Control, Stateful

public class ExternalLink
extends AbstractLink

Provides an External Link control:   <a href="" ></a>.

External Link
The ExternalLink control is used to create links to external pages and resources. See also the W3C HTML reference: A Links

See Also:
Serialized Form

Field Summary
protected  String targetPath
          The target path.
 
Fields inherited from class org.apache.click.control.AbstractLink
disabled, imageSrc, label, parameters, renderLabelAndImage, tabindex, title
 
Fields inherited from class org.apache.click.control.AbstractControl
actionListener, attributes, behaviors, headElements, listener, listenerMethod, messages, name, parent, styles
 
Fields inherited from interface org.apache.click.Control
CONTROL_MESSAGES
 
Constructor Summary
ExternalLink()
          Create an ExternalLink with no name defined.
ExternalLink(String name)
          Create an ExternalLink for the given name.
ExternalLink(String name, String targetPath)
          Create an ExternalLink for the given name and target Page class.
 
Method Summary
 String getHref()
          Return the ExternalLink anchor <a> tag href attribute.
 String getTargetPath()
          Return the link href target path.
 boolean onProcess()
          This method will return true.
 void setActionListener(ActionListener listener)
          This method does nothing.
 void setListener(Object listener, String method)
          This method does nothing.
 void setTargetPath(String targetPath)
          Set the link href target path.
 
Methods inherited from class org.apache.click.control.AbstractLink
bindRequestParameters, bindRequestValue, defineParameter, getId, getImageSrc, getLabel, getParameter, getParameters, getParameterValues, getState, getTabIndex, getTag, getTitle, hasParameters, isAjaxTarget, isDisabled, isRenderLabelAndImage, removeState, render, renderImgTag, renderParameters, restoreState, saveState, setDisabled, setImageSrc, setLabel, setParameter, setParameters, setParameterValues, setRenderLabelAndImage, setState, setTabIndex, setTitle
 
Methods inherited from class org.apache.click.control.AbstractControl
addBehavior, addStyleClass, appendAttributes, dispatchActionEvent, getActionListener, getAttribute, getAttributes, getBehaviors, getContext, getControlSizeEst, getHeadElements, getHtmlImports, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, hasAttribute, hasAttributes, hasBehaviors, hasStyles, onDeploy, onDestroy, onInit, onRender, removeBehavior, removeStyleClass, renderTagBegin, renderTagEnd, setAttribute, setId, setName, setParent, setStyle, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

targetPath

protected String targetPath
The target path.

Constructor Detail

ExternalLink

public ExternalLink(String name)
Create an ExternalLink for the given name.

Parameters:
name - the page link name
Throws:
IllegalArgumentException - if the name is null

ExternalLink

public ExternalLink(String name,
                    String targetPath)
Create an ExternalLink for the given name and target Page class.

Parameters:
name - the page link name
targetPath - the href target path
Throws:
IllegalArgumentException - if the name is null

ExternalLink

public ExternalLink()
Create an ExternalLink with no name defined.

Please note the control's name and target path must be defined before it is valid.

Method Detail

getHref

public String getHref()
Return the ExternalLink anchor <a> tag href attribute. This method will encode the URL with the session ID if required using HttpServletResponse.encodeURL().

Specified by:
getHref in class AbstractLink
Returns:
the ExternalLink HTML href attribute

setActionListener

public void setActionListener(ActionListener listener)
This method does nothing.

Overrides:
setActionListener in class AbstractControl
Parameters:
listener - the listener to invoke
See Also:
AbstractControl.setActionListener(org.apache.click.ActionListener)

setListener

public void setListener(Object listener,
                        String method)
This method does nothing.

Specified by:
setListener in interface Control
Overrides:
setListener in class AbstractControl
Parameters:
listener - the listener object with the named method to invoke
method - the name of the method to invoke
See Also:
Control.setListener(Object, String)

getTargetPath

public String getTargetPath()
Return the link href target path.

Returns:
the link href target path

setTargetPath

public void setTargetPath(String targetPath)
Set the link href target path.

Parameters:
targetPath - the link href target path

onProcess

public boolean onProcess()
This method will return true.

Specified by:
onProcess in interface Control
Overrides:
onProcess in class AbstractControl
Returns:
true
See Also:
Control.onProcess()