You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/05/16 00:11:32 UTC
svn commit: r170271 [2/3] - in
/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding:
datagrid/ invoke/
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Footer.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Footer.java?rev=170271&r1=170270&r2=170271&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Footer.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Footer.java Sun May 15 15:11:30 2005
@@ -1,4 +1,4 @@
-/*
+ /*
* Copyright 2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,7 +39,61 @@
import org.apache.beehive.netui.util.Bundle;
/**
- * @jsptagref.tagdescription Renders a footer below the data grid.
+ * <p>
+ * The Footer tag is used to render a table row after the data grid has rendered the
+ * header and rows regions demarcated by the {@link Header} and {@link Rows} tags respectively.
+ * The footer tag can also optionally render a <tfoot> HTML tag if the data grid is rendering
+ * HTML table row groups. To enable this functionality, set the {@link DataGrid#setRenderRowGroups(boolean)}
+ * attribute. The location of the footer tag inside of a data grid does not affect when its content renders.
+ * </p>
+ * <p>
+ * The attribute setters for the footer tag are used to add HTML attributes to the ≶tfoot> HTML
+ * tag. When row group rendering is disabled, attributes set here do not render.
+ * </p>
+ * <p>
+ * Because this tag renders inside of an HTML table, it by default renders an HTML
+ * <tr> tag to represent a table row. Table row tag rendering can be disabled using the {@link #setRenderRow(boolean)}
+ * attribute. When this is disabled, the page author is responsible for maintaining the integrity of the
+ * HTML table by writing <tr> tags manually or by using the {@link Row} tag. When this tag is rendering
+ * it does not produce table cells; the contents of the table row in the footer is entirely left to the
+ * page author. With row rendering disabled, it is also possible to add multiple table rows to the
+ * end of a data grid.
+ * </p>
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * </ul>
+ * </p>
+ * @jsptagref.tagdescription
+ * <p>
+ * The Footer tag is used to render a table row after the data grid has rendered the
+ * header and rows regions demarcated by the {@link Header} and {@link Rows} tags respectively.
+ * The footer tag can also optionally render a <tfoot> HTML tag if the data grid is rendering
+ * HTML table row groups. To enable this functionality, set the {@link DataGrid#setRenderRowGroups(boolean)}
+ * attribute. The location of the footer tag inside of a data grid does not affect when its content renders.
+ * </p>
+ * <p>
+ * The attribute setters for the footer tag are used to add HTML attributes to the ≶tfoot> HTML
+ * tag. When row group rendering is disabled, attributes set here do not render.
+ * </p>
+ * <p>
+ * Because this tag renders inside of an HTML table, it by default renders an HTML
+ * <tr> tag to represent a table row. Table row tag rendering can be disabled using the {@link #setRenderRow(boolean)}
+ * attribute. When this is disabled, the page author is responsible for maintaining the integrity of the
+ * HTML table by writing <tr> tags manually or by using the {@link Row} tag. When this tag is rendering
+ * it does not produce table cells; the contents of the table row in the footer is entirely left to the
+ * page author. With row rendering disabled, it is also possible to add multiple table rows to the
+ * end of a data grid.
+ * </p>
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * </ul>
+ * </p>
* @netui:tag name="footer" body-content="scriptless" description="Renders a footer into a NetUI data grid"
*/
public class Footer
@@ -54,143 +108,132 @@
}
/**
- * Sets the onClick javascript event.
+ * Sets the onClick JavaScript event for the HTML tfoot.
*
- * @param onClick - the onClick event.
- * @jsptagref.attributedescription The onClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onClick the onClick event
+ * @jsptagref.attributedescription The onClick JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript event for the HTML tfoot."
*/
public void setOnClick(String onClick) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONCLICK, onClick);
}
/**
- * Sets the onDblClick javascript event.
+ * Sets the onDblClick JavaScript event for the HTML tfoot.
*
- * @param onDblClick - the onDblClick event.
- * @jsptagref.attributedescription The onDblClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onDblClick the onDblClick event.
+ * @jsptagref.attributedescription The onDblClick JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onDblClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript event for the HTML tfoot."
*/
public void setOnDblClick(String onDblClick) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONDBLCLICK, onDblClick);
}
/**
- * Sets the onKeyDown javascript event.
+ * Sets the onKeyDown JavaScript event for the HTML tfoot.
*
- * @param onKeyDown - the onKeyDown event.
- * @jsptagref.attributedescription The onKeyDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyDown the onKeyDown event.
+ * @jsptagref.attributedescription The onKeyDown JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onKeyDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript event for the HTML tfoot."
*/
public void setOnKeyDown(String onKeyDown) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYDOWN, onKeyDown);
}
/**
- * Sets the onKeyUp javascript event.
+ * Sets the onKeyUp JavaScript event for the HTML tfoot.
*
- * @param onKeyUp - the onKeyUp event.
- * @jsptagref.attributedescription The onKeyUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyUp the onKeyUp event.
+ * @jsptagref.attributedescription The onKeyUp JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onKeyUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript event for the HTML tfoot."
*/
public void setOnKeyUp(String onKeyUp) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYUP, onKeyUp);
}
/**
- * Sets the onKeyPress javascript event.
+ * Sets the onKeyPress JavaScript event.
*
- * @param onKeyPress - the onKeyPress event.
- * @jsptagref.attributedescription The onKeyPress JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyPress the onKeyPress event.
+ * @jsptagref.attributedescription The onKeyPress JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onKeyPress</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript event for the HTML tfoot."
*/
public void setOnKeyPress(String onKeyPress) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYPRESS, onKeyPress);
}
/**
- * Sets the onMouseDown javascript event.
+ * Sets the onMouseDown JavaScript event for the HTML tfoot.
*
- * @param onMouseDown - the onMouseDown event.
- * @jsptagref.attributedescription The onMouseDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseDown the onMouseDown event.
+ * @jsptagref.attributedescription The onMouseDown JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onMouseDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript event for the HTML tfoot."
*/
public void setOnMouseDown(String onMouseDown) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEDOWN, onMouseDown);
}
/**
- * Sets the onMouseUp javascript event.
+ * Sets the onMouseUp JavaScript event for the HTML tfoot.
*
- * @param onMouseUp - the onMouseUp event.
- * @jsptagref.attributedescription The onMouseUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseUp the onMouseUp event.
+ * @jsptagref.attributedescription The onMouseUp JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onMouseUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript event for the HTML tfoot."
*/
public void setOnMouseUp(String onMouseUp) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEUP, onMouseUp);
}
/**
- * Sets the onMouseMove javascript event.
+ * Sets the onMouseMove JavaScript event for the HTML tfoot.
*
- * @param onMouseMove - the onMouseMove event.
- * @jsptagref.attributedescription The onMouseMove JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseMove the onMouseMove event.
+ * @jsptagref.attributedescription The onMouseMove JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onMouseMove</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript event for the HTML tfoot."
*/
public void setOnMouseMove(String onMouseMove) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEMOVE, onMouseMove);
}
/**
- * Sets the onMouseOut javascript event.
+ * Sets the onMouseOut JavaScript event for the HTML tfoot.
*
- * @param onMouseOut - the onMouseOut event.
- * @jsptagref.attributedescription The onMouseOut JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOut the onMouseOut event.
+ * @jsptagref.attributedescription The onMouseOut JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOut</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript event for the HTML tfoot."
*/
public void setOnMouseOut(String onMouseOut) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOUT, onMouseOut);
}
/**
- * Sets the onMouseOver javascript event.
+ * Sets the onMouseOver JavaScript event for the HTML tfoot.
*
- * @param onMouseOver - the onMouseOver event.
- * @jsptagref.attributedescription The onMouseOver JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOver the onMouseOver event.
+ * @jsptagref.attributedescription The onMouseOver JavaScript event for the HTML tfoot.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOver</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript event for the HTML tfoot."
*/
public void setOnMouseOver(String onMouseOver) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOVER, onMouseOver);
}
/**
- * Sets the style of the rendered html tag.
+ * Sets the style of the HTML tfoot tag.
*
- * @param style - the html style.
- * @jsptagref.attributedescription The style.
- * @jsptagref.databindable false
+ * @param style the style
+ * @jsptagref.attributedescription The style for the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_style</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The style."
+ * @netui:attribute required="false" rtexprvalue="true" description="The style for the HTML tfoot tag."
*/
public void setStyle(String style) {
if("".equals(style)) return;
@@ -201,11 +244,10 @@
/**
* Sets the style class of the rendered html tag.
*
- * @param styleClass - the html style class.
- * @jsptagref.attributedescription The style class.
- * @jsptagref.databindable false
+ * @param styleClass the style class
+ * @jsptagref.attributedescription The style class of the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_style_class</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The style class."
+ * @netui:attribute required="false" rtexprvalue="true" description="The style class of the HTML tfoot tag."
*/
public void setStyleClass(String styleClass) {
if("".equals(styleClass)) return;
@@ -214,26 +256,24 @@
}
/**
- * Sets the value of the title attribute.
+ * Sets the value of the title attribute of the HTML tfoot tag.
*
* @param title
- * @jsptagref.attributedescription The title.
- * @jsptagref.databindable false
+ * @jsptagref.attributedescription The title of the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_title</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The title. "
+ * @netui:attribute required="false" rtexprvalue="true" description="The title of the HTML tfoot tag."
*/
public void setTitle(String title) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.TITLE, title);
}
/**
- * Sets the value of the horizontal align attribute.
+ * Sets the value of the horizontal align attribute of the HTML tfoot tag.
*
- * @param align
- * @jsptagref.attributedescription The horizontal alignment.
- * @jsptagref.databindable true
+ * @param align the alignment
+ * @jsptagref.attributedescription The horizontal alignment of the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_align</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment"
+ * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment of the HTML tfoot tag"
*/
public void setAlign(String align) {
/* todo: should this enforce left|center|right|justify|char as in the spec? */
@@ -241,26 +281,24 @@
}
/**
- * Sets the value of the horizontal alignment character attribute.
+ * Sets the value of the horizontal alignment character attribute of the HTML tfoot tag.
*
- * @param alignChar
- * @jsptagref.attributedescription The horizontal alignment character.
- * @jsptagref.databindable true
+ * @param alignChar the alignment character
+ * @jsptagref.attributedescription The horizontal alignment character of the HTML tfoot tag
* @jsptagref.attributesyntaxvalue <i>string_alignChar</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment character"
+ * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment character of the HTML tfoot tag"
*/
public void setChar(String alignChar) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.CHAR, alignChar);
}
/**
- * Sets the value of the horizontal alignment character offset attribute.
+ * Sets the value of the horizontal alignment character offset attribute of the HTML tfoot tag
*
- * @param alignCharOff
- * @jsptagref.attributedescription The horizontal alignment character offset
- * @jsptagref.databindable true
+ * @param alignCharOff the character alignment offset
+ * @jsptagref.attributedescription The horizontal alignment character offset of the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_alignCharOff</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment character offset"
+ * @netui:attribute required="false" rtexprvalue="true" description="The horizontal alignment character offset of the HTML tfoot tag"
*/
public void setCharoff(String alignCharOff) {
_tfootTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.CHAROFF, alignCharOff);
@@ -271,7 +309,6 @@
*
* @param align
* @jsptagref.attributedescription The vertical alignment.
- * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_align</i>
* @netui:attribute required="false" rtexprvalue="true" description="The cell's vertical alignment"
*/
@@ -285,7 +322,6 @@
*
* @param lang
* @jsptagref.attributedescription The language.
- * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_lang</i>
* @netui:attribute required="false" rtexprvalue="true" description="The cell's language"
*/
@@ -298,7 +334,6 @@
*
* @param dir
* @jsptagref.attributedescription The text direction attribute.
- * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_dir</i>
* @netui:attribute required="false" rtexprvalue="true" description="The cell's text direction"
*/
@@ -307,26 +342,47 @@
}
/**
+ * Set a boolean that enables / disables rendering HTML table rows by this tag. If the
+ * value is enabled, an HTML <tr> will be rendered when this tag renders its body. If
+ * the value is disabled, no <tr> tags will be rendered and the page author is responsible
+ * for maintaining the integrity of the HTML table.
+ * @jsptagref.attributedescription
+ * Set a boolean that enables / disables rendering HTML table rows by this tag. If the
+ * value is enabled, an HTML <tr> will be rendered when this tag renders its body. If
+ * the value is disabled, no <tr> tags will be rendered and the page author is responsible
+ * for maintaining the integrity of the HTML table.
+ * @jsptagref.attributesyntaxvalue <i>boolean_renderRow</i>
* @netui:attribute required="false" rtexprvalue="true"
+ * description="Boolean to enable / disable rendering HTML table row tags"
*/
public void setRenderRow(boolean renderRow) {
_renderRow = renderRow;
}
/**
- * Set the name of the tagId for the tfoot tag.
+ * Set the name of the tagId for the HTML tfoot tag.
*
- * @param tagId - the the name of the tagId for the tfoot tag.
- * @jsptagref.attributedescription The tagId.
- * @jsptagref.databindable false
+ * @param tagId the tag id
+ * @jsptagref.attributedescription The tagId of the HTML tfoot tag.
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
- * @netui:attribute required="false" rtexprvalue="true" description="String value. Sets the id (or name) attribute of the rendered HTML tag. "
+ * @netui:attribute required="false" rtexprvalue="true"
+ * description="String value. Sets the id (or name) attribute of the HTML tfoot tag."
*/
public void setTagId(String tagId)
throws JspException {
applyTagId(_tfootTag, tagId);
}
+ /**
+ * Render this tag. This method renders during the data grid's {@link DataGridTagModel#RENDER_STATE_FOOTER}
+ * state in order to add table rows to the end of a data grid's HTML table. If the data grid is rendering
+ * HTML row groups, this tag will output an HTML <tfoot> tag. Then, if this tag is rendering
+ * a table row, it will produce an HTML <tr> tag. Then the content of the body will be rendered. If
+ * table row rendering is disabled, the page author is responsible for rendering the appropriate HTML
+ * table row tags as this tag renders inside of the HTML table opened by the data grid.
+ * @throws IOException
+ * @throws JspException when the {@link DataGridTagModel} can not be found in the {@link JspContext}
+ */
public void doTag()
throws IOException, JspException {
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Header.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Header.java?rev=170271&r1=170270&r2=170271&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Header.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/Header.java Sun May 15 15:11:30 2005
@@ -41,8 +41,65 @@
import org.apache.beehive.netui.util.Bundle;
/**
- * @jsptagref.tagdescription Renders an HTML table head tag (<code><thead></code>).
- * @netui:tag name="header" description="Render an HTML table head tag" body-content="scriptless"
+ * <p>
+ * The Header tag is used to render a table row(s) before the data grid has rendered data rows as demarcated
+ * by the {@link Rows} tag. The header can also optionally render a <thead> HTML tag if the data grid
+ * is rendering HTML table row groups. To enable this functionality, set the
+ * {@link DataGrid#setRenderRowGroups(boolean)} attribute. The location of this tag inside of a
+ * data grid does not affect when its content renders. Table cells containing header describing columns
+ * of data along with sort and filter state / UI is commonly placed inside of a data grid's header.
+ * </p>
+ * <p>
+ * The attribute setters for the footer tag are used to add HTML attributes to the ≶thead> HTML
+ * tag. When row group rendering is disabled, attributes set here do not render.
+ * </p>
+ * <p>
+ * Because this tag renders inside of an HTML table, it by default renders an HTML
+ * <tr> tag to represent a table row. Table row tag rendering can be disabled using the {@link #setRenderRow(boolean)}
+ * attribute. When this is disabled, the page author is responsible for maintaining the integrity of the
+ * HTML table by writing <tr> tags manually or by using the {@link Row} tag. When this tag is rendering
+ * it does not produce table cells; the contents of the table row in the footer is entirely left to the
+ * page author. With row rendering disabled, it is also possible to add multiple table rows to the
+ * end of a data grid.
+ * </p>
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * </ul>
+ * </p>
+ *
+ * @jsptagref.tagdescription
+ * <p>
+ * The Header tag is used to render a table row(s) before the data grid has rendered data rows as demarcated
+ * by the {@link Rows} tag. The header can also optionally render a <thead> HTML tag if the data grid
+ * is rendering HTML table row groups. To enable this functionality, set the
+ * {@link DataGrid#setRenderRowGroups(boolean)} attribute. The location of this tag inside of a
+ * data grid does not affect when its content renders. Table cells containing header describing columns
+ * of data along with sort and filter state / UI is commonly placed inside of a data grid's header.
+ * </p>
+ * <p>
+ * The attribute setters for the footer tag are used to add HTML attributes to the ≶thead> HTML
+ * tag. When row group rendering is disabled, attributes set here do not render.
+ * </p>
+ * <p>
+ * Because this tag renders inside of an HTML table, it by default renders an HTML
+ * <tr> tag to represent a table row. Table row tag rendering can be disabled using the {@link #setRenderRow(boolean)}
+ * attribute. When this is disabled, the page author is responsible for maintaining the integrity of the
+ * HTML table by writing <tr> tags manually or by using the {@link Row} tag. When this tag is rendering
+ * it does not produce table cells; the contents of the table row in the footer is entirely left to the
+ * page author. With row rendering disabled, it is also possible to add multiple table rows to the
+ * end of a data grid.
+ * </p>
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * </ul>
+ * </p>
+ * @netui:tag name="header" description="Renders the header into a NetUI data grid" body-content="scriptless"
*/
public class Header
extends AbstractDataGridHtmlTag
@@ -56,143 +113,132 @@
}
/**
- * Sets the onClick javascript event.
+ * Sets the onClick JavaScript event for the HTML thead tag.
*
- * @param onClick - the onClick event.
- * @jsptagref.attributedescription The onClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onClick the onClick event.
+ * @jsptagref.attributedescription The onClick JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript event for the HTML thead tag."
*/
public void setOnClick(String onClick) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONCLICK, onClick);
}
/**
- * Sets the onDblClick javascript event.
+ * Sets the onDblClick JavaScript event for the HTML thead tag.
*
- * @param onDblClick - the onDblClick event.
- * @jsptagref.attributedescription The onDblClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onDblClick the onDblClick event.
+ * @jsptagref.attributedescription The onDblClick JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onDblClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript event for the HTML thead tag."
*/
public void setOnDblClick(String onDblClick) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONDBLCLICK, onDblClick);
}
/**
- * Sets the onKeyDown javascript event.
+ * Sets the onKeyDown JavaScript event for the HTML thead tag.
*
- * @param onKeyDown - the onKeyDown event.
- * @jsptagref.attributedescription The onKeyDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyDown the onKeyDown event.
+ * @jsptagref.attributedescription The onKeyDown JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript event for the HTML thead tag."
*/
public void setOnKeyDown(String onKeyDown) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYDOWN, onKeyDown);
}
/**
- * Sets the onKeyUp javascript event.
+ * Sets the onKeyUp JavaScript event for the HTML thead tag.
*
- * @param onKeyUp - the onKeyUp event.
- * @jsptagref.attributedescription The onKeyUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyUp the onKeyUp event.
+ * @jsptagref.attributedescription The onKeyUp JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript event for the HTML thead tag."
*/
public void setOnKeyUp(String onKeyUp) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYUP, onKeyUp);
}
/**
- * Sets the onKeyPress javascript event.
+ * Sets the onKeyPress JavaScript event for the HTML thead tag.
*
- * @param onKeyPress - the onKeyPress event.
- * @jsptagref.attributedescription The onKeyPress JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyPress the onKeyPress event.
+ * @jsptagref.attributedescription The onKeyPress JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyPress</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript event for the HTML thead tag."
*/
public void setOnKeyPress(String onKeyPress) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYPRESS, onKeyPress);
}
/**
- * Sets the onMouseDown javascript event.
+ * Sets the onMouseDown JavaScript event for the HTML thead tag.
*
- * @param onMouseDown - the onMouseDown event.
- * @jsptagref.attributedescription The onMouseDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseDown the onMouseDown event.
+ * @jsptagref.attributedescription The onMouseDown JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript event for the HTML thead tag."
*/
public void setOnMouseDown(String onMouseDown) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEDOWN, onMouseDown);
}
/**
- * Sets the onMouseUp javascript event.
+ * Sets the onMouseUp JavaScript event for the HTML thead tag.
*
- * @param onMouseUp - the onMouseUp event.
- * @jsptagref.attributedescription The onMouseUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseUp the onMouseUp event.
+ * @jsptagref.attributedescription The onMouseUp JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript event for the HTML thead tag."
*/
public void setOnMouseUp(String onMouseUp) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEUP, onMouseUp);
}
/**
- * Sets the onMouseMove javascript event.
+ * Sets the onMouseMove JavaScript event for the HTML thead tag.
*
- * @param onMouseMove - the onMouseMove event.
- * @jsptagref.attributedescription The onMouseMove JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseMove the onMouseMove event.
+ * @jsptagref.attributedescription The onMouseMove JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseMove</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript event for the HTML thead tag."
*/
public void setOnMouseMove(String onMouseMove) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEMOVE, onMouseMove);
}
/**
- * Sets the onMouseOut javascript event.
+ * Sets the onMouseOut JavaScript event for the HTML thead tag.
*
- * @param onMouseOut - the onMouseOut event.
- * @jsptagref.attributedescription The onMouseOut JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOut the onMouseOut event.
+ * @jsptagref.attributedescription The onMouseOut JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOut</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript event for the HTML thead tag."
*/
public void setOnMouseOut(String onMouseOut) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOUT, onMouseOut);
}
/**
- * Sets the onMouseOver javascript event.
+ * Sets the onMouseOver JavaScript event for the HTML thead tag.
*
- * @param onMouseOver - the onMouseOver event.
- * @jsptagref.attributedescription The onMouseOver JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOver the onMouseOver event.
+ * @jsptagref.attributedescription The onMouseOver JavaScript event for the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOver</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript event for the HTML thead tag."
*/
public void setOnMouseOver(String onMouseOver) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOVER, onMouseOver);
}
/**
- * Sets the style of the rendered html tag.
+ * Sets the style rendered by the HTML thead tag.
*
- * @param style - the html style.
- * @jsptagref.attributedescription The style.
- * @jsptagref.databindable false
+ * @param style the style
+ * @jsptagref.attributedescription The style rendered by the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_style</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The style."
+ * @netui:attribute required="false" rtexprvalue="true" description="The style rendered by the HTML thead tag"
*/
public void setStyle(String style) {
if("".equals(style)) return;
@@ -201,13 +247,12 @@
}
/**
- * Sets the style class of the rendered html tag.
+ * Sets the style class of the rendered by the HTML thead tag.
*
- * @param styleClass - the html style class.
- * @jsptagref.attributedescription The style class.
- * @jsptagref.databindable false
+ * @param styleClass the style class
+ * @jsptagref.attributedescription The style class rendered by the HTML thead tag
* @jsptagref.attributesyntaxvalue <i>string_style_class</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The style class."
+ * @netui:attribute required="false" rtexprvalue="true" description="The style class rendered by the HTML thead tag"
*/
public void setStyleClass(String styleClass) {
if("".equals(styleClass)) return;
@@ -216,26 +261,25 @@
}
/**
- * Sets the value of the title attribute.
+ * Sets the value of the title attribute rendered by the HTML thead tag.
*
- * @param title
- * @jsptagref.attributedescription The title.
- * @jsptagref.databindable false
+ * @param title the title
+ * @jsptagref.attributedescription The title rendered by the HTML thead tag
* @jsptagref.attributesyntaxvalue <i>string_title</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The title. "
+ * @netui:attribute required="false" rtexprvalue="true" description="The title rendered by the HTML thead tag."
*/
public void setTitle(String title) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.TITLE, title);
}
/**
- * Sets the value of the horizontal align attribute.
+ * Sets the value of the horizontal align attribute rendered by the HTML thead tag.
*
- * @param align
- * @jsptagref.attributedescription The horizontal alignment.
+ * @param align the alignment
+ * @jsptagref.attributedescription The horizontal alignment rendered by the HTML thead tag.
* @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_align</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment"
+ * @netui:attribute required="false" rtexprvalue="true" description="The horizontal alignment attribute rendered by the HTML thead tag."
*/
public void setAlign(String align) {
/* todo: should this enforce left|center|right|justify|char as in the spec */
@@ -243,93 +287,110 @@
}
/**
- * Sets the value of the horizontal alignment character attribute.
+ * Sets the value of the horizontal alignment character attribute rendered by the HTML thead tag.
*
- * @param alignChar
- * @jsptagref.attributedescription The horizontal alignment character.
- * @jsptagref.databindable true
+ * @param alignChar the alignment character
+ * @jsptagref.attributedescription The horizontal alignment character rendered by the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_alignChar</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment character"
+ * @netui:attribute required="false" rtexprvalue="true" description="The horizontal alignment character rendered by the HTML thead tag."
*/
public void setChar(String alignChar) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.CHAR, alignChar);
}
/**
- * Sets the value of the horizontal alignment character offset attribute.
+ * Sets the value of the horizontal alignment character offset attribute rendered by the HTML thead tag.
*
- * @param alignCharOff
- * @jsptagref.attributedescription The horizontal alignment character offset
- * @jsptagref.databindable true
+ * @param alignCharOff the alignment character offset
+ * @jsptagref.attributedescription The horizontal alignment character offset rendered by the HTML thead tag.
* @jsptagref.attributesyntaxvalue <i>string_alignCharOff</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's horizontal alignment character offset"
+ * @netui:attribute required="false" rtexprvalue="true" description="The horizontal alignment character offset rendered by the HTML thead tag."
*/
public void setCharoff(String alignCharOff) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.CHAROFF, alignCharOff);
}
/**
- * Sets the value of the vertical alignment attribute.
+ * Sets the value of the vertical alignment attribute rendered by the HTML thead tag.
*
- * @param align
- * @jsptagref.attributedescription The vertical alignment.
- * @jsptagref.databindable true
+ * @param valign the vertical alignment
+ * @jsptagref.attributedescription The vertical alignment rendered by the HTML thead tag
* @jsptagref.attributesyntaxvalue <i>string_align</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's vertical alignment"
+ * @netui:attribute required="false" rtexprvalue="true" description="The vertical alignment rendered by the HTML thead tag.
*/
- public void setValign(String align) {
+ public void setValign(String valign) {
/* todo: should this enforce top|middle|bottom|baseline as in the spec */
- _theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.VALIGN, align);
+ _theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.VALIGN, valign);
}
/**
- * Sets the value of the language attribute.
+ * Sets the value of the language attribute rendered by the HTML thead tag
*
- * @param lang
- * @jsptagref.attributedescription The language.
+ * @param lang the language
+ * @jsptagref.attributedescription The language attribute rendered by the HTML thead tag.
* @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_lang</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's language"
+ * @netui:attribute required="false" rtexprvalue="true" description="The language attribute rendered by the HTML thead tag."
*/
public void setLang(String lang) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.LANG, lang);
}
/**
- * Sets the value of the text direction attribute.
+ * Sets the value of the text direction attribute rendered by the HTML thead tag.
*
- * @param dir
- * @jsptagref.attributedescription The text direction attribute.
+ * @param dir the dir attribute
+ * @jsptagref.attributedescription The text direction attribute rendered by the HTML thead tag.
* @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_dir</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The cell's text direction"
+ * @netui:attribute required="false" rtexprvalue="true" description="The text direction rendered by the HTML thead tag."
*/
public void setDir(String dir) {
_theadTag.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.DIR, dir);
}
/**
+ * Set a boolean that enables / disables rendering HTML table rows by this tag. If the
+ * value is enabled, an HTML <tr> will be rendered when this tag renders its body. If
+ * the value is disabled, no <tr> tags will be rendered and the page author is responsible
+ * for maintaining the integrity of the HTML table.
+ * @jsptagref.attributedescription
+ * Set a boolean that enables / disables rendering HTML table rows by this tag. If the
+ * value is enabled, an HTML <tr> will be rendered when this tag renders its body. If
+ * the value is disabled, no <tr> tags will be rendered and the page author is responsible
+ * for maintaining the integrity of the HTML table.
+ * @jsptagref.attributesyntaxvalue <i>boolean_renderRow</i>
* @netui:attribute required="false" rtexprvalue="true"
+ * description="Boolean to enable / disable rendering HTML table row tags"
*/
public void setRenderRow(boolean renderRow) {
_renderRow = renderRow;
}
/**
- * Set the name of the tagId for the thead tag.
+ * Set the name of the tagId for the HTML thead tag.
*
- * @param tagId - the the name of the tagId for the thead tag.
+ * @param tagId the the name of the tagId for the thead tag.
* @jsptagref.attributedescription The tagId.
- * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="String value. Sets the id (or name) attribute of the rendered HTML tag. "
+ * description="String value. Sets the id (or name) attribute of the rendered HTML tag. "
*/
public void setTagId(String tagId)
throws JspException {
applyTagId(_theadTag, tagId);
}
+ /**
+ * Render this tag. This method renders during the data grid's {@link DataGridTagModel#RENDER_STATE_HEADER}
+ * state in order to add table rows to the beginning of a data grid's HTML table. If the data grid is rendering
+ * HTML row groups, this tag will output an HTML <thead> tag. Then, if this tag is rendering
+ * a table row, it will produce an HTML <tr> tag. Then the content of the body will be rendered. If
+ * table row rendering is disabled, the page author is responsible for rendering the appropriate HTML
+ * table row tags as this tag renders inside of the HTML table opened by the data grid.
+ * @throws IOException
+ * @throws JspException when the {@link DataGridTagModel} can not be found in the {@link JspContext}
+ */
public void doTag()
throws JspException, IOException {
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/HeaderCell.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/HeaderCell.java?rev=170271&r1=170270&r2=170271&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/HeaderCell.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/HeaderCell.java Sun May 15 15:11:30 2005
@@ -45,8 +45,18 @@
import org.apache.beehive.netui.util.Bundle;
/**
- * @jsptagref.tagdescription Renders an HTML table head cell tag (<code><th></code>).
- * @netui:tag name="headerCell" description="Render an HTML table head cell tag" body-content="scriptless"
+ *
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * </ul>
+ * </p>
+ *
+ * @jsptagref.tagdescription
+ * @netui:tag name="headerCell" body-content="scriptless"
+ * description="Render an HTML table head cell inside of a data grid"
*/
public class HeaderCell
extends AbstractCell
@@ -159,9 +169,9 @@
*/
/**
- * Sets the onClick javascript event.
+ * Sets the onClick JavaScript event.
*
- * @param onClick - the onClick event.
+ * @param onClick the onClick event.
* @jsptagref.attributedescription The onClick JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onClick</i>
@@ -172,9 +182,9 @@
}
/**
- * Sets the onDblClick javascript event.
+ * Sets the onDblClick JavaScript event.
*
- * @param onDblClick - the onDblClick event.
+ * @param onDblClick the onDblClick event.
* @jsptagref.attributedescription The onDblClick JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onDblClick</i>
@@ -185,9 +195,9 @@
}
/**
- * Sets the onKeyDown javascript event.
+ * Sets the onKeyDown JavaScript event.
*
- * @param onKeyDown - the onKeyDown event.
+ * @param onKeyDown the onKeyDown event.
* @jsptagref.attributedescription The onKeyDown JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onKeyDown</i>
@@ -198,9 +208,9 @@
}
/**
- * Sets the onKeyUp javascript event.
+ * Sets the onKeyUp JavaScript event.
*
- * @param onKeyUp - the onKeyUp event.
+ * @param onKeyUp the onKeyUp event.
* @jsptagref.attributedescription The onKeyUp JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onKeyUp</i>
@@ -211,9 +221,9 @@
}
/**
- * Sets the onKeyPress javascript event.
+ * Sets the onKeyPress JavaScript event.
*
- * @param onKeyPress - the onKeyPress event.
+ * @param onKeyPress the onKeyPress event.
* @jsptagref.attributedescription The onKeyPress JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onKeyPress</i>
@@ -224,9 +234,9 @@
}
/**
- * Sets the onMouseDown javascript event.
+ * Sets the onMouseDown JavaScript event.
*
- * @param onMouseDown - the onMouseDown event.
+ * @param onMouseDown the onMouseDown event.
* @jsptagref.attributedescription The onMouseDown JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onMouseDown</i>
@@ -237,9 +247,9 @@
}
/**
- * Sets the onMouseUp javascript event.
+ * Sets the onMouseUp JavaScript event.
*
- * @param onMouseUp - the onMouseUp event.
+ * @param onMouseUp the onMouseUp event.
* @jsptagref.attributedescription The onMouseUp JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onMouseUp</i>
@@ -250,9 +260,9 @@
}
/**
- * Sets the onMouseMove javascript event.
+ * Sets the onMouseMove JavaScript event.
*
- * @param onMouseMove - the onMouseMove event.
+ * @param onMouseMove the onMouseMove event.
* @jsptagref.attributedescription The onMouseMove JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onMouseMove</i>
@@ -263,9 +273,9 @@
}
/**
- * Sets the onMouseOut javascript event.
+ * Sets the onMouseOut JavaScript event.
*
- * @param onMouseOut - the onMouseOut event.
+ * @param onMouseOut the onMouseOut event.
* @jsptagref.attributedescription The onMouseOut JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onMouseOut</i>
@@ -276,9 +286,9 @@
}
/**
- * Sets the onMouseOver javascript event.
+ * Sets the onMouseOver JavaScript event.
*
- * @param onMouseOver - the onMouseOver event.
+ * @param onMouseOver the onMouseOver event.
* @jsptagref.attributedescription The onMouseOver JavaScript event.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_onMouseOver</i>
@@ -291,7 +301,7 @@
/**
* Sets the style of the rendered html tag.
*
- * @param style - the html style.
+ * @param style the html style.
* @jsptagref.attributedescription The style.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_style</i>
@@ -306,7 +316,7 @@
/**
* Sets the style class of the rendered html tag.
*
- * @param styleClass - the html style class.
+ * @param styleClass the html style class.
* @jsptagref.attributedescription The style class.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_style_class</i>
@@ -492,7 +502,7 @@
/**
* Set the name of the tagId for the th tag.
*
- * @param tagId - the the name of the tagId for the th tag.
+ * @param tagId the the name of the tagId for the th tag.
* @jsptagref.attributedescription The tagId.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/ImageAnchorCell.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/ImageAnchorCell.java?rev=170271&r1=170270&r2=170271&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/ImageAnchorCell.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/ImageAnchorCell.java Sun May 15 15:11:30 2005
@@ -34,8 +34,19 @@
import org.apache.beehive.netui.util.ParamHelper;
/**
- * @jsptagref.tagdescription Renders a column containing an image anchor.
- * @netui:tag name="imageAnchorCell" description="Renders a column containing an image anchor" body-content="scriptless"
+ * <p>
+ * The set of JSP implicit objects available to the body include:
+ * <ul>
+ * <li><code>dataGridModel</code> -- the {@link org.apache.beehive.netui.databinding.datagrid.api.rendering.DataGridTagModel}
+ * for the cell's containing data grid.</li>
+ * <li><code>container</code> -- the {@link org.apache.beehive.netui.script.common.IDataAccessProvider} instance
+ * that exposes the current data item and the current item's index</li>
+ * </ul>
+ * </p>
+ *
+ * @jsptagref.tagdescription
+ * @netui:tag name="imageAnchorCell" body-content="scriptless"
+ * description="Renders an HTML table cell in a data grid that contains an HTML image inside of an anchor."
*/
public class ImageAnchorCell
extends AbstractHtmlTableCell
@@ -58,141 +69,130 @@
}
/**
- * Sets the onClick javascript event.
+ * Sets the onClick JavaScript for the HTML anchor tag.
*
- * @param onClick - the onClick event.
- * @jsptagref.attributedescription The onClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onClick the onClick event.
+ * @jsptagref.attributedescription The onClick JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onClick JavaScript for the HTML anchor tag."
*/
public void setOnClick(String onClick) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONCLICK, onClick);
}
/**
- * Sets the onDblClick javascript event.
+ * Sets the onDblClick JavaScript for the HTML anchor tag.
*
- * @param onDblClick - the onDblClick event.
- * @jsptagref.attributedescription The onDblClick JavaScript event.
- * @jsptagref.databindable false
+ * @param onDblClick the onDblClick event.
+ * @jsptagref.attributedescription The onDblClick JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onDblClick</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onDblClick JavaScript for the HTML anchor tag."
*/
public void setOnDblClick(String onDblClick) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONDBLCLICK, onDblClick);
}
/**
- * Sets the onKeyDown javascript event.
+ * Sets the onKeyDown JavaScript for the HTML anchor tag.
*
- * @param onKeyDown - the onKeyDown event.
- * @jsptagref.attributedescription The onKeyDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyDown the onKeyDown event.
+ * @jsptagref.attributedescription The onKeyDown JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyDown JavaScript for the HTML anchor tag."
*/
public void setOnKeyDown(String onKeyDown) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYDOWN, onKeyDown);
}
/**
- * Sets the onKeyUp javascript event.
+ * Sets the onKeyUp JavaScript for the HTML anchor tag.
*
- * @param onKeyUp - the onKeyUp event.
- * @jsptagref.attributedescription The onKeyUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyUp the onKeyUp event.
+ * @jsptagref.attributedescription The onKeyUp JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyUp JavaScript for the HTML anchor tag."
*/
public void setOnKeyUp(String onKeyUp) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYUP, onKeyUp);
}
/**
- * Sets the onKeyPress javascript event.
+ * Sets the onKeyPress JavaScript for the HTML anchor tag.
*
- * @param onKeyPress - the onKeyPress event.
- * @jsptagref.attributedescription The onKeyPress JavaScript event.
- * @jsptagref.databindable false
+ * @param onKeyPress the onKeyPress event.
+ * @jsptagref.attributedescription The onKeyPress JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onKeyPress</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onKeyPress JavaScript for the HTML anchor tag."
*/
public void setOnKeyPress(String onKeyPress) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONKEYPRESS, onKeyPress);
}
/**
- * Sets the onMouseDown javascript event.
+ * Sets the onMouseDown JavaScript for the HTML anchor tag.
*
- * @param onMouseDown - the onMouseDown event.
- * @jsptagref.attributedescription The onMouseDown JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseDown the onMouseDown event.
+ * @jsptagref.attributedescription The onMouseDown JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseDown</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseDown JavaScript for the HTML anchor tag."
*/
public void setOnMouseDown(String onMouseDown) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEDOWN, onMouseDown);
}
/**
- * Sets the onMouseUp javascript event.
+ * Sets the onMouseUp JavaScript for the HTML anchor tag.
*
- * @param onMouseUp - the onMouseUp event.
- * @jsptagref.attributedescription The onMouseUp JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseUp the onMouseUp event.
+ * @jsptagref.attributedescription The onMouseUp JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseUp</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseUp JavaScript for the HTML anchor tag."
*/
public void setOnMouseUp(String onMouseUp) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEUP, onMouseUp);
}
/**
- * Sets the onMouseMove javascript event.
+ * Sets the onMouseMove JavaScript for the HTML anchor tag.
*
- * @param onMouseMove - the onMouseMove event.
- * @jsptagref.attributedescription The onMouseMove JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseMove the onMouseMove event.
+ * @jsptagref.attributedescription The onMouseMove JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseMove</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseMove JavaScript for the HTML anchor tag."
*/
public void setOnMouseMove(String onMouseMove) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEMOVE, onMouseMove);
}
/**
- * Sets the onMouseOut javascript event.
+ * Sets the onMouseOut JavaScript for the HTML anchor tag.
*
- * @param onMouseOut - the onMouseOut event.
- * @jsptagref.attributedescription The onMouseOut JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOut the onMouseOut event.
+ * @jsptagref.attributedescription The onMouseOut JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOut</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOut JavaScript for the HTML anchor tag."
*/
public void setOnMouseOut(String onMouseOut) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOUT, onMouseOut);
}
/**
- * Sets the onMouseOver javascript event.
+ * Sets the onMouseOver JavaScript for the HTML anchor tag.
*
- * @param onMouseOver - the onMouseOver event.
- * @jsptagref.attributedescription The onMouseOver JavaScript event.
- * @jsptagref.databindable false
+ * @param onMouseOver the onMouseOver event.
+ * @jsptagref.attributedescription The onMouseOver JavaScript for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_onMouseOver</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript event."
+ * @netui:attribute required="false" rtexprvalue="true" description="The onMouseOver JavaScript for the HTML anchor tag."
*/
public void setOnMouseOver(String onMouseOver) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_JAVASCRIPT, HtmlConstants.ONMOUSEOVER, onMouseOver);
}
/**
- * Sets the style of the rendered html tag.
+ * Sets the style of the rendered HTML anchor tag.
*
- * @param style - the html style.
- * @jsptagref.attributedescription The style.
- * @jsptagref.databindable false
+ * @param style the html style.
+ * @jsptagref.attributedescription The style for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true" description="The style."
*/
@@ -203,13 +203,12 @@
}
/**
- * Sets the style class of the rendered html tag.
+ * Sets the style class of the rendered HTML anchor tag.
*
- * @param styleClass - the html style class.
- * @jsptagref.attributedescription The style class.
- * @jsptagref.databindable false
+ * @param styleClass the style class.
+ * @jsptagref.attributedescription The style class for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_style_class</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The style class."
+ * @netui:attribute required="false" rtexprvalue="true" description="The style class for the HTML anchor tag."
*/
public void setStyleClass(String styleClass) {
if("".equals(styleClass)) return;
@@ -218,13 +217,12 @@
}
/**
- * Sets the value of the title attribute.
+ * Sets the value of the title attribute for the HTML anchor tag.
*
- * @param title
- * @jsptagref.attributedescription The title.
- * @jsptagref.databindable false
+ * @param title the title
+ * @jsptagref.attributedescription The title for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_title</i>
- * @netui:attribute required="false" rtexprvalue="true" description="The title. "
+ * @netui:attribute required="false" rtexprvalue="true" description="The title for the HTML anchor tag."
*/
public void setTitle(String title) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.TITLE, title);
@@ -238,70 +236,65 @@
--------------------------------------------------------- */
/**
- * Sets <code>charset</code> attribute for the anchor.
+ * Sets <code>charset</code> attribute for the HTML anchor tag
*
- * @param charSet - the window target.
- * @jsptagref.attributedescription The character set.
- * @jsptagref.databindable false
+ * @param charSet the charset
+ * @jsptagref.attributedescription The character set for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_charset</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The character set."
+ * description="The character set for the HTML anchor tag."
*/
public void setCharSet(String charSet) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.CHARSET, charSet);
}
/**
- * Sets <code>type</code> attribute for the anchor.
+ * Sets <code>type</code> attribute for the HTML anchor tag.
*
- * @param type - the window target.
- * @jsptagref.attributedescription The type.
- * @jsptagref.databindable false
+ * @param type the type
+ * @jsptagref.attributedescription The type attribute for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_type</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The type."
+ * description="The type attribute for the HTML anchor tag."
*/
public void setType(String type) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.TYPE, type);
}
/**
- * Sets <code>hreflang</code> attribute for the anchor.
+ * Sets <code>hreflang</code> attribute for the HTML anchor tag.
*
- * @param hreflang - the window target.
- * @jsptagref.attributedescription The HREF lang.
- * @jsptagref.databindable false
+ * @param hreflang the hreflang.
+ * @jsptagref.attributedescription The hreflang attribute for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_hreflang</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The HREF lang."
+ * description="The hreflang attribute for the HTML anchor tag."
*/
public void setHrefLang(String hreflang) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.HREFLANG, hreflang);
}
/**
- * Sets <code>rel</code> attribute for the anchor.
+ * Sets <code>rel</code> attribute for the HTML anchor tag.
*
- * @param rel - the window target.
- * @jsptagref.attributedescription The rel attribute for the anchor.
- * @jsptagref.databindable false
+ * @param rel the rel attribute
+ * @jsptagref.attributedescription The rel attribute for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_rel</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The rel."
+ * description="The rel attribute for the HTML anchor tag."
*/
public void setRel(String rel) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.REL, rel);
}
/**
- * Sets <code>rev</code> attribute for the anchor.
+ * Sets <code>rev</code> attribute for the HTML anchor tag.
*
- * @param rev - the window target.
- * @jsptagref.attributedescription The rev.
- * @jsptagref.databindable false
+ * @param rev the rev attribute.
+ * @jsptagref.attributedescription The rev attribute for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_rev</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The rev."
+ * description="The rev attribute for the HTML anchor tag."
*/
public void setRev(String rev) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.REV, rev);
@@ -309,29 +302,26 @@
/**
- * Sets the window target.
+ * Sets the window target for the HTML anchor tag.
*
- * @param target - the window target.
- * @jsptagref.attributedescription The window target.
- * @jsptagref.databindable false
+ * @param target the window target
+ * @jsptagref.attributedescription The window target for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_action</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The window target."
+ * description="The window target for the HTML anchor tag."
*/
public void setTarget(String target) {
_anchorState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.TARGET, target);
}
/**
- * Sets the href of the Anchor. This attribute will accept the empty String as a legal value.
+ * Sets the href of the HTML anchor tag. This attribute will accept the empty String as a legal value.
*
- * @param href - the hyperlink URI for the Area.
- * @jsptagref.attributedescription The URL to go to.
- * @jsptagref.databindable false
+ * @param href the hyperlink URI for the anchor.
+ * @jsptagref.attributedescription The HREF for the HTML anchor tag.
* @jsptagref.attributesyntaxvalue <i>string_href</i>
- * @netui:attribute required="false" rtexprvalue="true"
- * description="The URL to go to."
- * reftype="url"
+ * @netui:attribute required="false" rtexprvalue="true" reftype="url"
+ * description="The HREF for the HTML anchor tag."
*/
public void setHref(String href) {
_imageAnchorCellModel.setHref(href);
@@ -341,9 +331,8 @@
* Set the target "scope" for the anchor's action. Multiple active page flows may exist concurrently within named
* scopes. This attribute selects which named scope to use. If omitted, the default scope is assumed.
*
- * @param targetScope - the name of the target scope in which the associated action's page flow resides.
+ * @param targetScope the name of the target scope in which the associated action's page flow resides.
* @jsptagref.attributedescription The target scope in which the associated action's page flow resides.
- * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_targetScope</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The target scope in which the associated action's page flow resides"
@@ -353,12 +342,12 @@
}
/**
- * Set the name of the action for the Area.
+ * Set the name of the action for the HTML anchor tag. This action name must be valid given the
+ * current Page Flow.
*
- * @param action - the name of the action to set for the Area.
- * @jsptagref.attributedescription The action method to invoke. The action method must be in the Controller file
- * of the Page Flow directory.
- * @jsptagref.databindable false
+ * @param action the name of the action to set for the anchor tag.
+ * @jsptagref.attributedescription The action method to invoke. The action method must valid given the
+ * ccurrent Page Flow.
* @jsptagref.attributesyntaxvalue <i>string_action</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The action method to invoke. The action method must be in the Controller file of the Page Flow directory."
@@ -375,110 +364,104 @@
--------------------------------------------------------- */
/**
- * Sets the property to specify where to align the image.
+ * Sets the alignment attribute for the HTML image tag.
*
- * @param align - the image alignment.
- * @jsptagref.attributedescription The alignment of the image.
- * @jsptagref.databindable false
+ * @param align the image alignment.
+ * @jsptagref.attributedescription The alignment attribute for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_align</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The alignment of the image."
+ * description="The alignment for the HTML image tag."
*/
public void setAlign(String align) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.ALIGN, align);
}
/**
- * Sets the property to specify the alt text of the image.
+ * Sets the alt text attribute for the HTML image tag.
*
- * @param alt - the image alignment.
- * @jsptagref.attributedescription The alternative text of the image
- * @jsptagref.databindable Read Only
+ * @param alt the alt attribute.
+ * @jsptagref.attributedescription The alternative text of the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_alt</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The alternative text of the image."
+ * description="The alternative text of the HTML image tag."
*/
public void setAlt(String alt) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.ALT, alt);
}
/**
- * Sets the property to specify the longdesc.
+ * Sets the longdesc attribute for the HTML image tag.
*
- * @param longdesc - the longdesc.
+ * @param longdesc the longdesc attribute
+ * @jsptagref.attributedescription The longdesc attribute for the HTML image tag.
+ * @jsptagref.attributesyntaxvalue <i>string_alt</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Sets the property to specify the longdesc."
+ * description="the longdesc for the HTML image tag."
*/
public void setLongdesc(String longdesc) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.LONGDESC, longdesc);
}
/**
- * Sets the border size around the image.
+ * Sets the border size attribute for the HTML image tag.
*
- * @param border - the border size.
- * @jsptagref.attributedescription The border size around the image
- * @jsptagref.databindable false
+ * @param border the border size.
+ * @jsptagref.attributedescription The border size attribute for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>integer_pixelBorder</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The border size around the image."
+ * description="The border size attribute for the HTML image tag."
*/
public void setBorder(String border) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.BORDER, border);
}
/**
- * Sets the image height.
+ * Sets the image height attribute for the HTML image tag.
*
- * @param height - the height.
- * @jsptagref.attributedescription The image height
- * @jsptagref.databindable Read Only
+ * @param height the height.
+ * @jsptagref.attributedescription The image height attribute for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>integer_height</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The image height."
+ * description="The image height attribute for the HTML image tag."
*/
public void setHeight(String height) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.HEIGHT, height);
}
/**
- * Sets the the horizontal spacing around the image.
+ * Sets the the horizontal spacing attribute for the HTML image tag.
*
- * @param hspace - the horizontal spacing.
- * @jsptagref.attributedescription The horizontal spacing around the image.
- * @jsptagref.databindable Read Only
+ * @param hspace the horizontal spacing.
+ * @jsptagref.attributedescription The horizontal spacing for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>integer_hspace</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The horizontal spacing around the image."
+ * description="The horizontal spacing for the HTML image tag."
*/
public void setHspace(String hspace) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.HSPACE, hspace);
}
/**
- * Sets the server-side image map declaration.
+ * Sets the server-side image map declaration for the HTML image tag.
*
- * @param ismap - the image map declaration.
- * @jsptagref.attributedescription The server-side map declaration.
- * @jsptagref.databindable false
+ * @param ismap the image map declaration.
+ * @jsptagref.attributedescription The server-side map declaration for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_isMap</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The server-side map declaration."
+ * description="The server-side map declaration for the HTML image tag."
*/
public void setIsmap(String ismap) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.ISMAP, ismap);
}
/**
- * Sets the image source URI.
+ * Sets the image source URI for the HTML image tag.
*
- * @param src - the image source URI.
- * @jsptagref.attributedescription The image source URI
- * @jsptagref.databindable Read Only
+ * @param src the image source URI.
+ * @jsptagref.attributedescription The image source URI for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_src</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The image source URI"
- * reftype="img-url"
+ * description="The image source URI for the HTML image tag" reftype="img-url"
*/
public void setSrc(String src)
throws JspException {
@@ -486,28 +469,26 @@
}
/**
- * Sets the client-side image map declaration.
+ * Sets the client-side image map declaration for the HTML iage tag.
*
- * @param usemap - the map declaration.
- * @jsptagref.attributedescription The client-side image map declaration
- * @jsptagref.databindable false
+ * @param usemap the map declaration.
+ * @jsptagref.attributedescription The client-side image map declaration for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_useMap</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The client-side image map declaration"
+ * description="The client-side image map declaration for the HTML image tag."
*/
public void setUsemap(String usemap) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.USEMAP, usemap);
}
/**
- * Sets the vertical spacing around the image.
+ * Sets the vertical spacing around the HTML image tag.
*
- * @param vspace - the vertical spacing.
- * @jsptagref.attributedescription The vertical spacing around the image.
- * @jsptagref.databindable Read Only
+ * @param vspace the vertical spacing.
+ * @jsptagref.attributedescription The vertical spacing around the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_vspace</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The vertical spacing around the image."
+ * description="The vertical spacing around the HTML image tag."
*/
public void setVspace(String vspace) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.VSPACE, vspace);
@@ -519,9 +500,11 @@
* set. If this is not set, and <code>style</code> is set, then it will be applied to
* the image.
*
- * @param imageStyle - the label style
+ * @param imageStyle the image style
+ * @jsptagref.attributedescription The style for the HTML image tag.
+ * @jsptagref.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Set the style for the contained image. "
+ * description="Set the style for the HTML image tag."
*/
public void setImageStyle(String imageStyle) {
_imageState.style = imageStyle;
@@ -533,34 +516,34 @@
* set. If this is not set, and <code>styleClass</code> is set, then it will be applied to
* the image.
*
- * @param imageClass - the image class
+ * @param imageClass the image class
+ * @jsptagref.attributedescription The style class for the HTML image tag.
+ * @jsptagref.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Set the label style class for each contained image."
+ * description="Set the style class for each contained image."
*/
public void setImageStyleClass(String imageClass) {
_imageState.styleClass = imageClass;
}
/**
- * Sets the image width.
+ * Sets the width attribute for the HTML image tag.
*
- * @param width - the image width.
- * @jsptagref.attributedescription The image width.
- * @jsptagref.databindable Read Only
+ * @param width the image width.
+ * @jsptagref.attributedescription The width for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>integer_pixelWidth</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The image width."
+ * description="The width attribute for the HTML image tag."
*/
public void setWidth(String width) {
_imageState.registerAttribute(AbstractHtmlState.ATTR_GENERAL, HtmlConstants.WIDTH, width);
}
/**
- * Set the name of the tagId for the image.
+ * Set the name of the tagId for the HTML image tag.
*
- * @param tagId - the the name of the tagId for the image.
- * @jsptagref.attributedescription The tagId.
- * @jsptagref.databindable false
+ * @param tagId the the name of the tagId for the image.
+ * @jsptagref.attributedescription The tagId for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="String value. Sets the id (or name) attribute of the rendered HTML tag. "
@@ -571,11 +554,10 @@
}
/**
- * Set the name of the tagId for the anchor.
+ * Set the name of the tagId for the HTML image tag..
*
- * @param tagId - the the name of the tagId for the anchor.
- * @jsptagref.attributedescription The tagId.
- * @jsptagref.databindable false
+ * @param tagId the the name of the tagId for the image.
+ * @jsptagref.attributedescription The tagId for the HTML image tag.
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="String value. Sets the id (or name) attribute of the rendered HTML tag. "
@@ -625,6 +607,12 @@
DECORATOR.decorate(getJspContext(), appender, _imageAnchorCellModel);
}
+ /**
+ * Implementation of {@link AbstractHtmlTableCell#internalGetCellModel()} that exposes the
+ * {@link org.apache.beehive.netui.databinding.datagrid.runtime.model.cell.ImageAnchorCellModel}
+ * which is storing state for this tag.
+ * @return this tag's image anchor cell model
+ */
protected CellModel internalGetCellModel() {
return _imageAnchorCellModel;
}