borland.jbcl Packages  borland.jbcl Class Hierarchy  borland.jbcl.dataset 

PickListDescriptor class

java.lang.Object
   +----borland.jbcl.dataset.PickListDescriptor

About the PickListDescriptor class

Constructors  Properties  Methods  
The PickListDescriptor describes a pick list relationship between a Column of one DataSet, and a second DataSet that provides values from which you can choose. The PickListDescriptor is a property setting of a Column component.

The DataSet that contains the items to display in the pick list is specified in the pickListDataSet property. The pickListDisplayColumns property describes the columns of that DataSet that are shown in the pick list.

Any control that follows the JBCL model-view architecture uses the PickListItemEditor as its itemEditor by default when this property is set. JBCL model-view controls include:

Although the pickListDisplayColumns parameter is an array of String names of Column components to display, the PickListItemEditor can only display a single Column in the pick list. To display multiple columns in a pick list, create a custom ItemEditor class and set the itemEditor property to your custom class.

Once a row is selected, the values of the pickListColumns in the pickListDataset are copied into the destinationColumns of this DataSet.

For more information on pick lists, see the pickList property of the Column component. For examples of pick lists in an application, see Looking up choices with a pick list in the Database Application Developer's Guide.


PickListDescriptor constructors

PickListDescriptor properties

*Read-only properties **Write-only properties

Properties implemented in this class

Properties implemented in java.lang.Object

PickListDescriptor methods

Methods implemented in java.lang.Object


PickListDescriptor constructors

PickListDescriptor(borland.jbcl.dataset.DataSet, java.lang.String[], java.lang.String[], java.lang.String[], boolean)

  public PickListDescriptor(borland.jbcl.dataset.DataSet pickListDataSet, java.lang.String[] pickListColumns, java.lang.String[] pickListDisplayColumns, java.lang.String[] destinationColumns, boolean enforceIntegrity)
Constructs a PickListDescriptor object with the properties stated in its parameters.

Parameters:

pickListDataSet
The DataSet object that contains the data for display in the pick list.
pickListColumns
The columns of the pickListDataSet from which values in the selected row are copied to the destinationColumns.
pickListDisplayColumns
The Column components of the DataSet to display in the pick list. This property is expressed as an array of String names.
destinationColumns
The Column components that are populated with the values associated with the selected pick list choice. This property is expressed as an array of String column names.
enforceIntegrity
Whether to enforce data integrity rules (data constraints) on the data added to the destinationColumns.

PickListDescriptor properties

destinationColumns

 public final String[] getDestinationColumns()
Read-only property that returns the String names of the Column components that are filled in when an entry in the pick list is selected. Set this property using the PickListDescriptor constructor.

enforceIntegrity

 public boolean isEnforceIntegrity()
Read-only property that returns whether to enforce data integrity rules (data constraints) on the data added to the destinationColumns. Set this property using the PickListDescriptor constructor.

pickListColumns

 public final String[] getPickListColumns()
Read-only property that returns the Column components to read from when filling in data from the pickListDataSet into the columns specified in the destinationColumns property. Set this property using the PickListDescriptor constructor.

pickListDataSet

 public final DataSet getPickListDataSet()
Read-only property that returns the pickListDataSet used to choose values from. Set this property using the PickListDescriptor constructor.

pickListDisplayColumns

 public final String[] getPickListDisplayColumns()
Read-only property that reuturns a String array of the Column names to display from the pickListDataSet. Set this property using the PickListDescriptor constructor.