railo.runtime.tag
Class GridColumn

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.tag.GridColumn
All Implemented Interfaces:
javax.servlet.jsp.tagext.Tag

public final class GridColumn
extends TagImpl

Used with cfgrid in a cfform, you use cfgridcolumn to specify column data in a cfgrid control. Font and alignment attributes used in cfgridcolumn override any global font or alignment settings defined in cfgrid.


Field Summary
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
GridColumn()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setBgcolor(String bgcolor)
          set the value bgcolor Color value for the background of the grid column, or an expression you can use to manipulate grid column background color.
 void setBold(boolean bold)
          set the value bold Yes or No.
 void setDataalign(String dataalign)
          set the value dataalign Alignment for column data.
 void setDisplay(boolean display)
          set the value display Yes or No.
 void setFont(String font)
          set the value font Font name to use for data in the column.
 void setFontsize(double fontsize)
          set the value fontsize Font size for text in the column.
 void setHeader(String header)
          set the value header Text for the column header.
 void setHeaderalign(String headeralign)
          set the value headeralign Alignment for the column header text.
 void setHeaderbold(boolean headerbold)
          set the value headerbold Yes or No.
 void setHeaderfont(String headerfont)
          set the value headerfont Font to use for the column header.
 void setHeaderfontsize(double headerfontsize)
          set the value headerfontsize Font size to use for the column header, in pixels.
 void setHeaderitalic(boolean headeritalic)
          set the value headeritalic Yes or No.
 void setHeadertextcolor(String headertextcolor)
          set the value colheadertextcolor Color value for the grid control column header text.
 void setHref(String href)
          set the value href URL to associate with the grid item.
 void setHrefkey(String hrefkey)
          set the value hrefkey The name of a query column when the grid uses a query.
 void setItalic(boolean italic)
          set the value italic Yes or No.
 void setMask(String mask)
           
 void setName(String name)
          set the value name A name for the grid column element.
 void setNumberformat(String numberformat)
          set the value numberformat The format for displaying numeric data in the grid.
 void setSelect(boolean select)
          set the value select Yes or No.
 void setTarget(String target)
          set the value target The name of the frame in which to open the link specified in href.
 void setTextcolor(String textcolor)
          set the value textcolor Color value for grid element text in the grid column, or an expression you can use to manipulate text color in grid column elements.
 void setType(String type)
          set the value type
 void setValues(String values)
          set the value values Formats cells in the column as drop down list boxes.
 void setValuesdelimiter(String valuesdelimiter)
          set the value valuesdelimiter Character to use as a delimiter in the values and valuesDisplay attributes.
 void setValuesdisplay(String valuesdisplay)
          set the value valuesdisplay Used to map elements specified in the values attribute to a string of your choice to display in the drop down list.
 void setWidth(double width)
          set the value width The width of the column, in pixels.
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridColumn

public GridColumn()
           throws TagNotSupported
Throws:
TagNotSupported
Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class TagImpl
See Also:
Tag.release()

setMask

public void setMask(String mask)
Parameters:
mask - the mask to set

setDisplay

public void setDisplay(boolean display)
set the value display Yes or No. Use to hide columns. Default is Yes to display the column.

Parameters:
display - value to set

setWidth

public void setWidth(double width)
set the value width The width of the column, in pixels. Default is the width of the column head text.

Parameters:
width - value to set

setHeaderfontsize

public void setHeaderfontsize(double headerfontsize)
set the value headerfontsize Font size to use for the column header, in pixels. Default is as specified by the orresponding attribute of cfgrid.

Parameters:
headerfontsize - value to set

setHrefkey

public void setHrefkey(String hrefkey)
set the value hrefkey The name of a query column when the grid uses a query. The column specified becomes the Key regardless of the select mode for the grid.

Parameters:
hrefkey - value to set

setTarget

public void setTarget(String target)
set the value target The name of the frame in which to open the link specified in href.

Parameters:
target - value to set

setValues

public void setValues(String values)
set the value values Formats cells in the column as drop down list boxes. lets end users select an item in a drop down list. Use the values attribute to specify the items you want to appear in the drop down list.

Parameters:
values - value to set

setHeaderfont

public void setHeaderfont(String headerfont)
set the value headerfont Font to use for the column header. Default is as specified by the corresponding attribute of cfgrid.

Parameters:
headerfont - value to set

setFont

