org.opengts.war.report
Class ReportColumn

java.lang.Object
  org.opengts.war.report.ReportColumn

public class ReportColumn
extends java.lang.Object

Constructor Summary

ReportColumn(java.lang.String key, java.lang.String arg, I18N.Text title)
Constructor

ReportColumn(java.lang.String key, java.lang.String arg, int colSpan, I18N.Text title)
Constructor

Method Summary

java.lang.String	getArg() Gets the column arguments/parameters
java.lang.String	getBlankFiller() Gets the value to use as a blank-value for this column
int	getColSpan() Gets the column span value
java.lang.String	getKey() Gets the column name(key) Same as getName()
java.lang.String	getName() Gets the column name(key) Same as getKey()
java.lang.String	getTitle(java.util.Locale loc, java.lang.String dft) Gets the localized column title
boolean	isSortable() Gets the sortable flag for this column
boolean	isVisible(BasicPrivateLabel bpl) Returns true if this column is visible
void	setBlankFiller(java.lang.String filler) Sets the value to use as a blank-value for this column
void	setColumnConditional(ReportConditional colCond) Sets the column conditional value
void	setSortable(boolean sortable) Sets the sortable flag for this column
java.lang.String	toString() Returns the String representation of this column

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportColumn

public ReportColumn(java.lang.String key,
                    java.lang.String arg,
                    I18N.Text title)

Constructor

Parameters:

key - Report column name

arg - Report column parameters

title - Report column title

ReportColumn

public ReportColumn(java.lang.String key,
                    java.lang.String arg,
                    int colSpan,
                    I18N.Text title)

Constructor

Parameters:

key - Report column name

arg - Report column parameters

colSpan - Number of columns spanned by this column title

title - Report column title

Method Detail

getName

public java.lang.String getName()

Gets the column name(key)
Same as getKey()

Returns:

The column name/key

See Also:

getKey()

getKey

public java.lang.String getKey()

Gets the column name(key) Same as getName()

Returns:

The column name/key

See Also:

getName()

getArg

public java.lang.String getArg()

Gets the column arguments/parameters

Returns:

The column arguments/parameters (as a String)

getColSpan

public int getColSpan()

Gets the column span value

Returns:

The column span value

getTitle

public java.lang.String getTitle(java.util.Locale loc,
                                 java.lang.String dft)

Gets the localized column title

Parameters:

loc - The Locale

dft - The default title to return if no column title defined

Returns:

The localized column title

setSortable

public void setSortable(boolean sortable)

Sets the sortable flag for this column

Parameters:

sortable - True if column is sortable, false otherwise

isSortable

public boolean isSortable()

Gets the sortable flag for this column

Returns:

True if column is sortable, false otherwise

setBlankFiller

public void setBlankFiller(java.lang.String filler)

Sets the value to use as a blank-value for this column

Parameters:

filler - The value to use as a blank-value for this column

getBlankFiller

public java.lang.String getBlankFiller()

Gets the value to use as a blank-value for this column

Returns:

The value to use as a blank-value for this column

setColumnConditional

public void setColumnConditional(ReportConditional colCond)

Sets the column conditional value

Parameters:

colCond - The column conditional value

isVisible

public boolean isVisible(BasicPrivateLabel bpl)

Returns true if this column is visible

Parameters:

bpl - The BasicPrivateLabel context

Returns:

True if this column is visible, false otherwise

toString

public java.lang.String toString()

Returns the String representation of this column

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this column