oracle.dss.dataView

Class EdgeRangeComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.EdgeRangeComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class EdgeRangeComponentHandle
extends ComponentHandle

Represents a range of cells in a GridView edge component and provides information about the range.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

Constructors

Constructor and Description
EdgeRangeComponentHandle(int id, java.lang.String name, java.lang.Object comp, EdgeComponentInfo[] elist) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ComponentInfo	getComponentInfo() Retrieves the EdgeComponentInfo for the first cell in the range.
EdgeComponentInfo[]	getLocationList() Retrieves the array of EdgeComponentInfo objects for the range of cells.
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

EdgeRangeComponentHandle

public EdgeRangeComponentHandle(int id,
                                java.lang.String name,
                                java.lang.Object comp,
                                EdgeComponentInfo[] elist)

Constructor.

Parameters:

id - A constant, such as GridView.ROW_HEADER_RANGE, that identifies the items that this EdgeRangeComponentHandle represents. Constants are defined in the GridView class.

name - The name of the represented component.

comp - The actual reference to the header component.

elist - Information about each cell in the range.

Method Detail

getLocationList

public EdgeComponentInfo[] getLocationList()

Retrieves the array of EdgeComponentInfo objects for the range of cells. The array contains an EdgeComponentInfo for each cell in the range.

Returns:

An array of EdgeComponentInfo 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 cells in the range, the edge number, depth, and index of the first cell, and the edge number, depth, and index of the last cell in the range. For the edge number, zero is the column edge, 1 is the row edge, and 2 is the page edge.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the EdgeComponentInfo for the first cell in the range.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

The EdgeComponentInfo for the first cell in the range. This EdgeComponentInfo can be null, though this is not normal.

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 EdgeRangeComponentHandle.