org.apache.beehive.netui.tags.databinding.datagrid
Class Caption

Object
  extended by SimpleTagSupport
      extended by AbstractSimpleTag
          extended by AbstractDataGridHtmlTag
              extended by Caption
All Implemented Interfaces:
JspTag, SimpleTag, INetuiTag

public class Caption
extends AbstractDataGridHtmlTag

The Caption tag is used to render an HTML <caption> inside of a data grid. The caption tag should be placed inside of a <netui-data:dataGrid> tag and will produce the caption for the HTML table that the dataGrid renders.

To set HTML attributes on the rendered caption tag, use the attribute setters defined in this tag

The set of JSP implicit objects available to the body include:


Constructor Summary
Caption()
           
 
Method Summary
 void doTag()
           Render the caption tag.
 String getTagName()
          The name of this tag; this value is used for error reporting.
 void setDir(String dir)
          Sets the value of the text direction attribute for the HTML caption.
 void setLang(String lang)
          Sets the value of the language attribute for the HTML caption.
 void setOnClick(String onClick)
          Sets the onClick JavaScript event for the HTML attribute.
 void setOnDblClick(String onDblClick)
          Sets the onDblClick JavaScript event for the HTML caption.
 void setOnKeyDown(String onKeyDown)
          Sets the onKeyDown JavaScript event for the HTML caption.
 void setOnKeyPress(String onKeyPress)
          Sets the onKeyPress JavaScript event for the HTML caption.
 void setOnKeyUp(String onKeyUp)
          Sets the onKeyUp JavaScript event for the HTML caption.
 void setOnMouseDown(String onMouseDown)
          Sets the onMouseDown JavaScript event for the HTML caption.
 void setOnMouseMove(String onMouseMove)
          Sets the onMouseMove JavaScript event for the HTML caption.
 void setOnMouseOut(String onMouseOut)
          Sets the onMouseOut JavaScript event for the HTML caption.
 void setOnMouseOver(String onMouseOver)
          Sets the onMouseOver JavaScript event for the HTML caption.
 void setOnMouseUp(String onMouseUp)
          Sets the onMouseUp JavaScript event for the HTML caption.
 void setStyle(String style)
          Sets the style of the HTML caption.
 void setStyleClass(String styleClass)
          Sets the style class of the HTML caption.
 void setTagId(String tagId)
          Set the name of the tagId for the HTML caption.
 void setTitle(String title)
          Sets the value of the title attribute for the HTML caption.
 
Methods inherited from class AbstractDataGridHtmlTag
applyIndexedTagId, applyTagId, lookupDataGridTagModel, renderDefaultNameAndId, renderNameAndId
 
Methods inherited from class AbstractSimpleTag
getBufferBody, getHtmlTag, getIdForTagId, getInlineError, getPageContext, getScriptReporter, getUserLocale, hasErrors, registerTagError, registerTagError, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write
 
Methods inherited from class SimpleTagSupport
findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Caption

public Caption()
Method Detail

getTagName

public String getTagName()
The name of this tag; this value is used for error reporting.

Specified by:
getTagName in interface INetuiTag
Specified by:
getTagName in class AbstractSimpleTag
Returns:
the String name of this tag

setOnClick

public void setOnClick(String onClick)
Sets the onClick JavaScript event for the HTML attribute.

Parameters:
onClick - the onClick event

setOnDblClick

public void setOnDblClick(String onDblClick)
Sets the onDblClick JavaScript event for the HTML caption.

Parameters:
onDblClick - the onDblClick event

setOnKeyDown

public void setOnKeyDown(String onKeyDown)
Sets the onKeyDown JavaScript event for the HTML caption.

Parameters:
onKeyDown - the onKeyDown event

setOnKeyUp

public void setOnKeyUp(String onKeyUp)
Sets the onKeyUp JavaScript event for the HTML caption.

Parameters:
onKeyUp - the onKeyUp event.

setOnKeyPress

public void setOnKeyPress(String onKeyPress)
Sets the onKeyPress JavaScript event for the HTML caption.

Parameters:
onKeyPress - the onKeyPress event.

setOnMouseDown

public void setOnMouseDown(String onMouseDown)
Sets the onMouseDown JavaScript event for the HTML caption.

Parameters:
onMouseDown - the onMouseDown event.

setOnMouseUp

public void setOnMouseUp(String onMouseUp)
Sets the onMouseUp JavaScript event for the HTML caption.

Parameters:
onMouseUp - the onMouseUp event.

setOnMouseMove

public void setOnMouseMove(String onMouseMove)
Sets the onMouseMove JavaScript event for the HTML caption.

Parameters:
onMouseMove - the onMouseMove event.

setOnMouseOut

public void setOnMouseOut(String onMouseOut)
Sets the onMouseOut JavaScript event for the HTML caption.

Parameters:
onMouseOut - the onMouseOut event.

setOnMouseOver

public void setOnMouseOver(String onMouseOver)
Sets the onMouseOver JavaScript event for the HTML caption.

Parameters:
onMouseOver - the onMouseOver event.

setStyle

public void setStyle(String style)
Sets the style of the HTML caption.

Parameters:
style - the caption attribute.

setStyleClass

public void setStyleClass(String styleClass)
Sets the style class of the HTML caption.

Parameters:
styleClass - the style class

setTitle

public void setTitle(String title)
Sets the value of the title attribute for the HTML caption.

Parameters:
title - the title attribute

setLang

public void setLang(String lang)
Sets the value of the language attribute for the HTML caption.

Parameters:
lang - the language attribute

setDir

public void setDir(String dir)
Sets the value of the text direction attribute for the HTML caption.

Parameters:
dir - the dir attribute

setTagId

public void setTagId(String tagId)
              throws JspException
Set the name of the tagId for the HTML caption. The page author is responsible for ensuring that the tagId value is unique within the current page scope.

Parameters:
tagId - the the name of the tagId for the caption.
Throws:
JspException

doTag

public void doTag()
           throws IOException,
                  JspException

Render the caption tag. This tag renders during the data grid's DataGridTagModel.RENDER_STATE_CAPTION state and produces an HTML <caption> which contains the result of having evaluated the body of this tag.

Specified by:
doTag in interface SimpleTag
Overrides:
doTag in class SimpleTagSupport
Throws:
IOException
JspException - when the DataGridTagModel can not be found in the JspContext