oracle.dss.dataView
Class NonDataIndexComponentHandle

java.lang.Object
  |
  +--oracle.dss.dataView.ComponentHandle
        |
        +--oracle.dss.dataView.NonDataIndexComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class NonDataIndexComponentHandle

extends ComponentHandle

Represents a component that does not display data but has an index and an axis associated with it. The ComponentHandle for a reference line component in a graph is a NonDataIndexComponentHandle.

See Also:

BaseReferenceLine, Serialized Form

Constructor Summary

NonDataIndexComponentHandle(int id, java.lang.String name, java.lang.Object comp, int index, int axisID)
Constructor.

Method Summary

int	getAxis() Retrieves the axis to which the component belongs.
ComponentInfo	getComponentInfo() Returns null.
int	getIndex() Retrieves the index of the component.
java.lang.String	toString() Generates a String representation of this object.

Methods inherited from class oracle.dss.dataView.ComponentHandle

getComponent, getID, getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NonDataIndexComponentHandle

public NonDataIndexComponentHandle(int id,
                                   java.lang.String name,
                                   java.lang.Object comp,
                                   int index,
                                   int axisID)

Constructor.

Parameters:

id - A constant, such as Graph.REFERENCE_LINE, that identifies the component that this NonDataIndexComponentHandle represents.

name - The name of the represented component.

comp - The actual reference to the component.

index - The index of the component.

axisID - A constant that identifies axis to which the component belongs.

Method Detail

toString

public java.lang.String toString()

Generates a String representation of this object. The String contains the name of this class and the name of the represented component.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Returns null. This method is implemented to provide a concrete implementation of the abstract method in the superclass. Because components that do not represent data do not have any ComponentInfo objects associated with them, this method returns null.

Overrides:

getComponentInfo in class ComponentHandle

Returns:

null.

getIndex

public int getIndex()

Retrieves the index of the component. For reference lines, this method returns the index of the selected line. Valid indexes are 0, 1, and 2.

Returns:

The index of the component.

getAxis

public int getAxis()

Retrieves the axis to which the component belongs.

Returns:

A constant that indicates the axis to which the component belongs. Valid constants are listed in the See Also section.

See Also:

Graph.X1AXIS, Graph.Y1AXIS, Graph.Y2AXIS