com.retek.commons.gui.table
Class RowProperties

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

public class RowProperties
extends java.lang.Object

ROW PROPERTIES


Constructor Summary
RowProperties()
           
 
Method Summary
 java.awt.Color getBackground()
          Retrieves the background color property of the row.
 int getColumnCount()
          Retrieves the number of columns in the row.
 int getColumnGap()
          Retrieves the column gap between each column of the row.
 ColumnProperties getColumnProperties(int column)
          Retrieves the ColumnProperties object for the specifiec column.
 java.awt.Font getFont()
          Retrieves the font property of the row.
 java.awt.Color getForeground()
          Retrieves the foreground color property of the row.
 int getIndentation()
          Retrieves the number of pixels that the row will be indented when displayed.
 int getLevel()
          Retrieves the level of the row property.
 int getRowHeight()
          Retrieves the row height of the row.
 WidgetManager getWidgetManager()
          Retrieves the widget manager property of the row.
 void setBackground(java.awt.Color background)
          Assigns background color property to the row.
 void setColumnCount(int count)
          Assigns the number of columns to the row properties.
 void setColumnGap(int gap)
          Assigns the column gap in pixels to place between the data in each column.
 void setColumnWidths(int[] columnWidths)
          Assigns the column widths to all the columns within the row.
 void setDefaultBackground(java.awt.Color background)
          Assigns default background color property to the row.
 void setDefaultFont(java.awt.Font font)
          Assigns the default font property of the row.
 void setDefaultForeground(java.awt.Color foreground)
          Assigns default foreground color property to the row.
 void setFont(java.awt.Font font)
          Assigns the font property of the row.
 void setForeground(java.awt.Color foreground)
          Assigns foreground color property to the row.
 void setIndentation(int indentation)
          Assigns an indentation (in pixels) to indent this row in the table.
 void setLevel(int level)
          Assigns a level to the row properties.
 void setRowHeight(int height)
          Assigns the row height for the row.
 void setWidgetManager(WidgetManager manager)
          Assigns the widget manager property of the row.
 java.lang.String toString()
          Returns string describing this row properties.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RowProperties

public RowProperties()
Method Detail

setLevel

public void setLevel(int level)
Assigns a level to the row properties.


getLevel

public int getLevel()
Retrieves the level of the row property. Level 0 is a primary row whereas 1 thru whatever is sub-row types of the primary row.

Returns:
The level of the row property.

setColumnCount

public void setColumnCount(int count)
Assigns the number of columns to the row properties. This method will create new ColumnProperty Objects for each column. Calling this after the RowProperties object is created will remove all earlier column properties.

Parameters:
count - The number of columns to assign to the row properties.

getColumnCount

public int getColumnCount()
Retrieves the number of columns in the row.

Returns:
The number of columns in the row.

setRowHeight

public void setRowHeight(int height)
Assigns the row height for the row.

Parameters:
height - The height (in pixels).

getRowHeight

public int getRowHeight()
Retrieves the row height of the row.

Returns:
The row height.

getColumnProperties

public ColumnProperties getColumnProperties(int column)
Retrieves the ColumnProperties object for the specifiec column.

Parameters:
column - The column number (beginning at 0) of the column.
Returns:
A ColumnProperties object containing information for the specified column.
Throws:
java.lang.IllegalArgumentException - Thrown if the column is out of range.

setColumnWidths

public void setColumnWidths(int[] columnWidths)
Assigns the column widths to all the columns within the row. The index into the array of the column widths is the same index used to determine which ColumnProperty is to have the width assigned that is located in the array.


setIndentation

public void setIndentation(int indentation)
Assigns an indentation (in pixels) to indent this row in the table.

Parameters:
indentation - The number of pixels to indent the row.

getIndentation

public int getIndentation()
Retrieves the number of pixels that the row will be indented when displayed.

Returns:
The number of pixels that the row will be indented when displayed.

setColumnGap

public void setColumnGap(int gap)
Assigns the column gap in pixels to place between the data in each column.

Parameters:
gap - The gap in pixels.

getColumnGap

public int getColumnGap()
Retrieves the column gap between each column of the row.

Returns:
The gap between each column of the row.

setDefaultForeground

public void setDefaultForeground(java.awt.Color foreground)
Assigns default foreground color property to the row. The default color is returned when a specific row color is not assigned.

Parameters:
foreground - The foreground color.

setForeground

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

Parameters:
foreground - The foreground color.

getForeground

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

Returns:
The foreground color property of the row.

setDefaultBackground

public void setDefaultBackground(java.awt.Color background)
Assigns default background color property to the row. The default color is returned when a specific row color is not assigned.

Parameters:
background - The background color.

setBackground

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

Parameters:
background - The background color.

getBackground

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

Returns:
The background color property of the row.

setDefaultFont

public void setDefaultFont(java.awt.Font font)
Assigns the default font property of the row.

Parameters:
font - The default font property of the row.

setFont

public void setFont(java.awt.Font font)
Assigns the font property of the row.

Parameters:
font - The font property to assign to the row.

getFont

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

Returns:
The font property of the row.

setWidgetManager

public void setWidgetManager(WidgetManager manager)
Assigns the widget manager property of the row.

Parameters:
manager - The widget manager.

getWidgetManager

public WidgetManager getWidgetManager()
Retrieves the widget manager property of the row.

Returns:
The widget manager property of the row.

toString

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



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