com.crystaldecisions.sdk.occa.report.gridcontent
Class GridColumn

java.lang.Object
  |
  +--com.crystaldecisions.sdk.occa.report.gridcontent.GridColumn

public class GridColumn

extends java.lang.Object

The GridColumn class allows you to modify the individual grid columns that appear in the GridViewer. A GridColumnCollection class also exists that is used as a container for the GridColumn class.

Constructor Summary

GridColumn()

GridColumn(java.lang.String fieldName)

Method Summary

CrColumnVisibilityEnum	getColumnVisibility() Returns the visibility of the column.
java.lang.String	getFieldName() Returns the column's field name.
java.lang.String	getFormatPattern() Returns the format pattern of the column values.
int	getGroupLevel() Returns the group level for the main report or the subreport.
java.lang.String	getHeading() Returns the column heading.
java.lang.String	getStyleClassName() Returns the style class name of the column.
void	setColumnVisibility(CrColumnVisibilityEnum newColumnVisibility) Sets the visibility of the column based on the view mode.
void	setFieldName(java.lang.String newFieldName) Sets the field name of the column.
void	setFormatPattern(java.lang.String newFormatPattern) Sets the format pattern of the column values.
void	setGroupLevel(int newGroupLevel) Sets the group level for the main report or subreport.
void	setHeading(java.lang.String heading) Sets the column heading.
void	setStyleClassName(java.lang.String newStyleClassName) Sets the style class name of the column.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridColumn

public GridColumn()

GridColumn

public GridColumn(java.lang.String fieldName)

Method Detail

getColumnVisibility

public CrColumnVisibilityEnum getColumnVisibility()

Returns the visibility of the column.

Returns:

a CrColumnVisibilityEnum specifying the visibility of the column (0 = Flat, 1 = Group, 2 = All)

See Also:

setColumnVisibility

getFieldName

public java.lang.String getFieldName()

Returns the column's field name. The field name is the field (for example, a database field) that the column represents.

Returns:

the field name of the column as a String

See Also:

setFieldName

getFormatPattern

public java.lang.String getFormatPattern()

Returns the format pattern of the column values.

Returns:

the format pattern as a String

See Also:

setFormatPattern

getGroupLevel

public int getGroupLevel()

Returns the group level for the main report or the subreport.

Note: This property is only used when the ColumnVisibility property is set to group. It determines how far a user needs to drill down before the column is visible.

Returns:

the group level as an int

See Also:

setGroupLevel

getStyleClassName

public java.lang.String getStyleClassName()

Returns the style class name of the column. The style class name defines the CSS style class to be applied to each item in the column.

Returns:

the style class name of the column as a String

See Also:

setStyleClassName

setColumnVisibility

public void setColumnVisibility(CrColumnVisibilityEnum newColumnVisibility)

Sets the visibility of the column based on the view mode. For example, if the view mode is Flat and ColumnVisibility is set to Group, then the column will not be visible.

Parameters:

newColumnVisibility - a constant that specifies the visibility of the column as a CrColumnVisibilityEnum (0 = Flat, 1 = Group, 2 = All)

See Also:

getColumnVisibility

setFieldName

public void setFieldName(java.lang.String newFieldName)

Sets the field name of the column. The field name is the field (for example, a database field) that the column represents.

Parameters:

newFieldName - a String that specifies the field name of the column

See Also:

getFieldName

setFormatPattern

public void setFormatPattern(java.lang.String newFormatPattern)

Sets the format pattern of the column values.

Parameters:

newFormatPattern - a String that specifies the format pattern of the column

See Also:

getFormatPattern

setGroupLevel

public void setGroupLevel(int newGroupLevel)

Sets the group level for the main report or subreport.

Note: This property is only used when the ColumnVisibility property is set to group. It determines how far a user needs to drill down before the column is visible.

Parameters:

newGroupLevel - an int that specifies the group level of the column

See Also:

getGroupLevel

setStyleClassName

public void setStyleClassName(java.lang.String newStyleClassName)

Sets the style class name of the column. The style class name defines the CSS style class to be applied to each item in the column.

Parameters:

newStyleClassName - a string that specifies the style class name of the column

See Also:

getStyleClassName

getHeading

public java.lang.String getHeading()

Returns the column heading. The heading is the title given to the column.

Returns:

the column heading as a String

See Also:

setHeading

setHeading

public void setHeading(java.lang.String heading)

Sets the column heading. The heading is the title given to the column.

Parameters:

heading - the column heading as a String

See Also:

getHeading