Home » displaytag-1.1.1-src » org » displaytag » tags » [javadoc | source]
org.displaytag.tags
public class: ColumnTag [javadoc | source]
java.lang.Object
   javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
         org.displaytag.tags.ColumnTag

All Implemented Interfaces:
    SupportsMedia, BodyTag, IterationTag, Serializable

Direct Known Subclasses:
    ELColumnTag

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.

Method from org.displaytag.tags.ColumnTag Summary:
doEndTag,   doStartTag,   getSupportedMedia,   getTableTag,   release,   setAutolink,   setClass,   setComparator,   setDecorator,   setDefaultorder,   setEscapeXml,   setFormat,   setGroup,   setHeaderClass,   setHeaderScope,   setHref,   setMaxLength,   setMaxWords,   setMedia,   setNulls,   setParamId,   setParamName,   setParamProperty,   setParamScope,   setProperty,   setScope,   setSortName,   setSortProperty,   setSortable,   setStyle,   setSupportedMedia,   setTitle,   setTitleKey,   setTotal,   setUrl,   setValue,   toString
Methods from javax.servlet.jsp.tagext.BodyTagSupport:
doAfterBody,   doEndTag,   doInitBody,   doStartTag,   getBodyContent,   getPreviousOut,   release,   setBodyContent
Methods from javax.servlet.jsp.tagext.TagSupport:
doAfterBody,   doEndTag,   doStartTag,   findAncestorWithClass,   getId,   getParent,   getValue,   getValues,   release,   removeValue,   setId,   setPageContext,   setParent,   setValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.displaytag.tags.ColumnTag Detail:
 public int doEndTag() throws 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.

 public int doStartTag() throws JspException 
 public List getSupportedMedia() 
 protected TableTag getTableTag() 
    Looks up the parent table tag.
 public  void release() 
 public  void setAutolink(boolean value) 
    setter for the "autolink" tag attribute.
 public  void setClass(String value) 
    setter for the "class" tag attribute.
 public  void setComparator(Object comparatorObj) 
    Set the comparator, classname or object.
 public  void setDecorator(String value) 
    setter for the "decorator" tag attribute.
 public  void setDefaultorder(String value) throws InvalidTagAttributeValueException 
    sets the sorting order for the sorted column.
 public  void setEscapeXml(boolean value) 
    setter for the "escapeXml" tag attribute.
 public  void setFormat(String value) 
    setter for the "format" tag attribute.
 public  void setGroup(int value) 
    setter for the "group" tag attribute.
 public  void setHeaderClass(String value) 
    setter for the "headerClass" tag attribute.
 public  void setHeaderScope(String value) 
    setter for the "headerScope" tag attribute.
 public  void setHref(String value) 
    setter for the "href" tag attribute.
 public  void setMaxLength(int value) 
    setter for the "maxLength" tag attribute.
 public  void setMaxWords(int value) 
    setter for the "maxWords" tag attribute.
 public  void setMedia(String media) 
    Tag setter.
 public  void setNulls(boolean value) 
    setter for the "nulls" tag attribute.
 public  void setParamId(String value) 
    setter for the "paramId" tag attribute.
 public  void setParamName(String value) 
    setter for the "paramName" tag attribute.
 public  void setParamProperty(String value) 
    setter for the "paramProperty" tag attribute.
 public  void setParamScope(String value) 
    setter for the "paramScope" tag attribute.
 public  void setProperty(String value) 
    setter for the "property" tag attribute.
 public  void setScope(String value) 
    setter for the "scope" tag attribute.
 public  void setSortName(String sortName) 
    sets the name given to the server when sorting this column
 public  void setSortProperty(String value) 
    setter for the "sortProperty" tag attribute.
 public  void setSortable(boolean value) 
    setter for the "sortable" tag attribute.
 public  void setStyle(String value) 
    setter for the "style" tag attribute.
 public  void setSupportedMedia(List media) 
 public  void setTitle(String value) 
    setter for the "title" tag attribute.
 public  void setTitleKey(String value) 
    setter for the "titleKey" tag attribute.
 public  void setTotal(boolean totals) 
    Setter for totals.
 public  void setUrl(String value) 
    setter for the "url" tag attribute. This has the same meaning of href, but prepends the context path to the given URI.
 public  void setValue(Object value) 
    setter for the "value" tag attribute.
 public String toString()