public void setFont(String font)
set the value font Font name to use for data in the column. Defaults is the font specified by cfgrid.

Parameters:
font - value to set

setItalic

public void setItalic(boolean italic)
set the value italic Yes or No. Yes displays all grid control text in italic. Default is as specified by the corresponding attribute of cfgrid.

Parameters:
italic - value to set

setBgcolor

public void setBgcolor(String bgcolor)
                throws ExpressionException
set the value bgcolor Color value for the background of the grid column, or an expression you can use to manipulate grid column background color. Valid color entries are: black, magenta, cyan, orange, darkgray, pink, gray, white (default), lightgray, yellow.

Parameters:
bgcolor - value to set
Throws:
ExpressionException

setValuesdisplay

public void setValuesdisplay(String valuesdisplay)
set the value valuesdisplay Used to map elements specified in the values attribute to a string of your choice to display in the drop down list. Enter comma separated strings and/or numeric range(s).

Parameters:
valuesdisplay - value to set

setHeaderitalic

public void setHeaderitalic(boolean headeritalic)
set the value headeritalic Yes or No. Yes displays column header text in italic. Default is as specified by the corresponding attribute of cfgrid.

Parameters:
headeritalic - value to set

setName

public void setName(String name)
set the value name A name for the grid column element. If the grid uses a query, the column name must specify the name of a query column.

Parameters:
name - value to set

setHref

public void setHref(String href)
set the value href URL to associate with the grid item. You can specify a URL that is relative to the current page

Parameters:
href - value to set

setType

public void setType(String type)
set the value type

Parameters:
type - value to set

setValuesdelimiter

public void setValuesdelimiter(String valuesdelimiter)
set the value valuesdelimiter Character to use as a delimiter in the values and valuesDisplay attributes. Default is "," (comma).

Parameters:
valuesdelimiter - value to set

setNumberformat

public void setNumberformat(String numberformat)
set the value numberformat The format for displaying numeric data in the grid. For information about mask characters, see "numberFormat mask characters".

Parameters:
numberformat - value to set

setHeader

public void setHeader(String header)
set the value header Text for the column header. The value of header is used only when the cfgrid colHeaders attribute is Yes (or omitted, since it defaults to Yes).

Parameters:
header - value to set

setTextcolor

public void setTextcolor(String textcolor)
                  throws ExpressionException
set the value textcolor Color value for grid element text in the grid column, or an expression you can use to manipulate text color in grid column elements. Valid color entries are: black (default), magenta, cyan, orange, arkgray, pink, gray, white, lightgray, yellow

Parameters:
textcolor - value to set
Throws:
ExpressionException

setSelect

public void setSelect(boolean select)
set the value select Yes or No. Yes lets end users select a column in a grid control. When No, the column cannot be edited, even if the cfgrid insert or delete attributes are enabled. The value of the select attribute is ignored if the cfgrid selectMode attribute is set to Row or Browse.

Parameters:
select - value to set

setHeaderalign

public void setHeaderalign(String headeralign)
set the value headeralign Alignment for the column header text. Default is as specified by cfgrid.

Parameters:
headeralign - value to set

setDataalign

public void setDataalign(String dataalign)
set the value dataalign Alignment for column data. Entries are: left, center, or right. Default is as specified by cfgrid.

Parameters:
dataalign - value to set

setBold

public void setBold(boolean bold)
set the value bold Yes or No. Yes displays all grid control text in boldface. Default is as specified by the corresponding attribute of cfgrid.

Parameters:
bold - value to set

setHeaderbold

public void setHeaderbold(boolean headerbold)
set the value headerbold Yes or No. Yes displays header text in boldface. Default is as specified by the corresponding attribute of cfgrid.

Parameters:
headerbold - value to set

setHeadertextcolor

public void setHeadertextcolor(String headertextcolor)
                        throws ExpressionException
set the value colheadertextcolor Color value for the grid control column header text. Entries are: black (default), magenta, cyan, orange, darkgray, pink, gray, white, lightgray, yellow.

Parameters:
headertextcolor - value to set
Throws:
ExpressionException

setFontsize

public void setFontsize(double fontsize)
set the value fontsize Font size for text in the column. Default is the font specified by cfgrid.

Parameters:
fontsize - value to set

doStartTag

public int doStartTag()
               throws PageException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
PageException
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class TagImpl
See Also:
Tag.doEndTag()


Copyright © 2012 Railo