Skip navigation links

oracle.adf.view.rich.export
Class CollectionContentProvider

java.lang.Object
oracle.adf.view.rich.export.CollectionContentProvider

All Implemented Interfaces:

java.lang.Cloneable

public abstract class CollectionContentProvider

extends java.lang.Object

implements java.lang.Cloneable

Abstract base content provider class. Each content provider works with a specific type of collection component, so CollectionExportDirector can uniformly navigates through the collection component to export data.

Constructor Summary

CollectionContentProvider()

Method Summary

CollectionContentProvider	clone() Gets a copy of the CollectionContentProvider that recognizes the same collection component as this one does.
abstract java.util.List<javax.faces.component.UIComponent>	getChildren() Overridable hook for subclasses to provide a list of column children
abstract org.apache.myfaces.trinidad.component.UIXCollection	getCollectionComponent() Retrieves the current collection component this CollectionContentProvider is currently coupled with.
abstract java.lang.String	getCollectionContentType() The type of the collection component that this CollectionContentProvider supports.
abstract org.apache.myfaces.trinidad.model.CollectionModel	getCollectionModel() Retrieves the collection model of the current collection component this CollectionContentProvider is currently coupled with.
abstract org.apache.myfaces.trinidad.model.RowKeyIndex	getCollectionObject() Overridable hook for subclasses to provide RowKeyIndex instance to represent model contract with exporter.
javax.faces.component.UIComponent	getDetailStamp() Gets the detailStamp component of the collection component coupled with this CollectionContentProvider.
abstract org.apache.myfaces.trinidad.model.RowKeySet	getSelectedRowKeySet() Get the selected RowKeySet for the collection.
abstract void	setCollectionComponent(org.apache.myfaces.trinidad.component.UIXCollection component) Couple/decouple the CollectionContentProvider instance with a collection component.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionContentProvider

public CollectionContentProvider()

Method Detail

getCollectionContentType

public abstract java.lang.String getCollectionContentType()

The type of the collection component that this CollectionContentProvider supports. This will be used as key to register this content provider with ExportManager.

clone

public CollectionContentProvider clone()

Gets a copy of the CollectionContentProvider that recognizes the same collection component as this one does. The default implementation is to return this. If any CollectionContentProvider that has internal state and cannot be shared, it needs to implement this method to return a true copy of the content provider.

Overrides:

clone in class java.lang.Object

Returns:

a copy of the CollectionContentProvider that recognizes the same collection component

getCollectionComponent

public abstract org.apache.myfaces.trinidad.component.UIXCollection getCollectionComponent()

Retrieves the current collection component this CollectionContentProvider is currently coupled with.

getCollectionModel

public abstract org.apache.myfaces.trinidad.model.CollectionModel getCollectionModel()

Retrieves the collection model of the current collection component this CollectionContentProvider is currently coupled with.

setCollectionComponent

public abstract void setCollectionComponent(org.apache.myfaces.trinidad.component.UIXCollection component)

Couple/decouple the CollectionContentProvider instance with a collection component. A non-null component should be passed in before exporting starts and a null component should be passed in after exporting to clean the provider.

getCollectionObject

public abstract org.apache.myfaces.trinidad.model.RowKeyIndex getCollectionObject()

Overridable hook for subclasses to provide RowKeyIndex instance to represent model contract with exporter.

Returns:

RowKeyIndex instance

getChildren

public abstract java.util.List<javax.faces.component.UIComponent> getChildren()

Overridable hook for subclasses to provide a list of column children

Returns:

a list of columns

getSelectedRowKeySet

public abstract org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeySet()

Get the selected RowKeySet for the collection.

Returns:

the selected row key set

getDetailStamp

public javax.faces.component.UIComponent getDetailStamp()

Gets the detailStamp component of the collection component coupled with this CollectionContentProvider.

Returns:

the detail stamp component

Skip navigation links