org.apache.tapestry5.corelib.components
Class GridColumns

java.lang.Object
  extended by org.apache.tapestry5.corelib.components.GridColumns

@SupportsInformalParameters
@Events(value="inplaceupdate (internal event)")
public class GridColumns
extends Object

Renders out the column headers for the grid, including links (where appropriate) to control column sorting.

Component Parameters
NameDescriptionTypeFlagsDefaultDefault PrefixSince
gridModelThe object that provides access to bean and data models, which is typically the enclosing Grid component.org.apache.tapestry5.grid.GridModelcomponentResources.containerprop
indexOptional output parameter that stores the current column index.intprop
leanIf true, then the CSS class on each TH element will be omitted, which can reduce the amount of output from the component overall by a considerable amount. Leave this as false, the default, when you are leveraging the CSS to customize the look and feel of particular columns.booleanprop
overridesWhere to look for informal parameter Blocks used to override column headers. The default is to look for such overrides in the GridColumns component itself, but this is usually overridden.org.apache.tapestry5.PropertyOverridesthisprop
zoneIf not null, then each link is output as a link to update the specified zone.Stringprop

Events:

inplaceupdate
(internal event)

Constructor Summary
GridColumns()
           
 
Method Summary
 Block getBlockForColumn()
           
 Object getColumnContext()
           
 List<String> getColumnNames()
           
 String getHeaderClass()
           
 Asset getIcon()
           
 String getIconLabel()
           
 String getSortLinkClass()
           
 boolean isActiveSortColumn()
           
 boolean isSortDisabled()
           
 void setColumnName(String columnName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridColumns

public GridColumns()
Method Detail

isSortDisabled

public boolean isSortDisabled()

getSortLinkClass

public String getSortLinkClass()

getHeaderClass

public String getHeaderClass()

isActiveSortColumn

public boolean isActiveSortColumn()

getIcon

public Asset getIcon()

getColumnContext

public Object getColumnContext()

getIconLabel

public String getIconLabel()

getColumnNames

public List<String> getColumnNames()

setColumnName

public void setColumnName(String columnName)

getBlockForColumn

public Block getBlockForColumn()


Copyright © 2003-2012 The Apache Software Foundation.