org.opensubsystems.patterns.dialoglayout.www
Class ContextHelpTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.opensubsystems.core.www.PageElementCacheTag
              org.opensubsystems.core.www.BlockElementTag
                  org.opensubsystems.patterns.dialoglayout.www.ContextHelpTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ContextHelpTag
extends org.opensubsystems.core.www.BlockElementTag

Custom tag to generate all HTML required to display context help for a control. You can use the HelpLabelTag to display this context help when user clicks on the label. It is expected that this tag will be placed in the dialog row or column of a dialog row immediately following the control it belongs to. The context help will be by default displayed at the row boundary (in case the row is split into left and right half) and not at the field boundary.

Version:

$Id: ContextHelpTag.java,v 1.13 2007/01/07 06:14:28 bastafidli Exp $

Author:

Miro Halas

See Also:

Serialized Form

Code reviewer:

Miroslav Halas

Code reviewed:

1.9 2006/04/19 14:20:39 bastafidli

Field Summary

static java.lang.String	CONTEXT_HELP_CACHE Identifier used to store context help until it is ready to be retrieved.
protected java.lang.String	m_strDirect Flag that specifies if the context help is written directly to the page at the location where the tag is placed in the page or if the custom tag can move it to a different place in the structure of the page.
protected java.lang.String	m_strTitle Context help title.

Fields inherited from class org.opensubsystems.core.www.BlockElementTag

CURRENT_ELEMENT_ID, DIV_BLOCK_ELEMENT, m_strCssclass, m_strIdSuffix, m_strRelatedIds, m_strStyle, m_strType, SPAN_BLOCK_ELEMENT

Fields inherited from class org.opensubsystems.core.www.PageElementCacheTag

CACHE_INDICATOR, CSS_ELEMENT, JS_ELEMENT, m_strCacheas, m_strId, PAGE_ELEMENTS_CACHE, SCRIPT_ELEMENT

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

ContextHelpTag()
Constructor for custom tag.

Method Summary

int	doEndTag()
int	doStartTag()
java.lang.String	getDirect()
java.lang.String	getTitle()
boolean	isDirectWritten()
void	setDirect(boolean bDirect)
void	setDirect(java.lang.String strDirect)
void	setTitle(java.lang.String strTitle)

Methods inherited from class org.opensubsystems.core.www.BlockElementTag

adjustId, getCssclass, getCurrentId, getRelatedids, getStyle, getType, isRelatedIdsTag, popCurrentId, pushCurrentId, restoreId, setCssclass, setRelatedids, setRelatedids, setStoredId, setStyle, setType

Methods inherited from class org.opensubsystems.core.www.PageElementCacheTag

cache, getCacheas, getCachedContent, getCachedContent, getCachedContent, getCachedContentElements, getId, setCacheas, setId

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, 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

CONTEXT_HELP_CACHE

public static final java.lang.String CONTEXT_HELP_CACHE

Identifier used to store context help until it is ready to be retrieved.

See Also:

Constant Field Values

m_strTitle

protected java.lang.String m_strTitle

Context help title.

m_strDirect

protected java.lang.String m_strDirect

Flag that specifies if the context help is written directly to the page at the location where the tag is placed in the page or if the custom tag can move it to a different place in the structure of the page. Default value is false (content can be moved to a different place in the structure of the page).

Constructor Detail

ContextHelpTag

public ContextHelpTag()

Constructor for custom tag.

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class org.opensubsystems.core.www.BlockElementTag

Throws:

javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class org.opensubsystems.core.www.BlockElementTag

Throws:

javax.servlet.jsp.JspException

getTitle

public java.lang.String getTitle()

Returns:

String - Context help title.

setTitle

public void setTitle(java.lang.String strTitle)

Parameters:

strTitle - - Context help title.

getDirect

public java.lang.String getDirect()

Returns:

String - flag which will tells us if the context will be written directly - then this attribute should say true or 1.

setDirect

public void setDirect(java.lang.String strDirect)

Parameters:

strDirect - - If context should be written then this attribute should say true or 1.

setDirect

public void setDirect(boolean bDirect)

Parameters:

bDirect - - If context should be written then this attribute should say true or 1.

isDirectWritten

public boolean isDirectWritten()

Returns:

boolean - true if this control should be disabled