Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.taglib.html
Class LinkTag

    java.lang.Object
      javax.servlet.jsp.tagext.TagSupport
          javax.servlet.jsp.tagext.BodyTagSupport
              org.apache.struts.taglib.html.BaseHandlerTag
                  org.apache.struts.taglib.html.LinkTag

All Implemented Interfaces:
  Serializable, BodyTag, IterationTag, Tag

Direct Known Subclasses:
  ELLinkTag, FrameTag, NestedLinkTag, RewriteTag

    public class LinkTag

extends BaseHandlerTag

Generate a URL-encoded hyperlink to the specified URI.

Version:
  $Rev: 519563 $ $Date: 2005-04-06 02:37:00 -0400 (Wed, 06 Apr 2005) $
See Also:
  Serialized Form

Field Summary
`protected String` | `action` The module-relative action (beginning with a slash) which will be called by this link
`protected String` | `anchor` The anchor to be added to the end of the generated hyperlink.
`protected String` | `forward` The logical forward name from which to retrieve the hyperlink URI.
`protected String` | `href` The hyperlink URI.
`protected String` | `indexId` Name of parameter to generate to hold index number
`protected String` | `linkName` The link name for named links.
`protected static MessageResources` | `messages` The message resources for this package.
`protected String` | `module` The module prefix (beginning with a slash) which will be used to find the action for this link.
`protected String` | `name` The JSP bean name for query parameters.
`protected String` | `page` The module-relative page URL (beginning with a slash) to which this hyperlink will be rendered.
`protected Map` | `parameters` Additional parameters included programatically.
`protected String` | `paramId` The single-parameter request parameter name to generate.
`protected String` | `paramName` The single-parameter JSP bean name.
`protected String` | `paramProperty` The single-parameter JSP bean property.
`protected String` | `paramScope` The single-parameter JSP bean scope.
`protected String` | `property` The JSP bean property name for query parameters.
`protected String` | `scope` The scope of the bean specified by the name property, if any.
`protected String` | `target` The window target.
`protected String` | `text` The body content of this tag (if any).
`protected boolean` | `transaction` Include transaction token (if any) in the hyperlink?
`protected boolean` | `useLocalEncoding`

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag
`accesskey, doDisabled, doReadonly, indexed, tabindex`

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
`bodyContent`

Fields inherited from class javax.servlet.jsp.tagext.TagSupport
`id, pageContext`

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
`EVAL_BODY_AGAIN`

Fields inherited from interface javax.servlet.jsp.tagext.Tag
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

Constructor Summary
`LinkTag()`

