com.groiss.gui.table
Class ColumnDescription

java.lang.Object
  com.groiss.gui.table.ColumnDescription

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ColumnDescription
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class represents the description of a column within a table, i.e. it defines the properties for a column like its name or if the column is visible by default. It depends on the table implementation if all properties are interpreted.

See Also:

Serialized Form

Constructor Summary

ColumnDescription(java.lang.String id, java.lang.Object name)
Creates a new column description.

ColumnDescription(java.lang.String id, java.lang.Object name, java.lang.String description, boolean visible, boolean editable, boolean edit)
Creates a new column description.

Method Summary

protected java.lang.Object	clone()
java.lang.String	getDescription() Returns the description.
java.lang.String	getId() Returns the id.
java.lang.Object	getName() Returns the name.
boolean	isEdit() Return true if this column can be edited, false otherwise.
boolean	isEditable() Returns true if direct editing is possible for this column, false otherwise.
boolean	isFiltered() Returns true if this column is used in a filter.
boolean	isVisible() Returns true if this column should be visible, false otherwise.
void	setDescription(java.lang.String description) Sets the description.
void	setEdit(boolean edit) Sets if this column can be edited.
void	setEditable(boolean editable) Sets if direct editing should be possible for this column.
void	setFiltered(boolean filtered)
void	setId(java.lang.String id) Sets the id.
void	setName(java.lang.Object name) Sets the name.
void	setVisible(boolean visible) Sets if this column will be visible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnDescription

public ColumnDescription(java.lang.String id,
                         java.lang.Object name)

Creates a new column description.

Parameters:

id - the id of the column for referencing it

name - the name for showing it in table header and column picker

ColumnDescription

public ColumnDescription(java.lang.String id,
                         java.lang.Object name,
                         java.lang.String description,
                         boolean visible,
                         boolean editable,
                         boolean edit)

Creates a new column description.

Parameters:

id - the id of the column for referencing it

name - the name for showing it in table header and column picker

description - the description which will be used as tooltip text in the column picker

visible - if true the column is visible by default, otherwise it is invisible

editable - if true the column allows direct editing, otherwise not

edit - if true the column can be edited directly, otherwise not

Method Detail

setId

public void setId(java.lang.String id)

Sets the id.

Parameters:

id - the id to set

getId

public java.lang.String getId()

Returns the id.

Returns:

the id

setName

public void setName(java.lang.Object name)

Sets the name.

Parameters:

name - the name to set

getName

public java.lang.Object getName()

Returns the name.

Returns:

the name

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the description to set

getDescription

public java.lang.String getDescription()

Returns the description.

Returns:

the description

setVisible

public void setVisible(boolean visible)

Sets if this column will be visible.

Parameters:

visible - pass true if the column should be visible, false otherwise

isVisible

public boolean isVisible()

Returns true if this column should be visible, false otherwise.

isFiltered

public boolean isFiltered()

Returns true if this column is used in a filter.

setFiltered

public void setFiltered(boolean filtered)

setEditable

public void setEditable(boolean editable)

Sets if direct editing should be possible for this column.

Parameters:

editable - pass ture if editing should be possible, false otherwise

isEditable

public boolean isEditable()

Returns true if direct editing is possible for this column, false otherwise.

Returns:

the editable

setEdit

public void setEdit(boolean edit)

Sets if this column can be edited.

Parameters:

edit - pass true if this column can be edited, false otherwise

isEdit

public boolean isEdit()

Return true if this column can be edited, false otherwise.

Returns:

the edit

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException