org.displaytag.tags
Class ColumnTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.displaytag.tags.ColumnTag

All Implemented Interfaces:

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

Direct Known Subclasses:

ELColumnTag

public class ColumnTag

extends javax.servlet.jsp.tagext.BodyTagSupport

This tag works hand in hand with the TableTag to display a list of objects. This describes a column of data in the TableTag. There can be any number of columns that make up the list.

This tag does no work itself, it is simply a container of information. The TableTag does all the work based on the information provided in the attributes of this tag.

Version:

$Revision: 1.48 $ ($Author: fgiust $)

Author:

mraible, Fabrizio Giustina

See Also:

Serialized Form

Field Summary

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

ColumnTag()

Method Summary

void	addClass(java.lang.String value) Adds a css class to the class attribute (html class suports multiple values).
boolean	availableForMedia(MediaTypeEnum mediaType) Is this column configured for the media type?
int	doEndTag() Passes attribute information up to the parent TableTag.
int	doStartTag()
void	release()
void	setAlign(java.lang.String value) Deprecated. use css in "class" or "style"
void	setAutolink(boolean value) setter for the "autolink" tag attribute.
void	setBackground(java.lang.String value) Deprecated. use css in "class" or "style"
void	setBgcolor(java.lang.String value) Deprecated. use css in "class" or "style"
void	setClass(java.lang.String value) setter for the "class" tag attribute.
void	setDecorator(java.lang.String value) setter for the "decorator" tag attribute.
void	setGroup(int value) setter for the "group" tag attribute.
void	setHeaderClass(java.lang.String value) setter for the "headerClass" tag attribute.
void	setHeight(java.lang.String value) Deprecated. use css in "class" or "style"
void	setHref(java.lang.String value) setter for the "href" tag attribute.
void	setMaxLength(int value) setter for the "maxLength" tag attribute.
void	setMaxWords(int value) setter for the "maxWords" tag attribute.
void	setMedia(java.lang.String media) Tag setter.
void	setNowrap(java.lang.String value) Deprecated. use css in "class" or "style"
void	setNulls(boolean value) setter for the "nulls" tag attribute.
void	setParamId(java.lang.String value) setter for the "paramId" tag attribute.
void	setParamName(java.lang.String value) setter for the "paramName" tag attribute.
void	setParamProperty(java.lang.String value) setter for the "paramProperty" tag attribute.
void	setParamScope(java.lang.String value) setter for the "paramScope" tag attribute.
void	setProperty(java.lang.String value) setter for the "property" tag attribute.
void	setSortable(boolean value) setter for the "sortable" tag attribute.
void	setSortProperty(java.lang.String value) setter for the "sortProperty" tag attribute.
void	setStyle(java.lang.String value) setter for the "style" tag attribute.
void	setTitle(java.lang.String value) setter for the "title" tag attribute.
void	setTitleKey(java.lang.String value) setter for the "titleKey" tag attribute.
void	setUrl(java.lang.String value) setter for the "url" tag attribute.
void	setValign(java.lang.String value) Deprecated. use css in "class" or "style"
void	setWidth(java.lang.String value) Deprecated. use css in "class" or "style"
java.lang.String	toString()

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

ColumnTag

public ColumnTag()

Method Detail

setProperty

public void setProperty(java.lang.String value)

setter for the "property" tag attribute.

Parameters:

value - attribute value

setTitle

public void setTitle(java.lang.String value)

setter for the "title" tag attribute.

Parameters:

value - attribute value

setNulls

public void setNulls(boolean value)

setter for the "nulls" tag attribute.

Parameters:

value - attribute value

setSortable

public void setSortable(boolean value)

setter for the "sortable" tag attribute.

Parameters:

value - attribute value

setAutolink

public void setAutolink(boolean value)

setter for the "autolink" tag attribute.

Parameters:

value - attribute value

setGroup

public void setGroup(int value)

setter for the "group" tag attribute.

Parameters:

value - attribute value

setTitleKey

public void setTitleKey(java.lang.String value)

setter for the "titleKey" tag attribute.

Parameters:

value - property name

setHref

public void setHref(java.lang.String value)

setter for the "href" tag attribute.

Parameters:

value - attribute value

setUrl

public void setUrl(java.lang.String value)

setter for the "url" tag attribute. This has the same meaning of href, but prepends the context path to the given URI.

Parameters:

value - attribute value

setParamId

public void setParamId(java.lang.String value)

setter for the "paramId" tag attribute.

Parameters:

value - attribute value

setParamName

public void setParamName(java.lang.String value)

setter for the "paramName" tag attribute.

Parameters:

value - attribute value

setParamProperty

public void setParamProperty(java.lang.String value)

setter for the "paramProperty" tag attribute.

Parameters:

value - attribute value

setParamScope

public void setParamScope(java.lang.String value)

setter for the "paramScope" tag attribute.

Parameters:

value - attribute value

setMaxLength

public void setMaxLength(int value)

setter for the "maxLength" tag attribute.

Parameters:

value - attribute value

setMaxWords

public void setMaxWords(int value)

setter for the "maxWords" tag attribute.

Parameters:

value - attribute value

setWidth

public void setWidth(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "width" tag attribute.

Parameters:

value - attribute value

setAlign

public void setAlign(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "align" tag attribute.

Parameters:

value - attribute value

setBackground

public void setBackground(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "background" tag attribute.

Parameters:

value - attribute value

setBgcolor

public void setBgcolor(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "bgcolor" tag attribute.

Parameters:

value - attribute value

setHeight

public void setHeight(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "height" tag attribute.

Parameters:

value - attribute value

setNowrap

public void setNowrap(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "nowrap" tag attribute.

Parameters:

value - attribute value

setValign

public void setValign(java.lang.String value)

Deprecated. use css in "class" or "style"

setter for the "valign" tag attribute.

Parameters:

value - attribute value

setStyle

public void setStyle(java.lang.String value)

setter for the "style" tag attribute.

Parameters:

value - attribute value

setClass

public void setClass(java.lang.String value)

setter for the "class" tag attribute.

Parameters:

value - attribute value

addClass

public void addClass(java.lang.String value)

Adds a css class to the class attribute (html class suports multiple values).

Parameters:

value - attribute value

setHeaderClass

public void setHeaderClass(java.lang.String value)

setter for the "headerClass" tag attribute.

Parameters:

value - attribute value

setDecorator

public void setDecorator(java.lang.String value)

setter for the "decorator" tag attribute.

Parameters:

value - attribute value

setSortProperty

public void setSortProperty(java.lang.String value)

setter for the "sortProperty" tag attribute.

Parameters:

value - attribute value

availableForMedia

public boolean availableForMedia(MediaTypeEnum mediaType)

Is this column configured for the media type?

Parameters:

mediaType - the currentMedia type

Returns:

true if the column should be displayed for this request

setMedia

public void setMedia(java.lang.String media)

Tag setter.

Parameters:

media - the space delimited list of supported types

doEndTag

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

Passes attribute information up to the parent TableTag.

When we hit the end of the tag, we simply let our parent (which better be a TableTag) know what the user wants to do with this column. We do that by simple registering this tag with the parent. This tag's only job is to hold the configuration information to describe this particular column. The TableTag does all the work.

Returns:

int

Throws:

javax.servlet.jsp.JspException - if this tag is being used outside of a <display:list...> tag.

See Also:

Tag.doEndTag()

release

public void release()

See Also:

Tag.release()

doStartTag

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

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

toString

public java.lang.String toString()

See Also:

Object.toString()