| java.lang.Object net.sf.regain.util.sharedtag.SharedTag
All known Subclasses: net.sf.regain.search.sharedlib.ListTag, net.sf.regain.ui.desktop.status.sharedlib.autoupdate.MetaTag, net.sf.regain.search.sharedlib.input.QueryTag, net.sf.regain.search.sharedlib.input.SubmitTag, net.sf.regain.search.sharedlib.stats.QueryTag, net.sf.regain.ui.desktop.config.sharedlib.FormTag, net.sf.regain.search.sharedlib.ParamTag, net.sf.regain.search.sharedlib.error.AbstractErrorTag, net.sf.regain.ui.desktop.status.sharedlib.autoupdate.FormTag, net.sf.regain.ui.desktop.status.sharedlib.IndexupdateTag, net.sf.regain.search.sharedlib.stats.FromTag, net.sf.regain.search.sharedlib.hit.AbstractHitTag, net.sf.regain.search.sharedlib.input.FieldlistTag, net.sf.regain.search.sharedlib.MsgTag, net.sf.regain.search.sharedlib.CheckTag, net.sf.regain.search.sharedlib.stats.SearchtimeTag, net.sf.regain.search.sharedlib.input.HiddenparamTag, net.sf.regain.ui.desktop.config.sharedlib.EditlistTag, net.sf.regain.search.sharedlib.stats.ToTag, net.sf.regain.ui.desktop.status.sharedlib.CurrentindexTag, net.sf.regain.search.sharedlib.hit.ScoreTag, net.sf.regain.ui.desktop.config.sharedlib.TextTag, net.sf.regain.ui.desktop.status.sharedlib.IndexupdatecontrolTag, net.sf.regain.ui.desktop.status.sharedlib.LogTag, net.sf.regain.search.sharedlib.input.MaxresultsTag, net.sf.regain.search.sharedlib.NavigationTag, net.sf.regain.search.sharedlib.stats.TotalTag, net.sf.regain.ui.desktop.status.sharedlib.ProfilerTag, net.sf.regain.ui.desktop.config.sharedlib.IntervalTag,
SharedTag | abstract public class SharedTag (Code) | | A tag that may be used within the taglib technology or the simpleweb
technology.
author: Til Schneider, www.murfman.de |
Field Summary | |
final public static int | EVAL_TAG_BODY Specifies that the tag body should be evaluated. | final public static int | SKIP_TAG_BODY Specifies that the tag body should be skipped. |
Constructor Summary | |
public | SharedTag() Creates a new instance of SharedTag. |
Method Summary | |
protected Localizer | getLocalizer() Gets the localizer. | public String | getParameter(String name) Gets a parameter.
Parameters: name - The parameter's name. | public String | getParameter(String name, String defaultValue) Gets a parameter.
Parameters: name - The parameter's name. Parameters: defaultValue - The value to return if the parameter was not set. | public String | getParameter(String name, boolean mandatory) Gets a parameter.
Parameters: name - The parameter's name. Parameters: mandatory - Specifies whether the parameter is mandatory. | public boolean | getParameterAsBoolean(String name, boolean defaultValue) Gets a parameter and converts it to a boolean.
Parameters: name - The name of the parameter. Parameters: defaultValue - The value to return if the parameter is not set. throws: RegainException - When the parameter value is not a number. | public int | getParameterAsInt(String name, int defaultValue) Gets a parameter and converts it to an int.
Parameters: name - The name of the parameter. Parameters: defaultValue - The value to return if the parameter is not set. throws: RegainException - When the parameter value is not a number. | public String | getTagName() Gets the name of this Tag.
The name of the tag is extracted from the class name. | public int | printAfterBody(PageRequest request, PageResponse response) Called after the body content was evaluated.
Parameters: request - The page request. Parameters: response - The page response. | public void | printEndTag(PageRequest request, PageResponse response) Called when the parser reaches the end tag. | public int | printStartTag(PageRequest request, PageResponse response) Called when the parser reaches the start tag.
Parameters: request - The page request. Parameters: response - The page response. | final public void | setContext(PageRequest request) Sets the tag execution context. | public void | setParameter(String name, String value) Sets a parameter. | public String | toString() Gets the String representation of this tag. | final public void | unsetContext() Unsets the tag execution context. |
EVAL_TAG_BODY | final public static int EVAL_TAG_BODY(Code) | | Specifies that the tag body should be evaluated.
|
SKIP_TAG_BODY | final public static int SKIP_TAG_BODY(Code) | | Specifies that the tag body should be skipped.
|
SharedTag | public SharedTag()(Code) | | Creates a new instance of SharedTag.
|
getParameter | public String getParameter(String name)(Code) | | Gets a parameter.
Parameters: name - The parameter's name. The value of the parameter or null if the parameterwas not set. |
getParameter | public String getParameter(String name, String defaultValue)(Code) | | Gets a parameter.
Parameters: name - The parameter's name. Parameters: defaultValue - The value to return if the parameter was not set. The value of the parameter or the default value if the parameterwas not set. |
getParameter | public String getParameter(String name, boolean mandatory) throws RegainException(Code) | | Gets a parameter.
Parameters: name - The parameter's name. Parameters: mandatory - Specifies whether the parameter is mandatory. The parameter value or null if no such parameter wasgiven and mandatory is false . throws: RegainException - If mandatory is true and the parameterwas not specified. |
getParameterAsBoolean | public boolean getParameterAsBoolean(String name, boolean defaultValue) throws RegainException(Code) | | Gets a parameter and converts it to a boolean.
Parameters: name - The name of the parameter. Parameters: defaultValue - The value to return if the parameter is not set. throws: RegainException - When the parameter value is not a number. The int value of the parameter. |
getParameterAsInt | public int getParameterAsInt(String name, int defaultValue) throws RegainException(Code) | | Gets a parameter and converts it to an int.
Parameters: name - The name of the parameter. Parameters: defaultValue - The value to return if the parameter is not set. throws: RegainException - When the parameter value is not a number. The int value of the parameter. |
getTagName | public String getTagName()(Code) | | Gets the name of this Tag.
The name of the tag is extracted from the class name. In order to work,
subclasses must be named using the pattern [TagName]Tag
(e.g. NavigationTag for the tag navigation ).
The name of this tag. |
setContext | final public void setContext(PageRequest request) throws RegainException(Code) | | Sets the tag execution context.
Is called by the shared tag engine before the start tag is processed.
Parameters: request - The request to get the context from throws: RegainException - If setting the context failed. |
setParameter | public void setParameter(String name, String value)(Code) | | Sets a parameter.
Parameters: name - The parameter's name. Parameters: value - The parameter's value. |
toString | public String toString()(Code) | | Gets the String representation of this tag.
The String representation. |
unsetContext | final public void unsetContext()(Code) | | Unsets the tag execution context.
Is called by the shared tag engine after the end tag was processed.
|
|
|