public abstract class UIDataviewAdapter extends PagingControlAttributesAdapter implements UIDataview, DataviewCommon
UIDataview
interface.
Create an instance of a concrete subclass of this proxy class so that the UI panels
can be displayed before a view is constructed.Modifier and Type | Field and Description |
---|---|
protected boolean |
m_customColorsEnabled |
protected DataviewTitles |
m_dataViewFootnote |
protected DataviewTitles |
m_dataViewSubtitle |
protected DataviewTitles |
m_dataViewTitle |
protected ErrorHandler |
m_errorHandler |
protected javax.swing.event.EventListenerList |
m_listenerList |
protected java.util.Locale |
m_locale |
protected ComponentHandle |
m_selectedObject |
protected TokenSubstitution |
m_token |
m_bPagingControlVisible
Constructor and Description |
---|
UIDataviewAdapter()
Constructor.
|
UIDataviewAdapter(UIDataview view)
Constructor that initializes this adapter from an existing view
or proxy.
|
Modifier and Type | Method and Description |
---|---|
void |
addControllerListener(ControllerListener l)
Adds a listener for user gestures that do not affect data, such as
selecting or resizing a component.
|
protected void |
applyTitleAttributes(UIDataview toView) |
void |
applyToDataview(UIDataview view)
Applies properties of this adapter to a
UIDataview . |
protected void |
cleanUp() |
static void |
clearPropertyOverrideFlag(int attrID,
java.util.BitSet overrideFlags) |
int |
convertComponentTypeToInteger(java.lang.String type)
Retrieves an integer representation of a view component, from a
String . |
java.lang.String |
convertComponentTypeToString(int type)
Retrieves a
String representation of a view component,
from an integer. |
java.util.BitSet |
createPropertyOverrideFlags(int maxID) |
void |
dataFormatChanged() |
void |
dataStyleChanged() |
protected void |
fireComponentSelected(java.lang.Object source,
ComponentHandle id) |
protected boolean |
fireComponentSelecting(java.lang.Object source,
ComponentHandle id) |
DataSource |
getDataSource()
Retrieves the data source for this view.
|
DataviewTitles |
getDataviewFootnote()
Retrieves the
Footnote component for this adapter. |
DataviewTitles |
getDataviewSubtitle()
Retrieves the
Subtitle component for this adapter. |
DataviewTitles |
getDataviewTitle()
Retrieves the
Title component for this adapter. |
ErrorHandler |
getErrorHandler()
Retrieves the current error handler for this view.
|
FontList |
getFontList() |
int |
getHTMLPagingControlWidth()
Retrieves the number of page items that are displayed before the
paging control wraps.
|
java.lang.String |
getIntlString(java.lang.String key) |
java.lang.String |
getIntlString(java.lang.String key,
java.util.ResourceBundle rBundle) |
java.lang.String |
getLayerMetadataLabelType(int edge)
Retrieves the type of labels to display for dimension names
on the specified edge.
|
java.util.Locale |
getLocale()
Retrieves the
Locale that this UIDataviewAdapter uses. |
java.lang.String |
getMemberMetadataLabelType(int edge)
Retrieves the type of labels to display for dimension
members on the specified edge.
|
Model |
getModel()
Retrieves the model for this view.
|
ComponentHandle |
getSelectedObject()
Retrieves the selected component.
|
TokenSubstitution |
getTokenSubstitution()
Retrieves the handler for token substitution in this view.
|
abstract int |
getViewType()
Get the specific type of the view that this adapter represents.
|
WaitData |
getWaitDataForRow(int row) |
int |
getZoomFactor()
Retrieves the default zoom factor for this view.
|
void |
initFromDataview(UIDataview view)
Initializes the properties of this adapter from a
UIDataview . |
protected void |
initTitleAttributes(UIDataview fromView) |
boolean |
isCustomColorsEnabled()
Return if the custom color option is enabled on all color choice pickers
|
boolean |
isDataUnformattedSupported() |
boolean |
isDataViewFormatSupported() |
boolean |
isHTMLPagingControlAutosubmit()
Indicates whether paging control changes are automatically submitted.
|
boolean |
isLayerMetadataLabelTypeSupported(java.lang.String type) |
boolean |
isLayerMetaShortLabelSupported() |
boolean |
isLayerMetaViewStyleSupported() |
boolean |
isMemberMetadataLabelTypeSupported(java.lang.String type) |
boolean |
isMetadataShortLabelSupported() |
boolean |
isMetadataViewStyleSupported() |
boolean |
isPropertyOverrideFlag(int attrID,
java.util.BitSet overrideFlags) |
protected boolean |
isStyleOverrideMode() |
protected boolean |
isUserOverrideMode() |
void |
metadataStyleChanged() |
void |
removeControllerListener(ControllerListener l)
Removes a listener for user gestures that do not affect data.
|
void |
repaint() |
java.awt.Font |
scaleFont(java.awt.Font f,
int zoomFactor) |
boolean |
selectObject(ComponentHandle handle)
Sets the selected component.
|
void |
setCustomColorsEnabled(boolean enabled)
Set custom color option enabled on all color choice pickers
|
void |
setDataSource(DataSource ds)
Specifies the data source for this view.
|
void |
setHTMLPagingControlAutosubmit(boolean autosubmit)
Specifies whether paging control changes are automatically submitted.
|
void |
setHTMLPagingControlWidth(int width)
Specifies the number of page items that are displayed before
the paging control wraps to a new line.
|
void |
setLocale(java.util.Locale loc)
Sets the
Locale that this UIDataviewAdapter uses. |
void |
setPropertyOverrideFlags(int attrID,
java.util.BitSet userFlags,
java.util.BitSet styleFlags) |
protected void |
setStyleOverrideMode(boolean flag) |
void |
setTokenSubstitution(TokenSubstitution token)
Specifies a handler for token substitution in this view.
|
protected void |
setUserOverrideMode(boolean flag) |
void |
setWaitDataForRow(int row,
WaitData waitData) |
applyToPagingControlAttributes, initFromPagingControlAttributes, isPagingControlVisible, setPagingControlVisible
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isPagingControlVisible, setPagingControlVisible
isPagingControlVisible, setPagingControlVisible
protected DataviewTitles m_dataViewTitle
protected DataviewTitles m_dataViewSubtitle
protected DataviewTitles m_dataViewFootnote
protected java.util.Locale m_locale
protected ComponentHandle m_selectedObject
protected javax.swing.event.EventListenerList m_listenerList
protected TokenSubstitution m_token
protected ErrorHandler m_errorHandler
protected boolean m_customColorsEnabled
public UIDataviewAdapter()
public UIDataviewAdapter(UIDataview view)
view
- The UIDataview
to initialize this adapter from.public void initFromDataview(UIDataview view)
UIDataview
.
The view's Locale
and SelectedObject
will be set on this adapter.
This method calls the initFromPagingControlAttributes
method
of the superclass.view
- The UIDataview
to initialize this adapter from.public void applyToDataview(UIDataview view)
UIDataview
.
This method calls the applyToPagingControlAttributes
method
of the superclass.view
- The view to apply properties of this adapter to.public java.util.Locale getLocale()
Locale
that this UIDataviewAdapter
uses.getLocale
in interface DataviewCommon
getLocale
in interface UIView
Locale
for this UIDataviewAdapter
.public void setLocale(java.util.Locale loc)
Locale
that this UIDataviewAdapter
uses.loc
- The Locale
for this UIDataviewAdapter
.public ComponentHandle getSelectedObject()
getSelectedObject
in interface UIView
ComponentHandle
.public DataviewTitles getDataviewTitle()
Title
component for this adapter.getDataviewTitle
in interface DataviewCommon
getDataviewTitle
in interface UIDataview
Title
component for this adapter.public DataviewTitles getDataviewSubtitle()
Subtitle
component for this adapter.getDataviewSubtitle
in interface DataviewCommon
getDataviewSubtitle
in interface UIDataview
Subtitle
component for this adapter.public DataviewTitles getDataviewFootnote()
Footnote
component for this adapter.getDataviewFootnote
in interface DataviewCommon
getDataviewFootnote
in interface UIDataview
Footnote
component for this adapter.public boolean selectObject(ComponentHandle handle)
handle
- A handle for the selected component. The parameter
should actually be a concrete subclass of
ComponentHandle
.true
if the component is successfully selected,
false
if selection fails.public void addControllerListener(ControllerListener l)
addControllerListener
in interface UIView
l
- The listener to add.ControllerListener.componentSelected(oracle.dss.dataView.ControllerEvent)
,
ControllerListenerAdapter
public void removeControllerListener(ControllerListener l)
removeControllerListener
in interface UIView
l
- The listener to remove.public abstract int getViewType()
getViewType
in interface DataviewCommon
getViewType
in interface UIView
DataviewConstants.VIEW_TYPE_CROSSTAB
,
DataviewConstants.VIEW_TYPE_GRAPH
,
DataviewConstants.VIEW_TYPE_TABLE
public void setTokenSubstitution(TokenSubstitution token)
TokenSubstitution
.
You need to call this method only if you provide your own handler for
allowing users to insert tokens.setTokenSubstitution
in interface DataviewCommon
setTokenSubstitution
in interface UIDataview
token
- The token substitution handler for this view.public TokenSubstitution getTokenSubstitution()
TokenSubstitution
.getTokenSubstitution
in interface DataviewCommon
getTokenSubstitution
in interface UIDataview
TokenSubstitutionAdapter
.public ErrorHandler getErrorHandler()
DataviewCommon
getErrorHandler
in interface DataviewCommon
public FontList getFontList()
getFontList
in interface DataviewCommon
public int getZoomFactor()
scaleFont
method.getZoomFactor
in interface DataviewCommon
public java.awt.Font scaleFont(java.awt.Font f, int zoomFactor)
scaleFont
in interface DataviewCommon
f
- The font to scale.zoomFactor
- The percent of the default zoom factor to make the
font. For example, to double the size of the font,
pass 2 * (getZoomFactor())
.public java.lang.String getIntlString(java.lang.String key)
getIntlString
in interface DataviewCommon
key
- the String that needs to be translated.public java.lang.String getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
getIntlString
in interface DataviewCommon
key
- the String that needs to be translated.rBundle
- the bundle to look inpublic boolean isLayerMetaShortLabelSupported()
isLayerMetaShortLabelSupported
in interface DataviewCommon
public boolean isLayerMetaViewStyleSupported()
isLayerMetaViewStyleSupported
in interface DataviewCommon
public boolean isMetadataViewStyleSupported()
isMetadataViewStyleSupported
in interface DataviewCommon
public boolean isMetadataShortLabelSupported()
isMetadataShortLabelSupported
in interface DataviewCommon
public boolean isDataUnformattedSupported()
isDataUnformattedSupported
in interface DataviewCommon
public boolean isDataViewFormatSupported()
isDataViewFormatSupported
in interface DataviewCommon
public boolean isMemberMetadataLabelTypeSupported(java.lang.String type)
isMemberMetadataLabelTypeSupported
in interface DataviewCommon
type
- type of member metadata labelpublic boolean isLayerMetadataLabelTypeSupported(java.lang.String type)
isLayerMetadataLabelTypeSupported
in interface DataviewCommon
type
- type of layer metadata labelpublic java.lang.String getLayerMetadataLabelType(int edge)
LAYER_METADATA_LONGLABEL
.getLayerMetadataLabelType
in interface DataviewCommon
edge
- A constant that represents the edge for which to get the
metadata label type.
Valid constants are listed in the See Also section,
and they end with "EDGE".DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
,
DataDirector.PAGE_EDGE
,
LayerMetadataMap.LAYER_METADATA_LONGLABEL
,
LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL
,
LayerMetadataMap.LAYER_METADATA_SHORTLABEL
,
LayerMetadataMap.LAYER_METADATA_NAME
public java.lang.String getMemberMetadataLabelType(int edge)
METADATA_LONGLABEL
.getMemberMetadataLabelType
in interface DataviewCommon
edge
- A constant that represents the edge for which to get
the metadata label type.
Valid constants are listed in the See Also section,
and they end with "EDGE".DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
,
DataDirector.PAGE_EDGE
,
MetadataMap.METADATA_LONGLABEL
,
MetadataMap.METADATA_MEDIUMLABEL
,
MetadataMap.METADATA_SHORTLABEL
,
MetadataMap.METADATA_VALUE
public void repaint()
repaint
in interface DataviewCommon
public void metadataStyleChanged()
metadataStyleChanged
in interface DataviewCommon
public void dataStyleChanged()
dataStyleChanged
in interface DataviewCommon
public void dataFormatChanged()
dataFormatChanged
in interface DataviewCommon
public WaitData getWaitDataForRow(int row)
getWaitDataForRow
in interface DataviewCommon
row
- The index of the row that you want to know about.WaitData
object for the row, otherwise this
method will return null
.Application developers do not need to call this method.
public void setWaitDataForRow(int row, WaitData waitData)
setWaitDataForRow
in interface DataviewCommon
row
- The index of the row that is waiting for data.waitData
- The WaitData
object that you want to use
to display a message in each cell on the row.Application developers do not need to call this method.
public Model getModel()
getModel
in interface DataviewCommon
getModel
in interface UIView
null
.public int convertComponentTypeToInteger(java.lang.String type)
String
.convertComponentTypeToInteger
in interface ComponentTypeConverter
The
- constant for a view component.public java.lang.String convertComponentTypeToString(int type)
String
representation of a view component,
from an integer.convertComponentTypeToString
in interface ComponentTypeConverter
type
- An identifier for a view component.null
.public void setHTMLPagingControlAutosubmit(boolean autosubmit)
DataviewCommon
setHTMLPagingControlAutosubmit
in interface DataviewCommon
autosubmit
- true, if autosubmit is enabled, and false if autosubmit is disabledpublic boolean isHTMLPagingControlAutosubmit()
DataviewCommon
isHTMLPagingControlAutosubmit
in interface DataviewCommon
public void setHTMLPagingControlWidth(int width)
DataviewCommon
setHTMLPagingControlWidth
in interface DataviewCommon
width
- the number of page items to display before wrappingpublic int getHTMLPagingControlWidth()
DataviewCommon
getHTMLPagingControlWidth
in interface DataviewCommon
protected void applyTitleAttributes(UIDataview toView)
protected void initTitleAttributes(UIDataview fromView)
protected boolean fireComponentSelecting(java.lang.Object source, ComponentHandle id)
source
- the source of the event (usually this adapter)id
- the ComponentHandle of the object being selectedprotected void fireComponentSelected(java.lang.Object source, ComponentHandle id)
source
- the source of this event (usually this adapter)id
- the ComponentHandle of the object being selectedpublic void setDataSource(DataSource ds)
setDataSource
in interface DataviewCommon
ds
- The data source for this view.public DataSource getDataSource()
getDataSource
in interface DataviewCommon
null
.protected void cleanUp()
public java.util.BitSet createPropertyOverrideFlags(int maxID)
createPropertyOverrideFlags
in interface DataviewCommon
public void setPropertyOverrideFlags(int attrID, java.util.BitSet userFlags, java.util.BitSet styleFlags)
setPropertyOverrideFlags
in interface DataviewCommon
public boolean isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
isPropertyOverrideFlag
in interface DataviewCommon
public static void clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
public void setCustomColorsEnabled(boolean enabled)
setCustomColorsEnabled
in interface UIView
enabled
- true
to enable custom color option on all color choice pickers
false
to disable itpublic boolean isCustomColorsEnabled()
isCustomColorsEnabled
in interface UIView
true
custom color option is enabled on all color choice pickers
false
custom color option is disabledprotected void setStyleOverrideMode(boolean flag)
protected boolean isStyleOverrideMode()
protected void setUserOverrideMode(boolean flag)
protected boolean isUserOverrideMode()