oracle.dss.dataView
Class PageItemComponentHandle

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

All Implemented Interfaces:

java.io.Serializable

public class PageItemComponentHandle

extends ComponentHandle

Represents an item in the paging component in a Dataview, and provides information about the page that it represents. A page item is an item in a paging control. Each item shows information about a dimension on the page edge of a Dataview.

See Also:

Serialized Form

Constructor Summary

PageItemComponentHandle(int id, java.lang.String name, java.lang.Object comp, int pageItem)
Constructor.

Method Summary

ComponentInfo	getComponentInfo() Retrieves the PageItemComponentInfo for the page item that this PageItemComponentHandle represents.
int	getPageItem() Retrieves the number of the page item.
java.lang.String	toString() Converts this object to a String.

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

PageItemComponentHandle

public PageItemComponentHandle(int id,
                               java.lang.String name,
                               java.lang.Object comp,
                               int pageItem)

Constructor.

Parameters:

id - A constant, such as Dataview.PAGE_ITEM, that identifies the page item that this PageItemComponentHandle represents.

name - The name of represented page item.

comp - The actual reference to the page item.

page - The number of the page item that this component represents.

Method Detail

getPageItem

public int getPageItem()

Retrieves the number of the page item. Page item numbers begin at zero.

Returns:

The number of the page item.

toString

public java.lang.String toString()

Converts this object to a String. The String contains the name of this class, the name of the page item, and the number of the page item.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the PageItemComponentInfo for the page item that this PageItemComponentHandle represents.

Overrides:

getComponentInfo in class ComponentHandle

Returns:

Information about the represented page item. The PageItemComponentInfo can be null, but this is not normal.