Method Summary
`void` | `addParameter(String paramName, Object paramValue)` Adds a parameter to this link.
`protected String` | `calculateURL()` Return the complete URL to which this hyperlink will direct the user.
`int` | `doAfterBody()` Save the associated label from the body content.
`int` | `doEndTag()` Render the end of the hyperlink.
`int` | `doStartTag()` Render the beginning of the hyperlink.
`String` | `getAction()`
`String` | `getAnchor()`
`String` | `getForward()`
`String` | `getHref()`
`String` | `getIndexId()`
`String` | `getLinkName()`
`String` | `getModule()`
`String` | `getName()`
`String` | `getPage()`
`String` | `getParamId()`
`String` | `getParamName()`
`String` | `getParamProperty()`
`String` | `getParamScope()`
`String` | `getProperty()`
`String` | `getScope()`
`String` | `getTarget()`
`boolean` | `getTransaction()`
`boolean` | `isUseLocalEncoding()`
`void` | `release()` Release any acquired resources.
`void` | `setAction(String action)`
`void` | `setAnchor(String anchor)`
`void` | `setForward(String forward)`
`void` | `setHref(String href)`
`void` | `setIndexId(String indexId)`
`void` | `setLinkName(String linkName)`
`void` | `setModule(String module)`
`void` | `setName(String name)`
`void` | `setPage(String page)`
`void` | `setParamId(String paramId)`
`void` | `setParamName(String paramName)`
`void` | `setParamProperty(String paramProperty)`
`void` | `setParamScope(String paramScope)`
`void` | `setProperty(String property)`
`void` | `setScope(String scope)`
`void` | `setTarget(String target)`
`void` | `setTransaction(boolean transaction)`
`void` | `setUseLocalEncoding(boolean b)`

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag
`doErrorsExist, getAccesskey, getAlt, getAltKey, getBundle, getDir, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexed, getIndexValue, getLang, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareAttribute, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareInternationalization, prepareKeyEvents, prepareMouseEvents, prepareName, prepareOtherAttributes, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDir, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLang, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey`

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
`doInitBody, getBodyContent, getPreviousOut, setBodyContent`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
`findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface javax.servlet.jsp.tagext.Tag
`getParent, setPageContext, setParent`

Field Detail

### messages

    protected static MessageResources messages

  The message resources for this package.

### text

    protected String text

  The body content of this tag (if any).

### anchor

    protected String anchor

  The anchor to be added to the end of the generated hyperlink.

### forward

    protected String forward

  The logical forward name from which to retrieve the hyperlink URI.

  Usage note: If a forward config is used in a hyperlink, and a module is specified, the path must lead to another action and not directly to a page. This is in keeping with rule that in a modular application all links must be to an action rather than a page.

### href

    protected String href

  The hyperlink URI.

### linkName

    protected String linkName

  The link name for named links.

### name

    protected String name

  The JSP bean name for query parameters.

### page

    protected String page

  The module-relative page URL (beginning with a slash) to which this hyperlink will be rendered.

### action

    protected String action

  The module-relative action (beginning with a slash) which will be called by this link

### module

    protected String module

  The module prefix (beginning with a slash) which will be used to find the action for this link.

### paramId

    protected String paramId

  The single-parameter request parameter name to generate.

### paramName

    protected String paramName

  The single-parameter JSP bean name.

### paramProperty

    protected String paramProperty

  The single-parameter JSP bean property.

### paramScope

    protected String paramScope

  The single-parameter JSP bean scope.

### property

    protected String property

  The JSP bean property name for query parameters.

### scope

    protected String scope

  The scope of the bean specified by the name property, if any.

### target

    protected String target

  The window target.

### transaction

    protected boolean transaction

  Include transaction token (if any) in the hyperlink?

### parameters

    protected Map parameters

  Additional parameters included programatically.

### indexId

    protected String indexId

  Name of parameter to generate to hold index number

### useLocalEncoding

    protected boolean useLocalEncoding

Constructor Detail

### LinkTag

    public LinkTag()

Method Detail

### getAnchor

    public String getAnchor()

### setAnchor

    public void setAnchor(String anchor)

### getForward

    public String getForward()

### setForward

    public void setForward(String forward)

### getHref

    public String getHref()

### setHref

    public void setHref(String href)

### getLinkName

    public String getLinkName()

### setLinkName

    public void setLinkName(String linkName)

### getName

    public String getName()

### setName

    public void setName(String name)

### getPage

    public String getPage()

### setPage

    public void setPage(String page)

### getAction

    public String getAction()

### setAction

    public void setAction(String action)

### getModule

    public String getModule()

### setModule

    public void setModule(String module)

### getParamId

    public String getParamId()

### setParamId

    public void setParamId(String paramId)

### getParamName

    public String getParamName()

### setParamName

    public void setParamName(String paramName)

### getParamProperty

    public String getParamProperty()

### setParamProperty

    public void setParamProperty(String paramProperty)

### getParamScope

    public String getParamScope()

### setParamScope

    public void setParamScope(String paramScope)

### getProperty

    public String getProperty()

### setProperty

    public void setProperty(String property)

### getScope

    public String getScope()

### setScope

    public void setScope(String scope)

### getTarget

    public String getTarget()

### setTarget

    public void setTarget(String target)

### getTransaction

    public boolean getTransaction()

### setTransaction

    public void setTransaction(boolean transaction)

### getIndexId

    public String getIndexId()

### setIndexId

    public void setIndexId(String indexId)

### isUseLocalEncoding

    public boolean isUseLocalEncoding()

### setUseLocalEncoding

    public void setUseLocalEncoding(boolean b)

### doStartTag

    public int doStartTag()
                   throws JspException

  Render the beginning of the hyperlink.

  Support for indexed property since Struts 1.1

  Specified by:
    `doStartTag` in interface `Tag`
  Overrides:
    `doStartTag` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### doAfterBody

    public int doAfterBody()
                    throws JspException

  Save the associated label from the body content.

  Specified by:
    `doAfterBody` in interface `IterationTag`
  Overrides:
    `doAfterBody` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### doEndTag

    public int doEndTag()
                 throws JspException

  Render the end of the hyperlink.

  Specified by:
    `doEndTag` in interface `Tag`
  Overrides:
    `doEndTag` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### release

    public void release()

  Release any acquired resources.

  Specified by:
    `release` in interface `Tag`
  Overrides:
    `release` in class `BaseHandlerTag`

### calculateURL

    protected String calculateURL()
                           throws JspException

  Return the complete URL to which this hyperlink will direct the user. Support for indexed property since Struts 1.1

  Throws:
    `JspException` - if an exception is thrown calculating the value

### addParameter

    public void addParameter(String paramName,
                             Object paramValue)

  Adds a parameter to this link.

  Parameters:
    `paramName` - the parameter name
    `paramValue` - the parameter value
  Since:
    Struts 1.3.6

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.