railo.runtime.tag
Class Grid

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.ext.tag.BodyTagImpl
          extended by railo.runtime.tag.Grid
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public final class Grid
extends BodyTagImpl


Field Summary
 
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
Grid()
          constructor for the tag class
 
Method Summary
 void addColumn(GridColumnBean column)
           
 void addRow(String[] data)
           
 int doEndTag()
           
 void doInitBody()
           
 int doStartTag()
           
 void release()
           
 void setAlign(String align)
          set the value align Alignment value.
 void setAppendkey(boolean appendkey)
          set the value appendkey When used with href, Yes passes query string value of the selected tree item in the URL to the application page specified in the cfform action attribute.
 void setAutowidth(boolean autowidth)
          set the value autowidth Optional.
 void setBgcolor(String bgcolor)
          set the value bgcolor Background color value for the grid control.
 void setBold(boolean bold)
          set the value bold Yes displays grid control text in boldface.
 void setColheaderalign(String colheaderalign)
          set the value colheaderalign Enter Left, Right, or Center to position data within a column header.
 void setColheaderbold(boolean colheaderbold)
          set the value colheaderbold Yes or No.
 void setColheaderfont(String colheaderfont)
          set the value colheaderfont Font for the column header in the grid control.
 void setColheaderfontsize(double colheaderfontsize)
          set the value colheaderfontsize Size for column header text in the grid control, in points.
 void setColheaderitalic(boolean colheaderitalic)
          set the value colheaderitalic Yes or No.
 void setColheaders(boolean colheaders)
          set the value colheaders Yes or No.
 void setColheadertextcolor(String colheadertextcolor)
          set the value colheadertextcolor Color value for the grid control column headers.
 void setDelete(boolean delete)
          set the value delete Yes lets end users delete row data from the grid.
 void setDeletebutton(String deletebutton)
          set the value deletebutton Text to use for the delete action button.
 void setEnabled(boolean enabled)
           
 void setFont(String font)
          set the value font Font to use for column data in the grid control.
 void setFontsize(double fontsize)
          set the value fontsize Font size for text in the grid control, in points.
 void setFormat(String format)
           
 void setGriddataalign(String griddataalign)
          set the value griddataalign Enter Left, Right, or Center to position data in the grid within a column.
 void setGridlines(boolean gridlines)
          set the value gridlines Yes or No.
 void setHeight(double height)
          set the value height Height value of the grid control, in pixels.
 void setHighlighthref(boolean highlighthref)
          set the value highlighthref Yes highlights links associated with a cfgrid with an href attribute value.
 void setHref(String href)
          set the value href URL to associate with the grid item or a query column for a grid that is populated from a query.
 void setHrefkey(String hrefkey)
          set the value hrefkey The name of a query column when the grid uses a query.
 void setHspace(double hspace)
          set the value hspace Horizontal margin spacing to the left and right of the grid control, in pixels.
 void setInsert(boolean insert)
          set the value insert Yes lets end users insert row data into the grid.
 void setInsertbutton(String insertbutton)
          set the value insertbutton Text to use for the Insert action button.
 void setItalic(boolean italic)
          set the value italic Yes displays grid control text in italic.
 void setMaxrows(String maxrows)
          set the value maxrows Specifies the maximum number of rows to display in the grid.
 void setName(String name)
          set the value name A name for the grid element.
 void setNotsupported(String notsupported)
          set the value notsupported Selection mode for items in the grid control.
 void setOnblur(String onblur)
           
 void setOnchange(String onchange)
           
 void setOnerror(String onerror)
          set the value onerror The name of a JavaScript function to execute in the event of a failed validation.
 void setOnfocus(String onfocus)
           
 void setOnvalidate(String onvalidate)
          set the value onvalidate The name of a JavaScript function used to validate user input.
 void setPicturebar(boolean picturebar)
          set the value picturebar Yes or No.
 void setQuery(String query)
          set the value query Name of the query associated with the grid control.
 void setRowheaderalign(String rowheaderalign)
          set the value rowheaderalign Enter Left, Right, or Center to position data within a row header.
 void setRowheaderbold(boolean rowheaderbold)
          set the value rowheaderbold Yes or No.
 void setRowheaderfont(String rowheaderfont)
          set the value rowheaderfont Font to use for the row label.
 void setRowheaderfontsize(double rowheaderfontsize)
          set the value rowheaderfontsize Size for row label text in the grid control, in points.
 void setRowheaderitalic(boolean rowheaderitalic)
          set the value rowheaderitalic Yes or No.
 void setRowheaders(boolean rowheaders)
          set the value rowheaders Yes or No.
 void setRowheadertextcolor(String rowheadertextcolor)
          set the value rowheadertextcolor Text color value for the grid control row headers.
 void setRowheaderwidth(double rowheaderwidth)
          set the value rowheaderwidth The width, in pixels, of the row header column.
 void setRowheight(double rowheight)
          set the value rowheight Number of pixels for the minimum row height of the grid control.
 void setSelectcolor(String selectcolor)
          set the value selectcolor Background color for a selected item.
 void setSelectmode(String selectmode)
          set the value selectmode Selection mode for items in the grid control.
 void setSort(boolean sort)
          set the value sort If Yes, sort buttons are added to the grid control.
 void setSortascendingbutton(String sortascendingbutton)
          set the value sortascendingbutton Text to use for the Sort button.
 void setSortdescendingbutton(String sortdescendingbutton)
          set the value sortdescendingbutton Text to use for the Sort button.
 void setStyle(String style)
           
 void setTarget(String target)
          set the value target Target attribute for href URL.
 void setTextcolor(String textcolor)
          set the value textcolor Color value for text in the grid control.
 void setTooltip(String tooltip)
           
 void setVisible(boolean visible)
           
 void setVspace(double vspace)
          set the value vspace Vertical margin spacing above and below the grid control, in pixels.
 void setWidth(double width)
          set the value width Width value of the grid control, in pixels.
 
