|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LayoutAccess
Methods that layout panels call to work on the layout before applying the layout to an actual query. The implementation of this interface should provide a representation of the layout part of a query that will be manipulated by layout panels.
oracle.dss.util.gui.layout.Layout
Field Summary | |
---|---|
static java.lang.String |
MEASURE Constant for type parameter in isSpecialDimension to determine if the dimension at a given edge and layer is the measure dimension or a measure |
static java.lang.String |
TIME_DIMENSION Constant for type parameter in isSpecialDimension to determine if the dimension at a given edge and layer is a time dimension. |
Method Summary | |
---|---|
DataSource |
getDataSource() Retrieves the DataSource that reflects layout changes in this LayoutAccess . |
int |
getMeasureEdge() Retrieves the edge that has the measure dimension in the layout query. |
int |
getMeasureLayer() Retrieves the layer that has the measure dimension. |
java.lang.String[] |
getMeasures(java.lang.String type) Deprecated. As of 4.0.0.0, replaced by #LayoutAccess2.getDataItems() |
boolean |
isSpecialDimension(int edge, int layer, java.lang.String type) Determine if the dimension at the given edge and layer is of the type specified by the given constant. |
void |
release() Cleans up the LayoutAccess implementation. |
void |
setCursorEvaluation(boolean on) Specifies whether the cursor is evaluated. |
void |
setLayout(java.lang.String[][] layout) Specifies the layout of the data, as a two-dimensional array. |
void |
setMeasures(java.lang.String[] measures) Deprecated. As of 4.0.0.0, replaced by #LayoutAccess2.setItems() |
Field Detail |
---|
static final java.lang.String TIME_DIMENSION
isSpecialDimension
to determine if the dimension at a given edge and layer is a time dimension.
static final java.lang.String MEASURE
isSpecialDimension
to determine if the dimension at a given edge and layer is the measure dimension or a measure
Method Detail |
---|
void setCursorEvaluation(boolean on)
on
- true
to have the cursor evaluated, false
to turn off evaluation of the cursor.DataSource getDataSource()
DataSource
that reflects layout changes in this LayoutAccess
. Initially, the DataSource
that this method returns should be a copy of the query that will ultimately be affected by the layout panel. Layout panels then call DataDirector
methods to manipulate the query that this method returns. The changes made to the query do not affect the original query until the applyLayoutAccess
method of the LayoutContext
is called.DataSource
that reflects layout changes in this LayoutAccess
.LayoutContext.applyLayoutAccess(oracle.dss.util.LayoutAccess, boolean)
, DataDirector
void setMeasures(java.lang.String[] measures)
#LayoutAccess2.setItems()
measures
- The measures to use in the data source. The elements of the array should be a subset of the measures that are returned by a call to the getMeasures
method, with MetadataMap.METADATA_VALUE
as the parameter.getMeasures(java.lang.String)
java.lang.String[] getMeasures(java.lang.String type)
#LayoutAccess2.getDataItems()
type
- The type of labels that you want in the array that is returned. The types are those defined in the MetadataMap
for the query. Possible values are listed in the See Also section, but only those that are specified in the query's MetadataMap
are valid.MetadataMap.METADATA_LONGLABEL
, MetadataMap.METADATA_MEDIUMLABEL
, MetadataMap.METADATA_SHORTLABEL
, MetadataMap.METADATA_DISPLAYNAME
, MetadataMap.METADATA_VALUE
int getMeasureEdge()
DataDirector.COLUMN_EDGE
, DataDirector.ROW_EDGE
, DataDirector.PAGE_EDGE
int getMeasureLayer()
getMeasureEdge
returns.boolean isSpecialDimension(int edge, int layer, java.lang.String type) throws EdgeOutOfRangeException, LayerOutOfRangeException
edge
- the edge whose dimension should be checkedlayer
- the layer within the edge whose dimension should be checkedtype
- the type constant (defined in LayoutAccess, such as LayoutAccess.TIME_DIMENSION) against which to check the dimension at layer,edgetrue
if the dimension at edge, layer is of the special type given by type.EdgeOutOfRangeException
- if the given edge is illegal for the current dataLayerOutOfRangeException
- if the given layer is illegal for the current dataTIME_DIMENSION
, MEASURE
void setLayout(java.lang.String[][] layout)
Each element in the array represents a value that the DataDirector.getLayerMetadata
method returns when you pass LayerMetadataMap.LAYER_METADATA_NAME
to it. The location of each return value in the array specifies the location that you want it to have in the query.
Edges that you want to be empty should have a zero-element subarray at the edge location.
layout
- The array that specifies the desired layout.CDFDataAccess.getLayerMetadata(int, int, java.lang.String)
, LayerMetadataMap.LAYER_METADATA_NAME
void release()
LayoutAccess
implementation. This method should release any resources that the LayoutAccess
has created. Call this method when you no longer need the LayoutAccess
.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |