oracle.dss.util

Class PageItemComponentInfo

java.lang.Object

oracle.dss.util.ComponentInfo

oracle.dss.util.PageItemComponentInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PageItemComponentInfo
extends ComponentInfo

Page item information about a DataView component. A page item is an item in a paging control. Each item shows information about a dimension on the page edge.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageItemComponentInfo(int pageItem) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones this PageItemComponentInfo.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this PageItemComponentInfo.
int	getPageItem() Retrieves the number of the page item.
QDR	getQDR(DataAccess dataAccess, int flags) Retrieves a QDR for this PageItemComponentInfo.
int	hashCode()
java.lang.String	toString() Produces a String that identifies the page item.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageItemComponentInfo

public PageItemComponentInfo(int pageItem)

Constructor.

Parameters:

pageItem - The page item of the component.

Method Detail

clone

public java.lang.Object clone()

Clones this PageItemComponentInfo.

Specified by:

clone in class ComponentInfo

Returns:

The clone of this PageItemComponentInfo.

getPageItem

public int getPageItem()

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

Returns:

The page item number.

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this PageItemComponentInfo. PageItemComponentInfo objects are equivalent if they refer to the same item on the page edge.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this PageItemComponentInfo.

Returns:

true if both objects refer to the same page item, false if not or if o is not a PageItemComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)

Retrieves a QDR for this PageItemComponentInfo. The QDR is a dimension-only QDR that identifies the dimension whose members appear in the page item for which this PageItemComponentInfo provides information.

Specified by:

getQDR in class ComponentInfo

Parameters:

dataAccess - The DataAccess that the page item is using.

flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.

Returns:

A QDR that identifies the dimension whose members the page item displays.

See Also:

DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

hashCode

public int hashCode()

Specified by:

hashCode in class ComponentInfo

For internal use only. Application developers should not use this

toString

public java.lang.String toString()

Produces a String that identifies the page item.

Overrides:

toString in class java.lang.Object

Returns:

The page item number, in a String.