Methods inherited from class railo.runtime.ext.tag.BodyTagImpl
doAfterBody, setBodyContent
 
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
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

Grid

public Grid()
     throws TagNotSupported
constructor for the tag class

Throws:
TagNotSupported
Method Detail

release

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

setWidth

public void setWidth(double width)
set the value width Width value of the grid control, in pixels.

Parameters:
width - 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

setSort

public void setSort(boolean sort)
set the value sort If Yes, sort buttons are added to the grid control. When clicked, sort buttons perform a simple text sort on the selected column. Default is No. Note that columns are sortable by clicking the column head, even if no sort button is displayed.

Parameters:
sort - value to set

setColheaders

public void setColheaders(boolean colheaders)
set the value colheaders Yes or No. Yes displays column headers in the grid control. Default is Yes.

Parameters:
colheaders - value to set

setRowheadertextcolor

public void setRowheadertextcolor(String rowheadertextcolor)
set the value rowheadertextcolor Text color value for the grid control row headers. Entries are: black (default), magenta, cyan, orange, darkgray, pink, gray, white, lightgray, yellow. A hex value can be entered in the form: rowHeaderTextColor = "##xxxxxx" Where x is 0-9 or A-F. Use two pound signs or no pound signs.

Parameters:
rowheadertextcolor - value to set

setFont

public void setFont(String font)
set the value font Font to use for column data in the grid control.

Parameters:
font - value to set

setColheaderitalic

public void setColheaderitalic(boolean colheaderitalic)
set the value colheaderitalic Yes or No. Yes displays column header text in italic. Default is No.

Parameters:
colheaderitalic - value to set

setAutowidth

public void setAutowidth(boolean autowidth)
set the value autowidth Optional. Yes or No. Default is No. If Yes, automatically sets the width of each column so that all the columns are visible within the grid's specified width. All columns are initially set to equal widths. Users can resize any column. No horizontal scroll bars are available since all columns are visible. note that if you explicitly specify the width of a column and set autoWidth to Yes, CFML will set the column to the explicit width, if possible.

Parameters:
autowidth - value to set

setSelectcolor

public void setSelectcolor(String selectcolor)
set the value selectcolor Background color for a selected item. See bgColor for color options.

Parameters:
selectcolor - value to set

setHighlighthref

public void setHighlighthref(boolean highlighthref)
set the value highlighthref Yes highlights links associated with a cfgrid with an href attribute value. No disables highlight. Default is Yes.

Parameters:
highlighthref - value to set

setItalic

public void setItalic(boolean italic)
set the value italic Yes displays grid control text in italic. Default is No.

Parameters:
italic - value to set

setGridlines

public void setGridlines(boolean gridlines)
set the value gridlines Yes or No. Yes enables row and column rules (lines) in the grid control. No suppresses rules. Default is Yes.

Parameters:
gridlines - value to set

setPicturebar

public void setPicturebar(boolean picturebar)
set the value picturebar Yes or No. If Yes, images are used for the Insert, delete, and Sort buttons rather than text. Default is No.

Parameters:
picturebar - value to set

setDeletebutton

public void setDeletebutton(String deletebutton)
set the value deletebutton Text to use for the delete action button. The default is delete.

Parameters:
deletebutton - value to set

setTextcolor

public void setTextcolor(String textcolor)
set the value textcolor Color value for text in the grid control. Options are: black (default), magenta, cyan, orange, darkgray, pink, gray, white, lightgray, yellow. A hex value can be entered in the form: textColor = "##xxxxxx" where x is 0-9 or A-F. Use two pound signs or no pound signs.

Parameters:
textcolor - value to set

setInsertbutton

public void setInsertbutton(String insertbutton)
set the value insertbutton Text to use for the Insert action button. The default is Insert.

Parameters:
insertbutton - value to set

setRowheight

public void setRowheight(double rowheight)
set the value rowheight Number of pixels for the minimum row height of the grid control. Used with cfgridcolumn type = "Image", you can use rowHeight to define enough space for graphics to display in the row.

Parameters:
rowheight - value to set

setNotsupported

public void setNotsupported(String notsupported)
set the value notsupported Selection mode for items in the grid control.

Parameters:
notsupported - value to set

setFontsize

public void setFontsize(double fontsize)
set the value fontsize Font size for text in the grid control, in points.

Parameters:
fontsize - value to set

setRowheaderwidth

public void setRowheaderwidth(double rowheaderwidth)
set the value rowheaderwidth The width, in pixels, of the row header column.

Parameters:
rowheaderwidth - value to set

setOnerror

public void setOnerror(String onerror)
set the value onerror The name of a JavaScript function to execute in the event of a failed validation.

Parameters:
onerror - value to set

setTarget

public void setTarget(String target)
set the value target Target attribute for href URL.

Parameters:
target - value to set

setColheaderfont

public void setColheaderfont(String colheaderfont)
set the value colheaderfont Font for the column header in the grid control.

Parameters:
colheaderfont - value to set

setGriddataalign

public void setGriddataalign(String griddataalign)
set the value griddataalign Enter Left, Right, or Center to position data in the grid within a column. Default is Left.

Parameters:
griddataalign - value to set

setColheaderalign

public void setColheaderalign(String colheaderalign)
set the value colheaderalign Enter Left, Right, or Center to position data within a column header. Default is Left.

Parameters:
colheaderalign - value to set

setHeight

public void setHeight(double height)
set the value height Height value of the grid control, in pixels.

Parameters:
height - value to set

setQuery

public void setQuery(String query)
set the value query Name of the query associated with the grid control.

Parameters:
query - value to set

setMaxrows

public void setMaxrows(String maxrows)
set the value maxrows Specifies the maximum number of rows to display in the grid.

Parameters:
maxrows - value to set

setAlign

public void setAlign(String align)
set the value align Alignment value. Options are: Top, Left, Bottom, Baseline, Texttop, Absbottom, Middle, Absmiddle, Right.

Parameters:
align - value to set

setVspace

public void setVspace(double vspace)
set the value vspace Vertical margin spacing above and below the grid control, in pixels.

Parameters:
vspace - value to set

setInsert

public void setInsert(boolean insert)
set the value insert Yes lets end users insert row data into the grid. Default is No.

Parameters:
insert - value to set

setBgcolor

public void setBgcolor(String bgcolor)
set the value bgcolor Background color value for the grid control. Entries are: black, magenta, cyan, orange, darkgray, pink, gray, white, lightgray, yellow. A hex value can be entered in the form: bgColor = "##xxxxxx" where x is 0-9 or A-F. Use either two pound signs or no pound signs.

Parameters:
bgcolor - value to set

setAppendkey

public void setAppendkey(boolean appendkey)
set the value appendkey When used with href, Yes passes query string value of the selected tree item in the URL to the application page specified in the cfform action attribute. Default is Yes.

Parameters:
appendkey - value to set

setName

public void setName(String name)
set the value name A name for the grid element.

Parameters:
name - value to set

setSortascendingbutton

public void setSortascendingbutton(String sortascendingbutton)
set the value sortascendingbutton Text to use for the Sort button. Default is "A - Z".

Parameters:
sortascendingbutton - value to set

setRowheaderitalic

public void setRowheaderitalic(boolean rowheaderitalic)
set the value rowheaderitalic Yes or No. Yes displays row label text in italic. Default is No.

