oracle.dss.dataView

Class ColumnRangeComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.ColumnRangeComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class ColumnRangeComponentHandle
extends ComponentHandle

Represents a range of columns in the databody of a Gridview. This is normally a selected range, or the range of columns that you want to select programmatically.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

Constructors

Constructor and Description
ColumnRangeComponentHandle(int id, java.lang.String name, java.lang.Object comp, ColumnComponentInfo[] clist) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ComponentInfo	getComponentInfo() Retrieves the ColumnComponentInfo for the first column in the range that this ColumnRangeComponentHandle.
ColumnComponentInfo[]	getLocationList() Retrieves the array of ColumnComponentInfo objects for this ColumnRangeComponentHandle.
java.lang.String	toString() Converts this object to a String.

Methods inherited from class oracle.dss.dataView.ComponentHandle

getComponent, getID, getName, setDataAccess

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnRangeComponentHandle

public ColumnRangeComponentHandle(int id,
                                  java.lang.String name,
                                  java.lang.Object comp,
                                  ColumnComponentInfo[] clist)

Constructor.

Parameters:

id - The constant GridView.DATA_COLUMN_RANGE, which identifies this as a handle for a range of columns.

name - The name of the represented component.

comp - The actual reference to the component.

clist - Information about each column in the range. The first ColumnComponentInfo should be for the first column in the range.

Method Detail

getLocationList

public ColumnComponentInfo[] getLocationList()

Retrieves the array of ColumnComponentInfo objects for this ColumnRangeComponentHandle. The array contains a ColumnComponentInfo for each column in the represented range.

Returns:

An array of ColumnComponentInfo objects.

toString

public java.lang.String toString()

Converts this object to a String. The String contains the name of this class, the name of the component, the number of columns in the range, and the numbers of the first and last column in the range. Column numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the ColumnComponentInfo for the first column in the range that this ColumnRangeComponentHandle.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

The ColumnComponentInfo for the first column. The ColumnComponentInfo can be null.

See Also:

DataComponentHandle

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ComponentHandle

For internal use only. Application developers should not use this

Indicates whether the specified object is equivalent to this ColumnRangeComponentHandle.