com.ibm.as400.opnav
Class ColumnDescriptor

java.lang.Object
  |
  +--com.ibm.as400.opnav.ColumnDescriptor

public class ColumnDescriptor
extends java.lang.Object

A data entity which describes a column in a view of system objects. A ColumnDescriptor provides the text for the column heading and an ID which will be supplied to ListManager implementations when the data for the column is requested.

Since:
v4r4m0
See Also:
ListManager

Field Summary
static int ALIGN_CENTER
          Center the text in the column.
static int ALIGN_LEFT
          Left align the text in the column.
static int ALIGN_RIGHT
          Right align the text in the column.
 
Constructor Summary
ColumnDescriptor(java.lang.String heading, int width, int ID)
          Constructs a column descriptor.
ColumnDescriptor(java.lang.String heading, int width, int ID, int alignment)
          Constructs a column descriptor.
 
Method Summary
 int getAlignment()
          Returns the column alignment.
 int getDefaultWidth()
          Returns the initial column width.
 java.lang.String getHeading()
          Returns the column heading.
 int getID()
          Returns the column identifier.
 boolean getVisible()
          THIS METHOD IS CURRENTLY NOT SUPPORTED Returns whether this column should be displayed in the list pane.
 void setAlignment(int alignment)
          Sets the column alignment.
 void setDefaultWidth(int width)
          Sets the initial column width.
 void setHeading(java.lang.String heading)
          Sets the column heading.
 void setID(int ID)
          Sets the column identifier.
 void setVisible(boolean vis)
          THIS METHOD IS CURRENTLY NOT SUPPORTED Sets whether this column should be displayed in the list pane.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALIGN_LEFT

public static final int ALIGN_LEFT
Left align the text in the column.

ALIGN_RIGHT

public static final int ALIGN_RIGHT
Right align the text in the column.

ALIGN_CENTER

public static final int ALIGN_CENTER
Center the text in the column.
Constructor Detail

ColumnDescriptor

public ColumnDescriptor(java.lang.String heading,
                        int width,
                        int ID)
Constructs a column descriptor.
Parameters:
heading - the column heading in a form suitable for displaying to the user.
width - a suggested initial width for the column expressed in logical units.
ID - the identifier for the column which will be supplied when data for the column is requested.
Since:
v4r4m0

ColumnDescriptor

public ColumnDescriptor(java.lang.String heading,
                        int width,
                        int ID,
                        int alignment)
Constructs a column descriptor.
Parameters:
heading - the column heading in a form suitable for displaying to the user.
width - a suggested initial width for the column expressed in logical units.
ID - the identifier for the column which will be supplied when data for the column is requested.
alignment - the alignment of the text within the column.
Since:
v5r1m0
Method Detail

getHeading

public java.lang.String getHeading()
Returns the column heading.
Returns:
the column heading in a form suitable for displaying to the user.
Since:
v4r4m0
See Also:
setHeading(java.lang.String)

setHeading

public void setHeading(java.lang.String heading)
Sets the column heading.
Parameters:
heading - the column heading in a form suitable for displaying to the user.
Since:
v4r4m0
See Also:
getHeading()

getDefaultWidth

public int getDefaultWidth()
Returns the initial column width.
Returns:
a suggested initial width for the column; the number of characters that can be displayed in the column.
Since:
v4r4m0
See Also:
setDefaultWidth(int)

setDefaultWidth

public void setDefaultWidth(int width)
Sets the initial column width.
Parameters:
width - a suggested initial width for the column; the number of characters that can be displayed in the column.
Since:
v4r4m0
See Also:
getDefaultWidth()

getID

public int getID()
Returns the column identifier.
Returns:
the identifier for the column which will be supplied when data for the column is requested.
Since:
v4r4m0
See Also:
setID(int)

setID

public void setID(int ID)
Sets the column identifier.
Parameters:
ID - the identifier for the column which will be supplied when data for the column is requested.
Since:
v4r4m0
See Also:
getID()

getAlignment

public int getAlignment()
Returns the column alignment.
Returns:
the alignment of the text in the column.
Since:
v5r1m0
See Also:
setAlignment(int)

setAlignment

public void setAlignment(int alignment)
Sets the column alignment.
Parameters:
ID - the alignment of the text in the column.
Since:
v5r1m0
See Also:
getAlignment()

getVisible

public boolean getVisible()
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns whether this column should be displayed in the list pane.
Returns:
whether this column is to be displayed.
Since:
v5r1m0
See Also:
setVisible(boolean)

setVisible

public void setVisible(boolean vis)
THIS METHOD IS CURRENTLY NOT SUPPORTED Sets whether this column should be displayed in the list pane. The default value is true.
Parameters:
ID - whether this column is to be displayed.
Since:
v5r1m0
See Also:
getVisible()

toString

public java.lang.String toString()
Returns a string representation of the object.
Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object.
Since:
v4r4m0