Parameters:
rowheaderitalic - value to set

setOnvalidate

public void setOnvalidate(String onvalidate)
set the value onvalidate The name of a JavaScript function used to validate user input. The form object, input object, and input object value are passed to the routine, which should return True if validation succeeds and False otherwise.

Parameters:
onvalidate - value to set

setHref

public void setHref(String href)
set the value href URL to associate with the grid item or a query column for a grid that is populated from a query. If href is a query column, the href value is populated by the query. If href is not recognized as a query column, it is assumed that the href text is an actual HTML href.

Parameters:
href - value to set

setColheaderbold

public void setColheaderbold(boolean colheaderbold)
set the value colheaderbold Yes or No. Yes displays column header text in boldface. Default is No.

Parameters:
colheaderbold - value to set

setDelete

public void setDelete(boolean delete)
set the value delete Yes lets end users delete row data from the grid. Default is No.

Parameters:
delete - value to set

setRowheaderfontsize

public void setRowheaderfontsize(double rowheaderfontsize)
set the value rowheaderfontsize Size for row label text in the grid control, in points.

Parameters:
rowheaderfontsize - value to set

setSelectmode

public void setSelectmode(String selectmode)
set the value selectmode Selection mode for items in the grid control.

Parameters:
selectmode - value to set

setRowheaderbold

public void setRowheaderbold(boolean rowheaderbold)
set the value rowheaderbold Yes or No. Yes displays row label text in boldface. Default is No.

Parameters:
rowheaderbold - value to set

setColheaderfontsize

public void setColheaderfontsize(double colheaderfontsize)
set the value colheaderfontsize Size for column header text in the grid control, in points.

Parameters:
colheaderfontsize - value to set

setRowheaderalign

public void setRowheaderalign(String rowheaderalign)
set the value rowheaderalign Enter Left, Right, or Center to position data within a row header. Default is Left.

Parameters:
rowheaderalign - value to set

setRowheaderfont

public void setRowheaderfont(String rowheaderfont)
set the value rowheaderfont Font to use for the row label.

Parameters:
rowheaderfont - value to set

setRowheaders

public void setRowheaders(boolean rowheaders)
set the value rowheaders Yes or No. Yes displays a column of numeric row labels in the grid control. Defaults to Yes.

Parameters:
rowheaders - value to set

setBold

public void setBold(boolean bold)
set the value bold Yes displays grid control text in boldface. Default is No.

Parameters:
bold - value to set

setColheadertextcolor

public void setColheadertextcolor(String colheadertextcolor)
set the value colheadertextcolor Color value for the grid control column headers. Valid entries are: black (default), magenta, cyan, orange, darkgray, pink, gray, white, lightgray, yellow.A hex value can be entered in the form: colHeaderTextColor = "##xxxxxx" where x is 0-9 or A-F. Use either two pound signs or no pound signs.

Parameters:
colheadertextcolor - value to set

setHspace

public void setHspace(double hspace)
set the value hspace Horizontal margin spacing to the left and right of the grid control, in pixels.

Parameters:
hspace - value to set

setSortdescendingbutton

public void setSortdescendingbutton(String sortdescendingbutton)
set the value sortdescendingbutton Text to use for the Sort button. Default is "Z - A".

Parameters:
sortdescendingbutton - value to set

setEnabled

public void setEnabled(boolean enabled)
Parameters:
enabled - the enabled to set

setFormat

public void setFormat(String format)
Parameters:
format - the format to set

setOnblur

public void setOnblur(String onblur)
Parameters:
onblur - the onblur to set

setOnchange

public void setOnchange(String onchange)
Parameters:
onchange - the onchange to set

setOnfocus

public void setOnfocus(String onfocus)
Parameters:
onfocus - the onfocus to set

setStyle

public void setStyle(String style)
Parameters:
style - the style to set

setTooltip

public void setTooltip(String tooltip)
Parameters:
tooltip - the tooltip to set

setVisible

public void setVisible(boolean visible)
Parameters:
visible - the visible to set

doStartTag

public int doStartTag()
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
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()

doInitBody

public void doInitBody()
Specified by:
doInitBody in interface javax.servlet.jsp.tagext.BodyTag
Overrides:
doInitBody in class BodyTagImpl
See Also:
BodyTag.doInitBody()

addRow

public void addRow(String[] data)

addColumn

public void addColumn(GridColumnBean column)


Copyright © 2012 Railo