com.retek.commons.gui.table
Class ColumnProperties

java.lang.Object
  extended bycom.retek.commons.gui.table.ColumnProperties

public class ColumnProperties
extends java.lang.Object

COLUMN PROPERTIES


Constructor Summary
ColumnProperties()
           
 
Method Summary
 java.awt.Color getBackground()
          Retrieves the background color property of the column.
 javax.swing.ButtonGroup getButtonGroup()
          Retrieves the button group property of the column.
 java.lang.String getColumnCommand()
          Retrieves the action command property of the column.
 java.lang.String getColumnIcon()
          Retrieve the filename of the icon assigned to the column properties.
 Mask getColumnMask()
          Retrieves the mask of the column properties.
 int getColumnType()
          Retrieves the column type of the column.
 FormatValidator getColumnValidator()
          Retrieves the mask of the column properties.
 int getColumnWidth()
          Retrieves the width of the column properties.
 java.lang.String getComponentName()
          Retrieves the component name of the column properties.
 int getComponentType()
          Retrieves the display type of the column properties.
 java.awt.Font getFont()
          Retrieves the font property of the column.
 java.awt.Color getForeground()
          Retrieves the foreground color property of the column.
 int getJustification()
          Retrieves the justification of the column.
 void setBackground(java.awt.Color background)
          Assigns background color property to the column.
 void setButtonGroup(javax.swing.ButtonGroup group)
          Assigns the button group property of the column.
 void setColumnCommand(java.lang.String command)
          Assigns a column command to the column properties.
 void setColumnIcon(java.lang.String filename)
          Assigns an icon in the column properties by filename.
 void setColumnMask(Mask mask)
          Assigns a mask in the column properties.
 void setColumnType(int columnType)
          Assigns the column type to the column.
 void setColumnValidator(FormatValidator validator)
          Assigns a validator in the column properties.
 void setColumnWidth(int width)
          Assigns the width in the column properties.
 void setComponentName(java.lang.String name)
          Assigns the component name for the components displayed in the column.
 void setComponentType(int type)
          Assigns the display type in the column properties.
 void setFont(java.awt.Font font)
          Assigns font property to the column.
 void setForeground(java.awt.Color foreground)
          Assigns foreground color property to the column.
 void setJustification(int justification)
          Assigns the justification to the column.
 java.lang.String toString()
          Returns string describing this column properties.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ColumnProperties

public ColumnProperties()
Method Detail

setComponentName

public void setComponentName(java.lang.String name)
Assigns the component name for the components displayed in the column.

Parameters:
name - The name to assign to the components within the column.

getComponentName

public java.lang.String getComponentName()
Retrieves the component name of the column properties.

Returns:
The component name of the column properties.

setComponentType

public void setComponentType(int type)
Assigns the display type in the column properties.

Parameters:
type - The display type to assign to the column properties.
Throws:
java.lang.IllegalArgumentException - Thrown if the display type is outside of the valid type range.

getComponentType

public int getComponentType()
Retrieves the display type of the column properties.

Returns:
The display type of the column properties.

setColumnType

public void setColumnType(int columnType)
Assigns the column type to the column. The column type represents a data type and determines how the column is sorted. The default value is TEXT. Assigning a column type of number will reset the justification to right for the column regardless of any previous justification that has been assigned.

Parameters:
columnType - The column type to assign to the column (TEXT, NUMBER, DATE, or BOOLEAN).

getColumnType

public int getColumnType()
Retrieves the column type of the column.

Returns:
The column type of the column.

setColumnWidth

public void setColumnWidth(int width)
Assigns the width in the column properties. Values less than zero are converted to zero.

Parameters:
width - The width to assign to the column properties.

getColumnWidth

public int getColumnWidth()
Retrieves the width of the column properties.

Returns:
The width of the column properties.

setColumnMask

public void setColumnMask(Mask mask)
Assigns a mask in the column properties.

Parameters:
mask - The mask to assign to the column properties.

getColumnMask

public Mask getColumnMask()
Retrieves the mask of the column properties.

Returns:
The mask of the column properties.

setColumnValidator

public void setColumnValidator(FormatValidator validator)
Assigns a validator in the column properties.

Parameters:
validator - The validator to assign to the column properties.

getColumnValidator

public FormatValidator getColumnValidator()
Retrieves the mask of the column properties.

Returns:
The mask of the column properties.

setJustification

public void setJustification(int justification)
Assigns the justification to the column. The default value is LEFT.

Parameters:
justification - The justification to assign to the column (LEFT, CENTER, or RIGHT).

getJustification

public int getJustification()
Retrieves the justification of the column.

Returns:
The justification of the column.

setColumnIcon

public void setColumnIcon(java.lang.String filename)
Assigns an icon in the column properties by filename. The filename need to exist in the local classpath. Failure to build an icon will result in an "I" being displayed.

Parameters:
filename - The filename of an icon in the local system classpath.

getColumnIcon

public java.lang.String getColumnIcon()
Retrieve the filename of the icon assigned to the column properties.

Returns:
The filename of the icon assigned to the column properties.

setForeground

public void setForeground(java.awt.Color foreground)
Assigns foreground color property to the column.

Parameters:
foreground - The foreground color.

getForeground

public java.awt.Color getForeground()
Retrieves the foreground color property of the column.

Returns:
The foreground color property of the column.

setBackground

public void setBackground(java.awt.Color background)
Assigns background color property to the column.

Parameters:
background - The background color.

getBackground

public java.awt.Color getBackground()
Retrieves the background color property of the column.

Returns:
The background color property of the column.

setFont

public void setFont(java.awt.Font font)
Assigns font property to the column.

Parameters:
font - The font to assign to the column.

getFont

public java.awt.Font getFont()
Retrieves the font property of the column.

Returns:
The font property of the column.

setButtonGroup

public void setButtonGroup(javax.swing.ButtonGroup group)
Assigns the button group property of the column.


getButtonGroup

public javax.swing.ButtonGroup getButtonGroup()
Retrieves the button group property of the column.

Returns:
The button group property of the column.

setColumnCommand

public void setColumnCommand(java.lang.String command)
Assigns a column command to the column properties.

Parameters:
command - The command to assign to the column properties.

getColumnCommand

public java.lang.String getColumnCommand()
Retrieves the action command property of the column.

Returns:
The action command property of the column.

toString

public java.lang.String toString()
Returns string describing this column properties.



Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25