org.opensubsystems.patterns.tabbeddialog.www
Class TabbedDialogTabTag

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.tabbeddialog.www.TabbedDialogTabTag

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 TabbedDialogTabTag
extends org.opensubsystems.core.www.BlockElementTag

Custom tag to generate all HTML code necessary to display one tab of the tabbed dialog. The tab of the dialog contains will be created from the content of the body of this tag. This tag has to be placed inside of dialog tag.

Version:

$Id: TabbedDialogTabTag.java,v 1.29 2007/01/07 06:14:27 bastafidli Exp $

Author:

Miro Halas

See Also:

Serialized Form

Code reviewer:

Miro Halas

Code reviewed:

1.25 2006/05/31 01:22:21 jlegeny

Field Summary

protected java.lang.String	m_strAccessKey Access key that will be used for mnemonics to allow user access the content of the tab using keyboard.
protected java.lang.String	m_strActive If this tab is the active tab then this attribute should say true or 1.
protected java.lang.String	m_strHeader User visible text of the header for this tab.
protected java.lang.String	m_strImg URL of an image to display in tab header.
protected java.lang.String	m_strOnFocus JavaScript function that will be called when the tab becomes active.
static java.lang.String	TABBED_DIALOG_FORM_TAG Name of the form tag

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

TabbedDialogTabTag()
Constructor for custom tag.

Method Summary

int	doEndTag()
int	doStartTag()
java.lang.String	getAccesskey()
java.lang.String	getActive()
java.lang.String	getHeader()
java.lang.String	getImg()
java.lang.String	getOnfocus()
boolean	isActiveTab()
void	setAccesskey(java.lang.String strAccessKey)
void	setActive(boolean bActive)
void	setActive(java.lang.String strActive)
void	setHeader(java.lang.String strHeader)
void	setImg(java.lang.String strImg)
void	setOnfocus(java.lang.String strOnFocus)

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

TABBED_DIALOG_FORM_TAG

public static final java.lang.String TABBED_DIALOG_FORM_TAG

Name of the form tag

See Also:

Constant Field Values

m_strHeader

protected java.lang.String m_strHeader

User visible text of the header for this tab.

m_strActive

protected java.lang.String m_strActive

If this tab is the active tab then this attribute should say true or 1. Only one tab of the tab dialog can be made active.

m_strImg

protected java.lang.String m_strImg

URL of an image to display in tab header.

m_strAccessKey

protected java.lang.String m_strAccessKey

Access key that will be used for mnemonics to allow user access the content of the tab using keyboard.

m_strOnFocus

protected java.lang.String m_strOnFocus

JavaScript function that will be called when the tab becomes active.

Constructor Detail

TabbedDialogTabTag

public TabbedDialogTabTag()

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

getHeader

public java.lang.String getHeader()

Returns:

String - Text of the header for this tab

getActive

public java.lang.String getActive()

Returns:

String - If this tab is the active tab then this attribute should say true or 1.

getImg

public java.lang.String getImg()

Returns:

String - image to display in header if any

setHeader

public void setHeader(java.lang.String strHeader)

Parameters:

strHeader - - Text of the header for this tab

setActive

public void setActive(java.lang.String strActive)

Parameters:

strActive - - If this tab is the active tab then this attribute should say true or 1.

setActive

public void setActive(boolean bActive)

Parameters:

bActive - - If this tab is the active tab then this attribute should say true or 1.

setImg

public void setImg(java.lang.String strImg)

Parameters:

strImg - - image to display in the header if any

isActiveTab

public boolean isActiveTab()

Returns:

boolean - true if this tab is the active tab

getAccesskey

public java.lang.String getAccesskey()

Returns:

- Accesskey used for mnemonics

setAccesskey

public void setAccesskey(java.lang.String strAccessKey)

Parameters:

strAccessKey - - AccessKey that will be used in label for mnemonics

getOnfocus

public java.lang.String getOnfocus()

Returns:

- Javascript called onfocus

setOnfocus

public void setOnfocus(java.lang.String strOnFocus)

Parameters:

strOnFocus - - Javascript called onfocus