org.opensubsystems.patterns.dialoglayout.www
Class HelpLabelTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.opensubsystems.core.www.PageElementCacheTag
              extended by org.opensubsystems.core.www.BlockElementTag
                  extended by org.opensubsystems.patterns.dialoglayout.www.HelpLabelTag
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 HelpLabelTag
extends org.opensubsystems.core.www.BlockElementTag

Custom tag to generate all HTML code necessary to display control label which serves as a trigger to display context help for some control associated with the label. The association between the control and its label is made using id, since both the label, the control and the context help should be constructed using the same id or placed within a dialog row or a column of dialog row with the same id.

Version:
$Id: HelpLabelTag.java,v 1.16 2007/01/07 06:14:28 bastafidli Exp $
Author:
Miro Halas
See Also:
Serialized Form
Code reviewer:
Miro Halas
Code reviewed:
1.11 2006/02/18 05:29:32 bastafidli

Field Summary
protected  java.lang.String m_strAccessKey
          Accesskey that will be used for mnemonics
protected  java.lang.String m_strAllowFocus
          AllowFocus flag that will be used for allowing to get focus for Label text of particular control.
protected  java.lang.String m_strPostfix
          More text added behind the label
static java.lang.String WEBUI_HELPLABEL_FOCUS
          Configuration setting controlling if user interface allow user to focus (for example by tabbing through controls on the screen) on labels that can be used to display context help.
static boolean WEBUI_HELPLABEL_FOCUS_DEFAULT
          Default value of flag controlling if user interface allow user to focus (for example by tabbing through controls on the screen) on labels that can be used to display context help.
 
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
HelpLabelTag()
          Constructor for custom tag.
 
Method Summary
 int doEndTag()
          
 int doStartTag()
          
 java.lang.String getAccesskey()
           
 java.lang.String getAllowFocus()
           
 java.lang.String getPostfix()
           
 boolean isFocusAllowed()
           
 void setAccesskey(java.lang.String strAccessKey)
           
 void setAllowfocus(boolean bAllowFocus)
           
 void setAllowfocus(java.lang.String strAllowFocus)
           
 void setPostfix(java.lang.String strPostfix)
           
 
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

WEBUI_HELPLABEL_FOCUS

public static final java.lang.String WEBUI_HELPLABEL_FOCUS
Configuration setting controlling if user interface allow user to focus (for example by tabbing through controls on the screen) on labels that can be used to display context help.

See Also:
Constant Field Values

WEBUI_HELPLABEL_FOCUS_DEFAULT

public static final boolean WEBUI_HELPLABEL_FOCUS_DEFAULT
Default value of flag controlling if user interface allow user to focus (for example by tabbing through controls on the screen) on labels that can be used to display context help.

See Also:
Constant Field Values

m_strPostfix

protected java.lang.String m_strPostfix
More text added behind the label


m_strAccessKey

protected java.lang.String m_strAccessKey
Accesskey that will be used for mnemonics


m_strAllowFocus

protected java.lang.String m_strAllowFocus
AllowFocus flag that will be used for allowing to get focus for Label text of particular control. When there is switched between controls using tab key, the 'Label text' will be skipped. Default is false ('Label text' will be skipped). This attribute should say true or 1. Not required.

Constructor Detail

HelpLabelTag

public HelpLabelTag()
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

getPostfix

public java.lang.String getPostfix()
Returns:
- Extra text after label tag

setPostfix

public void setPostfix(java.lang.String strPostfix)
Parameters:
strPostfix - - Extra text added after label tag

getAccesskey

public java.lang.String getAccesskey()
Returns:
String - access key used for mnemonics

setAccesskey

public void setAccesskey(java.lang.String strAccessKey)
Parameters:
strAccessKey - - access key that will be used in label for mnemonics

getAllowFocus

public java.lang.String getAllowFocus()
Returns:
String - flag that will be used for allowing to get focus for Label text

setAllowfocus

public void setAllowfocus(java.lang.String strAllowFocus)
Parameters:
strAllowFocus - - If AllowFocus will be true there will be possible to focus to particular Label text. This attribute should say true or 1.

setAllowfocus

public void setAllowfocus(boolean bAllowFocus)
Parameters:
bAllowFocus - - If AllowFocus will be true there will be possible to focus to particular Label text.

isFocusAllowed

public boolean isFocusAllowed()
Returns:
boolean - true if focus for Help label text is allowed


Copyright © 2003 - 2006 OpenSubsystems s.r.o.