oracle.dss.dataView
Class Dataview

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.dss.dataView.Dataview

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, DataviewAttributes, DataviewCommon, DataviewConstants, ModelListener, UIDataview, UIView, oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, ErrorHandlerCallback, PagingControlAttributes, oracle.dss.util.persistence.CatLinkNode, oracle.dss.util.persistence.CatNode, oracle.dss.util.persistence.contract.AggregableContract, oracle.dss.util.persistence.contract.CustomXMLContract, oracle.dss.util.persistence.contract.OptionalContract, oracle.dss.util.persistence.Persistable, oracle.dss.util.persistence.SimplePersistable, oracle.dss.util.persistence.StringXMLizable

Direct Known Subclasses:

Gauge, Graph

public abstract class Dataview
extends javax.swing.JPanel
implements ModelListener, ErrorHandlerCallback, ComponentTypeConverter, oracle.dss.util.persistence.Persistable, DataviewCommon, UIDataview, DataviewAttributes, DataviewConstants

The base View. In the Model-View-Controller architecture, a view presents data to users. This class defines methods and fields that are common to all the views in the BI Beans.

Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	a_description
static java.lang.String	a_localName
static java.lang.String	a_name
static java.lang.String	a_pagingControlVisible
static java.lang.String	a_swapAllowed
static java.lang.String	a_version
static java.lang.String	above_title
static java.lang.String	below_title
protected java.beans.PropertyChangeSupport	boundSupport
static java.lang.String	d_description
static java.lang.String	d_localName
static java.lang.String	d_name
static boolean	d_pagingControlVisible
static boolean	d_swapAllowed
protected javax.swing.JPanel	footnotePanel
protected javax.swing.event.EventListenerList	listenerList
protected oracle.dss.util.persistence.PersistableAttributes	m_attrs
protected boolean	m_bSuperCalled
protected CommonDataview	m_commonDataview
protected java.util.Hashtable	m_context
protected boolean	m_customColorsEnabled
protected DataviewTitles	m_dataviewFootnote
protected boolean	m_dataViewFormatSupported
protected DataviewTitles	m_dataviewSubtitle
protected DataviewTitles	m_dataviewTitle
protected static java.lang.String	m_method_readXML
protected static java.lang.String	m_method_resetToDefault
protected static java.lang.String	m_method_setpagingcontrolposition
static java.lang.String	m_method_setViewStyle
protected static java.lang.String	m_method_setXML
protected boolean	m_stopRepaints
protected TokenSubstitution	m_tokenSubstitution
static int	MAX_TEXTFIELD_CHARS
protected oracle.dss.pagingControl.ViewPagingControl	pagingControl
protected boolean	printOrPreviewMode
protected javax.swing.event.EventListenerList	propertyChangeListenerList
protected java.util.Vector	subcomponent
protected javax.swing.JPanel	titlePanel
protected javax.swing.undo.UndoManager	undoSupport
protected javax.swing.event.EventListenerList	vetoableChangeListenerList
protected java.beans.VetoableChangeSupport	vetoSupport

Fields inherited from class javax.swing.JComponent

accessibleContext, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface oracle.dss.dataView.DataviewConstants

AD_ALPHA_FADE, AD_AUTO, AD_CONVEYOR_FROM_LEFT, AD_CONVEYOR_FROM_RIGHT, AD_CUBE_TO_LEFT, AD_CUBE_TO_RIGHT, AD_FLIP_LEFT, AD_FLIP_RIGHT, AD_MAX, AD_MIN, AD_NONE, AD_SLIDE_TO_LEFT, AD_SLIDE_TO_RIGHT, AD_TRANSITION_TO_LEFT, AD_TRANSITION_TO_RIGHT, AD_ZOOM, ADC_ALPHA_FADE, ADC_AUTO, ADC_CONVEYOR_FROM_LEFT, ADC_CONVEYOR_FROM_RIGHT, ADC_CUBE_TO_LEFT, ADC_CUBE_TO_RIGHT, ADC_FLIP_LEFT, ADC_FLIP_RIGHT, ADC_MAX, ADC_MIN, ADC_NONE, ADC_ON, ADC_SLIDE_TO_LEFT, ADC_SLIDE_TO_RIGHT, ADC_TRANSITION_TO_LEFT, ADC_TRANSITION_TO_RIGHT, ADC_ZOOM, AI_ALL, AI_MAX, AI_MIN, AI_NONE, ANIMATION_DOWN_COLOR, ANIMATION_DURATION, ANIMATION_INDICATORS, ANIMATION_ON_DATA_CHANGE, ANIMATION_ON_DISPLAY, ANIMATION_UP_COLOR, DATAVIEW_END, DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, FORMAT_MANAGER_NAME, FT_COLOR, FT_GRADIENT, FT_PATTERN, FT_TEXTURE, GD_CUSTOM_LINEAR, GD_CUSTOM_RADIAL, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_OFF_CENTER, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, MAP_ALL, MAP_DATA, MAP_DATATEXT, MAP_LABELS, MAP_LEGEND, MAP_ORDINALLABELS, MAP_TITLES, PAGE_CONTROL, page_header, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, PAGING_CONTROL_EAST_OF_VIEW, PAGING_CONTROL_SOUTH_OF_VIEW, PAGING_CONTROL_WEST_OF_VIEW, RESET_EVERYTHING, RESET_EVERYTHING_CUSTOM, RESET_EVERYTHING_NOT_DATASOURCE, RESET_EVERYTHING_ORIGINAL, RESET_MAX, RESET_MIN, RESET_NONE, RESET_XML_PROPERTIES, RESET_XML_PROPERTIES_CUSTOM, RESET_XML_PROPERTIES_ORIGINAL, STYLE_MANAGER_NAME, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, TOOLTIP_NAME, VE_AUTO, VE_BEVEL, VE_GLOW, VE_MAX, VE_MIN, VE_NONE, VE_SFX_MAX, VE_SFX_MIN, VE_SHADOW, VIEW_FORMAT_NAME, VIEW_STYLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GAUGE, VIEW_TYPE_GRAPH, VIEW_TYPE_PAGINGCONTROL, VIEW_TYPE_TABLE, VISUAL_EFFECTS

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Dataview()
Constructor.

Method Summary

void	addControllerListener(ControllerListener l) Adds a listener for user gestures that do not affect data, such as selecting or resizing a component.
void	addDataListener(DataListener l) Adds a listener for changes to data, such as drilling or pivoting data.
void	addErrorHandler(ErrorHandler eh) Specifies the error handler for this view.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a property change listener for this view.
protected void	addSubcomponent(java.lang.Object s)
void	addVetoableChangeListener(java.beans.VetoableChangeListener l)
void	addViewFocusListener(ViewFocusListener l) Adds a ViewFocusListener to this view.
void	addViewKeyListener(ViewKeyListener l) Adds a ViewKeyListener to this view.
void	addViewListener(ViewListener l) Adds a ViewListener to the listener list.
void	addViewMouseListener(ViewMouseListener l) Adds a ViewMouseListener to this view.
void	addViewMouseMotionListener(ViewMouseMotionListener l) Adds a ViewMouseMotionListener to this view.
void	cleanUp() Clears the memory of the view.
void	clearPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
protected void	clearStyleModified()
void	clearWaitDataForAllRows()
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.
protected void	copyAdornment(BaseTitle to, BaseTitle from)
protected void	createFootnote()
java.util.BitSet	createPropertyOverrideFlags(int maxID)
protected void	createTitles()
void	dataFormatChanged()
void	dataStyleChanged()
protected void	firePrintBegin(java.lang.Object source)
protected void	firePrintEnd(java.lang.Object source)
protected abstract void	firePropertyChange(java.lang.Object obj, java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
protected java.lang.Object	getComponentFromID(int ID)
Controller	getController() Retrieves the controller for this Dataview.
DataDirector	getDataDirector() Retrieves the data director for this view.
DataSource	getDataSource() Retrieves the data source for this view.
DataviewTitles	getDataviewFootnote() Retrieves the footnote for this view.
DataviewTitles	getDataviewSubtitle() Retrieves the subtitle for this view.
DataviewTitles	getDataviewTitle() Retrieves the title for this view.
java.lang.String	getDescription() Retrieves the description of this view.
ErrorHandler	getErrorHandler() Retrieves the current error handler for this view.
FontList	getFontList()
int	getHTMLPagingControlWidth() Retrieves the number of page items that are displayed in the paging control before it wraps to the next line.
java.lang.String	getIntlString(java.lang.String key)
java.lang.String	getIntlString(java.lang.String key, java.util.ResourceBundle rBundle)
java.lang.String	getLayerMetadataLabelType() Retrieves the type of labels that this view displays for dimension names on all edges.
java.lang.String	getLayerMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension names on the specified edge.
java.util.Locale	getLocale() Retrieves the Locale that this Dataview uses.
java.lang.String	getLocalName() Retrieves the local name for this view.
java.lang.String	getMemberMetadataLabelType() Retrieves the type of labels that this view displays for dimension members.
java.lang.String	getMemberMetadataLabelType(int edge) Retrieves the type of labels that this view displays for dimension members on the specified edge.
Model	getModel() Retrieves the model for this Dataview.
java.lang.String	getName() Retrieves the name of this view.
protected java.lang.String	getNameFromID(int ID)
protected abstract oracle.dss.util.xml.ObjectNode	getObjectNode(boolean allProperties)
protected oracle.dss.util.xml.ObjectNode	getObjectNode(oracle.dss.util.xml.ObjectNode node, boolean allProperties)
oracle.dss.pagingControl.ViewPagingControl	getPagingControl() Retrieves the paging control for this view.
int	getPagingControlPosition() Retrieves the location of the paging control in this Dataview.
abstract oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Retrieves the attributes of this Dataview, for searching.
oracle.dss.util.persistence.AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this Dataview aggregates.
java.util.Vector	getPhysicalComponents() Retrieves a Vector of the physical components in this view.
PopupManager	getPopupManager() Retrieves the popup manager for this view.
abstract int	getPresentationHeight() Retrieveis the height of this view, in pixels.
abstract int	getPresentationWidth() Retrieves the width of this view, in pixels.
RolloverTextManager	getRolloverTextManager() Retrieves the rollover text manager for this view.
abstract ComponentHandle	getSelectedObject() Retrieves the selected component.
protected boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
protected ViewComponent	getSubcomponent(int id)
protected ViewComponent	getSubcomponent(java.lang.String name)
TokenSubstitution	getTokenSubstitution() Retrieves the handler for token substitution in this view.
abstract java.lang.String	getVersion()
abstract int	getViewType() Retrieves the specific type of subclass of this Dataview.
protected abstract DataviewXML	getViewXML()
protected WaitData[]	getWaitData()
WaitData	getWaitDataForRow(int row)
java.lang.String	getXML(boolean allProperties) Retrieves the XML string for this Dataview.
java.lang.String	getXMLAsString() Retrieves the XML representation of this Dataview.
int	getZoomFactor()
void	initialize(java.util.Hashtable env)
boolean	isCustomColorsEnabled() Return if the custom color option is enabled on all color choice pickers
boolean	isDataUnavailable()
boolean	isDataUnformattedSupported()
boolean	isDataViewFormatSupported()
boolean	isDrillingEnabled() Indicates whether drilling is allowed in this view.
boolean	isDrillingSupported()
boolean	isHTMLPagingControlAutosubmit() Indicates whether automatic submssion of information is enabled for the paging control.
protected boolean	isJavaComponent()
boolean	isLayerMetadataLabelTypeSupported(java.lang.String type)
boolean	isLayerMetaLongLabelSupported()
boolean	isLayerMetaMediumLabelSupported()
boolean	isLayerMetaNameSupported()
boolean	isLayerMetaShortLabelSupported()
boolean	isLayerMetaViewStyleSupported()
protected boolean	isLoadingDataSourceFromPersistence()
boolean	isMemberMetadataLabelTypeSupported(java.lang.String type)
boolean	isMetadataLongLabelSupported()
boolean	isMetadataMediumLabelSupported()
boolean	isMetadataShortLabelSupported()
boolean	isMetadataValueSupported()
boolean	isMetadataViewStyleSupported()
boolean	isPagingControlVisible() Indicates whether the paging control appears in this view.
abstract boolean	isPrintOrPreviewMode()
boolean	isPropertyOverrideFlag(int attrID, java.util.BitSet overrideFlags)
protected boolean	isStyleModified()
protected boolean	isStyleOverrideMode()
abstract boolean	isSwapAllowed() Indicates whether swapping is allowed in this view.
protected boolean	isUserOverrideMode()
boolean	isXMLValidated() Indicates whether the Dataview validates XML against its DTD.
protected void	metadataLabelTypeChanged()
void	metadataStyleChanged()
void	modelDataAvailable(DataAvailableEvent e) Inform view of changes to the data availability.
void	modelDataChanged(DataChangedEvent e) Inform view of changes to the actual data or metadata.
void	modelWaitDataAvailable(WaitDataAvailableEvent e) Inform view that a lazy data fetch has been completed.
protected void	positionPagingControl(int location)
abstract boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Dataview, from a String.
protected abstract void	refreshData()
void	removeControllerListener(ControllerListener l) Removes a listener for user gestures that do not affect data.
void	removeDataListener(DataListener l) Removes a listener for user gestures that affect data.
void	removeErrorHandler() Removes a customized error handler for this view.
protected void	removeListeners(int reset)
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a property change listener from this view.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener l)
void	removeViewFocusListener(ViewFocusListener l) Removes a ViewFocusListener from this view.
void	removeViewKeyListener(ViewKeyListener l) Removes a ViewKeyListener from this view.
void	removeViewListener(ViewListener l) Removes a ViewListener from the listener list.
void	removeViewMouseListener(ViewMouseListener l) Removes a ViewMouseListener from this view.
void	removeViewMouseMotionListener(ViewMouseMotionListener l) Removes a ViewMouseMotionListener from this view.
void	resetToDefault(int reset) Resets properties of this Dataview to their default values.
protected void	resetToDefault(int reset, java.lang.String version) Resets properties of this Dataview to their default values.
java.awt.Font	scaleFont(java.awt.Font f, int zoomFactor)
abstract boolean	selectObject(ComponentHandle id) Select a component.
void	setCommonDataview(CommonDataview commonDataview)
protected abstract void	setContext()
void	setController(Controller c)
void	setCustomColorsEnabled(boolean enabled) Set custom color option enabled on all color choice pickers
void	setDataDirector(DataDirector dd)
void	setDataSource(DataSource ds) Specifies the data source for this view.
protected void	setDataUnformattedSupported(boolean supported)
void	setDescription(java.lang.String n) Specifies a description for this view.
void	setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view.
void	setEnabled(boolean enabled) Specifies whether this Dataview is enabled.
void	setHTMLPagingControlAutosubmit(boolean autosubmit) Specifies whether the paging control automatically submits information when someone changes a page dimension member.
void	setHTMLPagingControlWidth(int width) Specifies the number of page items that are displayed in the paging control before it wraps to the next line.
void	setLayerMetadataLabelType(int edge, java.lang.String type) Specifies the type of labels to display for dimension names on the specified edge in this view.
void	setLayerMetadataLabelType(java.lang.String type) Specifies the type of labels to display for dimension names on all edges in this view.
protected void	setLayerMetaLongLabelSupported(boolean supported)
protected void	setLayerMetaMediumLabelSupported(boolean supported)
protected void	setLayerMetaNameSupported(boolean supported)
protected void	setLayerMetaShortLabelSupported(boolean supported)
void	setLayerMetaViewStyleSupported(boolean supported)
protected void	setLoadingDataSourceFromPersistence(boolean bLoading)
void	setLocale(java.util.Locale loc) Specifies the Locale for this Dataview.
void	setLocalName(java.lang.String n) Specifies a local name for this view.
void	setMemberMetadataLabelType(int edge, java.lang.String type) Specifies the type of labels to display for dimension members on the specified edge in this view.
void	setMemberMetadataLabelType(java.lang.String type) Specifies the type of labels to display for dimension members on all edges in this view.
protected void	setMetadataLongLabelSupported(boolean supported)
protected void	setMetadataMediumLabelSupported(boolean supported)
protected void	setMetadataShortLabelSupported(boolean supported)
protected void	setMetadataValueSupported(boolean supported)
void	setMetadataViewStyleSupported(boolean supported)
void	setModel(Model m)
void	setName(java.lang.String n) Specifies the name of this view.
void	setPagingControlPosition(int loc) Specifies the location of the paging control in this Dataview.
void	setPagingControlVisible(boolean v) Specifies whether the paging control appears in this view.
void	setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Specifies persistable attributes that can be used in searches of the repository.
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
void	setPopupManager(PopupManager p) Specifies a popup manager for this view.
void	setPropertyOverrideFlags(int attrID, java.util.BitSet userFlags, java.util.BitSet styleFlags)
void	setRolloverTextManager(RolloverTextManager rm) Specifies the rollover text manager for this view.
protected void	setStyleOverrideMode(boolean flag)
protected void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
abstract void	setSwapAllowed(boolean swap) Specifies whether users can swap layers in this view.
void	setTokenSubstitution(TokenSubstitution token) Specifies a handler for token substitution in this view.
protected void	setUserOverrideMode(boolean flag)
void	setWaitDataForRow(int row, WaitData waitData)
protected void	setXML(oracle.dss.util.xml.ObjectNode node)
abstract boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Dataview, from a String.
abstract boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this Dataview.
void	setXMLValidated(boolean validate) Specifies whether this Dataview validates XML against its DTD.
void	updatePagingControlStyles()
void	writeXML(java.io.OutputStream stream, boolean allProperties) Writes XML for this Dataview to an output stream.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.dataView.DataviewCommon

repaint

Field Detail

m_attrs

protected transient oracle.dss.util.persistence.PersistableAttributes m_attrs

m_bSuperCalled

protected boolean m_bSuperCalled

d_name

public static final java.lang.String d_name

d_localName

public static final java.lang.String d_localName

d_description

public static final java.lang.String d_description

d_pagingControlVisible

public static final boolean d_pagingControlVisible

d_swapAllowed

public static final boolean d_swapAllowed

See Also:

Constant Field Values

a_name

public static final java.lang.String a_name

See Also:

Constant Field Values

a_localName

public static final java.lang.String a_localName

See Also:

Constant Field Values

a_description

public static final java.lang.String a_description

See Also:

Constant Field Values

a_pagingControlVisible

public static final java.lang.String a_pagingControlVisible

See Also:

Constant Field Values

a_swapAllowed

public static final java.lang.String a_swapAllowed

See Also:

Constant Field Values

a_version

public static final java.lang.String a_version

See Also:

Constant Field Values

MAX_TEXTFIELD_CHARS

public static final int MAX_TEXTFIELD_CHARS

See Also:

Constant Field Values

listenerList

protected javax.swing.event.EventListenerList listenerList

propertyChangeListenerList

protected javax.swing.event.EventListenerList propertyChangeListenerList

vetoableChangeListenerList

protected javax.swing.event.EventListenerList vetoableChangeListenerList

boundSupport

protected transient java.beans.PropertyChangeSupport boundSupport

vetoSupport

protected transient java.beans.VetoableChangeSupport vetoSupport

undoSupport

protected transient javax.swing.undo.UndoManager undoSupport

subcomponent

protected java.util.Vector subcomponent

pagingControl

protected oracle.dss.pagingControl.ViewPagingControl pagingControl

m_tokenSubstitution

protected TokenSubstitution m_tokenSubstitution

m_stopRepaints

protected boolean m_stopRepaints

m_customColorsEnabled

protected boolean m_customColorsEnabled

m_method_setViewStyle

public static final java.lang.String m_method_setViewStyle

See Also:

Constant Field Values

m_method_resetToDefault

protected static final java.lang.String m_method_resetToDefault

See Also:

Constant Field Values

m_method_readXML

protected static final java.lang.String m_method_readXML

See Also:

Constant Field Values

m_method_setXML

protected static final java.lang.String m_method_setXML

See Also:

Constant Field Values

m_method_setpagingcontrolposition

protected static final java.lang.String m_method_setpagingcontrolposition

See Also:

Constant Field Values

m_dataviewTitle

protected DataviewTitles m_dataviewTitle

m_dataviewSubtitle

protected DataviewTitles m_dataviewSubtitle

m_dataviewFootnote

protected DataviewTitles m_dataviewFootnote

m_commonDataview

protected CommonDataview m_commonDataview

m_dataViewFormatSupported

protected boolean m_dataViewFormatSupported

titlePanel

protected javax.swing.JPanel titlePanel

footnotePanel

protected javax.swing.JPanel footnotePanel

printOrPreviewMode

protected boolean printOrPreviewMode

m_context

protected java.util.Hashtable m_context

above_title

public static final java.lang.String above_title

See Also:

Constant Field Values

below_title

public static final java.lang.String below_title

See Also:

Constant Field Values

Constructor Detail

Dataview

public Dataview()

Constructor. Application developers should call the constructors of the concrete subclasses of this class. Those constructors call this constructor.

New subclasses of this Dataview should also set a controller and a model in their constructors.

Method Detail

setCommonDataview

public void setCommonDataview(CommonDataview commonDataview)

setPagingControlPosition

public void setPagingControlPosition(int loc)

Specifies the location of the paging control in this Dataview. If loc is not valid, then this method positions the paging control above the titles, as if PAGING_CONTROL_ABOVE_TITLES had been specified as the location.

Specified by:

setPagingControlPosition in interface DataviewAttributes

Parameters:

loc - A constant that indicates the location for the paging control. Constants begin with PAGING_CONTROL.

getPagingControlPosition

public int getPagingControlPosition()

Retrieves the location of the paging control in this Dataview.

Specified by:

getPagingControlPosition in interface DataviewAttributes

Returns:

A constant that indicates the location of the paging control. Constants begin with PAGING_CONTROL.

setTokenSubstitution

public void setTokenSubstitution(TokenSubstitution token)

Specifies a handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution. You need to call this method only if you provide your own handler for allowing users to insert tokens.

Specified by:

setTokenSubstitution in interface DataviewCommon

Specified by:

setTokenSubstitution in interface UIDataview

Parameters:

token - The token substitution handler for this view.

getTokenSubstitution

public TokenSubstitution getTokenSubstitution()

Retrieves the handler for token substitution in this view. Token substitution handlers make it possible for users to insert tokens (such as a token for the current dimension member) in the title, subtitle, and footnote of this view. Most application developers will use the default TokenSubstitution.

Specified by:

getTokenSubstitution in interface DataviewCommon

Specified by:

getTokenSubstitution in interface UIDataview

Returns:

The token substitution handler for this view. By default, this is a TokenSubstitutionAdapter.

setDataSource

public void setDataSource(DataSource ds)

Specifies the data source for this view. In the Model-View-Controller architecture, the data source is the model. It feeds data to the view for display. The Model class in a visualization bean represents the DataSource to the view, but the DataSource is the real source of the data.

Specified by:

setDataSource in interface DataviewCommon

Parameters:

ds - The data source for this view.

getDataSource

public DataSource getDataSource()

Retrieves the data source for this view.

Specified by:

getDataSource in interface DataviewCommon

Returns:

The DataSource for this view. If no model or data source has been set for this view, this method returns null.

getDataviewTitle

public DataviewTitles getDataviewTitle()

Retrieves the title for this view.

Specified by:

getDataviewTitle in interface DataviewCommon

Specified by:

getDataviewTitle in interface UIDataview

Returns:

The title for this view.

getDataviewSubtitle

public DataviewTitles getDataviewSubtitle()

Retrieves the subtitle for this view.

Specified by:

getDataviewSubtitle in interface DataviewCommon

Specified by:

getDataviewSubtitle in interface UIDataview

Returns:

The subtitle for this view.

getDataviewFootnote

public DataviewTitles getDataviewFootnote()

Retrieves the footnote for this view.

Specified by:

getDataviewFootnote in interface DataviewCommon

Specified by:

getDataviewFootnote in interface UIDataview

Returns:

The footnote for this view.

setDataDirector

public void setDataDirector(DataDirector dd)

Parameters:

dd - The data director for this view.

getDataDirector

public DataDirector getDataDirector()

Retrieves the data director for this view. The data director has been initialized.

Returns:

The data director for this view.

addControllerListener

public void addControllerListener(ControllerListener l)

Adds a listener for user gestures that do not affect data, such as selecting or resizing a component. Application developers call this method when they want to respond to a user gesture. For example, if you want to respond when a user selects a component, you would implement a ControllerListener and put the code to respond to the selection in the componentSelected method. You can simply extend the ControllerListenerAdapter, so that you do not have to implement all of the methods in the interface.

Specified by:

addControllerListener in interface UIView

Parameters:

l - The listener to add.

See Also:

ControllerListener.componentSelected(oracle.dss.dataView.ControllerEvent), ControllerListenerAdapter

removeControllerListener

public void removeControllerListener(ControllerListener l)

Removes a listener for user gestures that do not affect data.

Specified by:

removeControllerListener in interface UIView

Parameters:

l - The listener to remove.

addDataListener

public void addDataListener(DataListener l)

Adds a listener for changes to data, such as drilling or pivoting data. Application developers call this method to add listeners for data changes.

For example, if you want to intercept drill requests, implement a DataListener. In the viewDrillRequesting method, put the code for responding to the drill request. You can simply extend the DataListenerAdapter class, so that you do not have to implement the other methods in the interface.

Parameters:

l - The listener to add.

See Also:

DataListener.viewDrillRequesting(oracle.dss.dataView.DrillEvent), DataListenerAdapter

removeDataListener

public void removeDataListener(DataListener l)

Removes a listener for user gestures that affect data.

Parameters:

l - The listener to remove.

addErrorHandler

public void addErrorHandler(ErrorHandler eh)

Specifies the error handler for this view. This view can have one and only one error handler. The error handler is called when the view traps an error from another source, such as a DataSource, and when an internal error condition or exception occurs.

The default error handler prints messages to the console.

Use this method to install your own error handler. This method then sets the error handler on the Model.

Specified by:

addErrorHandler in interface ErrorHandlerCallback

Parameters:

eh - The error handler to use.

removeErrorHandler

public void removeErrorHandler()

Removes a customized error handler for this view. This method replaces the current error handler with a default error handler. This method in turn sets the new default error handler on the Model. The default error handler prints information to the console.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: DataviewCommon

Retrieves the current error handler for this view.

Specified by:

getErrorHandler in interface DataviewCommon

Returns:

The current error handler for this view.

addViewMouseListener

public void addViewMouseListener(ViewMouseListener l)

Adds a ViewMouseListener to this view.

Parameters:

l - The listener to add.

removeViewMouseListener

public void removeViewMouseListener(ViewMouseListener l)

Removes a ViewMouseListener from this view.

Parameters:

l - The listener to remove.

addViewMouseMotionListener

public void addViewMouseMotionListener(ViewMouseMotionListener l)

Adds a ViewMouseMotionListener to this view.

Parameters:

l - The listener to remove.

removeViewMouseMotionListener

public void removeViewMouseMotionListener(ViewMouseMotionListener l)

Removes a ViewMouseMotionListener from this view.

Parameters:

l - The listener to remove.

addViewKeyListener

public void addViewKeyListener(ViewKeyListener l)

Adds a ViewKeyListener to this view.

Parameters:

l - The listener to add.

removeViewKeyListener

public void removeViewKeyListener(ViewKeyListener l)

Removes a ViewKeyListener from this view.

Parameters:

l - The listener to remove.

addViewFocusListener

public void addViewFocusListener(ViewFocusListener l)

Adds a ViewFocusListener to this view.

Parameters:

l - The listener to add.

removeViewFocusListener

public void removeViewFocusListener(ViewFocusListener l)

Removes a ViewFocusListener from this view.

Parameters:

l - The listener to remove.

addViewListener

public void addViewListener(ViewListener l)

Adds a ViewListener to the listener list.

Parameters:

l - The listener to add.

removeViewListener

public void removeViewListener(ViewListener l)

Removes a ViewListener from the listener list.

Parameters:

l - The listener to remove.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a property change listener for this view.

Overrides:

addPropertyChangeListener in class java.awt.Container

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a property change listener from this view.

Overrides:

removePropertyChangeListener in class java.awt.Component

Parameters:

l - The listener to remove.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener l)

Overrides:

addVetoableChangeListener in class javax.swing.JComponent

Parameters:

l - The listener to add.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)

Overrides:

removeVetoableChangeListener in class javax.swing.JComponent

Parameters:

l - The listener to remove.

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether this Dataview validates XML against its DTD. By default, the table does not validate the XML. If there is a parsing error in the XML, then the Dataview. ignores the badly formed XML. If you want readXML and setXML to throw a BIParseException if they encounter XML that cannot be parsed, then pass true to this method.

Parameters:

validate - true to have XML validated, false to have the Dataview ignore invalid XML.

See Also:

setXML(java.lang.String, int)

isXMLValidated

public boolean isXMLValidated()

Indicates whether the Dataview validates XML against its DTD.

Returns:

true if the Dataview validates XML, false if the Dataview applies XML without validation.

positionPagingControl

protected void positionPagingControl(int location)

Parameters:

location - the location of the paging control with respect to the title and subtitle, as specified by the PagingControlPosition property

firePrintBegin

protected void firePrintBegin(java.lang.Object source)

Parameters:

source - The source of the print event.

firePrintEnd

protected void firePrintEnd(java.lang.Object source)

Parameters:

source - source of the event

copyAdornment

protected void copyAdornment(BaseTitle to,
                             BaseTitle from)

Parameters:

to - adornment to copy properties to

from - adornment to copy properties from

getComponentFromID

protected java.lang.Object getComponentFromID(int ID)

getNameFromID

protected java.lang.String getNameFromID(int ID)

firePropertyChange

protected abstract void firePropertyChange(java.lang.Object obj,
                                           java.lang.String propName,
                                           java.lang.Object oldValue,
                                           java.lang.Object newValue)

Parameters:

obj - the object which has the getter/setter for this property

propName - the name of the property (minus get/set)

oldValue - the previous value of the property

newValue - the new value of the property

selectObject

public abstract boolean selectObject(ComponentHandle id)

Select a component.

Parameters:

id - A ComponentHandle that represents the component to select.

Returns:

true if the component is successfully selected, false if not.

getSelectedObject

public abstract ComponentHandle getSelectedObject()

Retrieves the selected component.

Specified by:

getSelectedObject in interface UIView

Returns:

A handle for the selected component. The return value should actually be a concrete subclass of ComponentHandle.

getPresentationHeight

public abstract int getPresentationHeight()

Retrieveis the height of this view, in pixels.

Returns:

The height of the this view, in pixels.

getPresentationWidth

public abstract int getPresentationWidth()

Retrieves the width of this view, in pixels.

Returns:

The width of the this view, in pixels.

setName

public final void setName(java.lang.String n)

Specifies the name of this view.

Specified by:

setName in interface oracle.dss.presutil.CommonViewAttributes

Overrides:

setName in class java.awt.Component

Parameters:

n - The name to use for this view.

getName

public final java.lang.String getName()

Retrieves the name of this view.

Specified by:

getName in interface oracle.dss.presutil.CommonViewAttributes

Overrides:

getName in class java.awt.Component

Returns:

The name of this view.

setLocalName

public final void setLocalName(java.lang.String n)

Specifies a local name for this view. The name of the view should be constant in all versions of an application. The local name should be a translation of the name into the local language.

Specified by:

setLocalName in interface oracle.dss.presutil.CommonViewAttributes

Parameters:

n - The local name of this view bean.

getLocalName

public final java.lang.String getLocalName()

Retrieves the local name for this view. The local name should be a translation of the name, into the local language.

Specified by:

getLocalName in interface oracle.dss.presutil.CommonViewAttributes

Returns:

The local name of this view.

setDescription

public final void setDescription(java.lang.String n)

Specifies a description for this view.

Specified by:

setDescription in interface oracle.dss.presutil.CommonViewAttributes

Parameters:

n - The description to use for this view.

getDescription

public final java.lang.String getDescription()

Retrieves the description of this view.

Specified by:

getDescription in interface oracle.dss.presutil.CommonViewAttributes

Returns:

The description of this view.

setDrillingEnabled

public void setDrillingEnabled(boolean b)

Specifies whether drilling is allowed in this view. Drilling is enabled by default.

Specified by:

setDrillingEnabled in interface DataviewAttributes

Parameters:

b - true to enable drilling; false to disable drilling.

isDrillingEnabled

public final boolean isDrillingEnabled()

Indicates whether drilling is allowed in this view.

Specified by:

isDrillingEnabled in interface DataviewAttributes

Returns:

true if drilling is enabled, false if drilling is disabled.

isDrillingSupported

public boolean isDrillingSupported()

Specified by:

isDrillingSupported in interface DataviewAttributes

Returns:

true if drilling is supported, false if drilling is not supported.

setPopupManager

public void setPopupManager(PopupManager p)

Specifies a popup manager for this view. You implement a popup manager to display popup menus in this view.

Parameters:

p - The popup manager for this view.

getPopupManager

public PopupManager getPopupManager()

Retrieves the popup manager for this view.

Returns:

The popup manager for this view.

setRolloverTextManager

public void setRolloverTextManager(RolloverTextManager rm)

Specifies the rollover text manager for this view. You implement a rollover text manager to display text when the mouse moves over an area of this view.

Parameters:

rm - The rollover text manager for this view.

getRolloverTextManager

public RolloverTextManager getRolloverTextManager()

Retrieves the rollover text manager for this view.

Returns:

The rollover text manager for this view.

refreshData

protected abstract void refreshData()

isPrintOrPreviewMode

public abstract boolean isPrintOrPreviewMode()

modelDataChanged

public void modelDataChanged(DataChangedEvent e)

Description copied from interface: ModelListener

Inform view of changes to the actual data or metadata. This method is called by the ModelAdapter in response to data changes. Application developers do not need to call it.

Specified by:

modelDataChanged in interface ModelListener

Parameters:

e - Information about the data change.

See Also:

ModelAdapter

modelDataAvailable

public void modelDataAvailable(DataAvailableEvent e)

Description copied from interface: ModelListener

Inform view of changes to the data availability. This method is called by the ModelAdapter in response to data availability changes. Application developers do not need to call it.

Specified by:

modelDataAvailable in interface ModelListener

Parameters:

e - Information about the change in data availability.

See Also:

ModelAdapter

modelWaitDataAvailable

public void modelWaitDataAvailable(WaitDataAvailableEvent e)

Description copied from interface: ModelListener

Inform view that a lazy data fetch has been completed. This method is called by the ModelAdapter in response to the completion of a lazy data fetch. Application developers do not need to call it.

Specified by:

modelWaitDataAvailable in interface ModelListener

Parameters:

e - Information about the fetch.

setWaitDataForRow

public void setWaitDataForRow(int row,
                              WaitData waitData)

Specified by:

setWaitDataForRow in interface DataviewCommon

Parameters:

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.

getWaitDataForRow

public WaitData getWaitDataForRow(int row)

Specified by:

getWaitDataForRow in interface DataviewCommon

Parameters:

row - The index of the row that you want to know about.

Returns:

If the specified row is waiting for data, then this method will return a WaitData object for the row, otherwise this method will return null.

clearWaitDataForAllRows

public void clearWaitDataForAllRows()

getWaitData

protected WaitData[] getWaitData()

getFontList

public FontList getFontList()

Specified by:

getFontList in interface DataviewCommon

Returns:

The current font cache list.

getPhysicalComponents

public java.util.Vector getPhysicalComponents()

Retrieves a Vector of the physical components in this view. Physical components are objects that extend JComponent and have physical Java manifestations, as opposed to virtual components that extend Object and have only a logical Java manifestation.

For a GridView, the objects in the vector include components like the title, subtitle, footnote, data body, headers, and the paging control. For a Graph, the vector includes only the PFJ object and the paging control.

Returns:

The physical components in this view.

getIntlString

public java.lang.String getIntlString(java.lang.String key)

Specified by:

getIntlString in interface DataviewCommon

Parameters:

key - the String that needs to be translated.

Returns:

the translated String

getIntlString

public java.lang.String getIntlString(java.lang.String key,
                                      java.util.ResourceBundle rBundle)

Specified by:

getIntlString in interface DataviewCommon

Parameters:

key - the String that needs to be translated.

rBundle - the bundle to look in

Returns:

the translated String.

setModel

public void setModel(Model m)

Parameters:

m - the new model for the view

getModel

public Model getModel()

Retrieves the model for this Dataview. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full set of BI Beans, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Specified by:

getModel in interface DataviewCommon

Specified by:

getModel in interface UIView

Returns:

The Model for this Dataview.

setController

public void setController(Controller c)

Parameters:

c - the new controller for the view

getController

public Controller getController()

Retrieves the controller for this Dataview. In the Model-View-Controller architecture, the controller is responsible for attending to mouse events and key events.

Returns:

The Controller for this Dataview.

updatePagingControlStyles

public void updatePagingControlStyles()

metadataStyleChanged

public void metadataStyleChanged()

Specified by:

metadataStyleChanged in interface DataviewCommon

dataStyleChanged

public void dataStyleChanged()

Specified by:

dataStyleChanged in interface DataviewCommon

dataFormatChanged

public void dataFormatChanged()

Specified by:

dataFormatChanged in interface DataviewCommon

setLocale

public void setLocale(java.util.Locale loc)

Specifies the Locale for this Dataview.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The Locale for this Dataview.

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this Dataview uses.

Specified by:

getLocale in interface DataviewCommon

Specified by:

getLocale in interface UIView

Overrides:

getLocale in class java.awt.Component

Returns:

loc The Locale for this Dataview.

getXML

public java.lang.String getXML(boolean allProperties)

Retrieves the XML string for this Dataview. The XML can include values for all of the properties in the Dataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

allProperties - true to retrieve XML for all properties, false to retrieve XML only for properties whose values are different from the default property values.

Returns:

The XML string for this Dataview.

writeXML

public void writeXML(java.io.OutputStream stream,
                     boolean allProperties)

Writes XML for this Dataview to an output stream. The XML can include values for all of the properties in the Dataview, or, for better performance, it can include only the values that are different from the default values.

Notes: This method sets the current version as the version in the XML.

The XML does not contain attributes for the Locale property or the XMLValidated property.

Parameters:

stream - The output stream to which to write the XML.

allProperties - true to write out XML for all properties, false to write out XML only for properties whose values are different from the default property values.

addSubcomponent

protected void addSubcomponent(java.lang.Object s)

Parameters:

s - subcomponent object

getSubcomponent

protected ViewComponent getSubcomponent(int id)

Parameters:

id - subcomponent id to find

Returns:

subcomponent matching id, if found. null if not

getSubcomponent

protected ViewComponent getSubcomponent(java.lang.String name)

Parameters:

name - name to find

Returns:

subcomponent matching name, if found. null if not

getPagingControl

public oracle.dss.pagingControl.ViewPagingControl getPagingControl()

Retrieves the paging control for this view. The paging control provides UI for changing the page of data that appears in this view.

Returns:

The paging control for this view. If there is no paging control for this view, returns null.

setPagingControlVisible

public void setPagingControlVisible(boolean v)

Specifies whether the paging control appears in this view.

Specified by:

setPagingControlVisible in interface DataviewAttributes

Specified by:

setPagingControlVisible in interface DataviewCommon

Specified by:

setPagingControlVisible in interface PagingControlAttributes

Parameters:

v - true to make the paging control visible, false to hide it.

isPagingControlVisible

public boolean isPagingControlVisible()

Indicates whether the paging control appears in this view.

Specified by:

isPagingControlVisible in interface DataviewAttributes

Specified by:

isPagingControlVisible in interface DataviewCommon

Specified by:

isPagingControlVisible in interface PagingControlAttributes

Returns:

true if the paging control appears in this view, false if it does not.

getViewType

public abstract int getViewType()

Retrieves the specific type of subclass of this Dataview. This method is implemented in subclasses of Dataview.

Specified by:

getViewType in interface DataviewCommon

Specified by:

getViewType in interface UIView

Returns:

A constant that represents the specific type of view. Valid constants are listed in the See Also section.

See Also:

DataviewConstants.VIEW_TYPE_CROSSTAB, DataviewConstants.VIEW_TYPE_GRAPH, DataviewConstants.VIEW_TYPE_TABLE

scaleFont

public java.awt.Font scaleFont(java.awt.Font f,
                               int zoomFactor)

Specified by:

scaleFont in interface DataviewCommon

Parameters:

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()).

getZoomFactor

public int getZoomFactor()

Specified by:

getZoomFactor in interface DataviewCommon

Returns:

The default zoom factor for this view.

setEnabled

public void setEnabled(boolean enabled)

Specifies whether this Dataview is enabled. When a Dataview is disabled, it is visible, but users cannot operate on the Dataview.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

enabled - true to enable this Dataview, false to disable it.

setCustomColorsEnabled

public void setCustomColorsEnabled(boolean enabled)

Set custom color option enabled on all color choice pickers

Specified by:

setCustomColorsEnabled in interface UIView

Parameters:

enabled - true to enable custom color option on all color choice pickers false to disable it

isCustomColorsEnabled

public boolean isCustomColorsEnabled()

Return if the custom color option is enabled on all color choice pickers

Specified by:

isCustomColorsEnabled in interface UIView

Returns:

true custom color option is enabled on all color choice pickers false custom color option is disabled

convertComponentTypeToInteger

public int convertComponentTypeToInteger(java.lang.String type)

Description copied from interface: ComponentTypeConverter

Retrieves an integer representation of a view component, from a String.

Specified by:

convertComponentTypeToInteger in interface ComponentTypeConverter

convertComponentTypeToString

public java.lang.String convertComponentTypeToString(int type)

Description copied from interface: ComponentTypeConverter

Retrieves a String representation of a view component, from an integer.

Specified by:

convertComponentTypeToString in interface ComponentTypeConverter

Parameters:

type - An identifier for a view component.

resetToDefault

public void resetToDefault(int reset)

Resets properties of this Dataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

This method is helpful when you want to reuse a Dataview rather than instantiate a new one.

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

resetToDefault

protected void resetToDefault(int reset,
                              java.lang.String version)

Resets properties of this Dataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

This method is helpful when you want to reuse a Dataview rather than instantiate a new one.

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

removeListeners

protected void removeListeners(int reset)

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

getVersion

public abstract java.lang.String getVersion()

Returns:

String The XML version that this view is using

readXML

public abstract boolean readXML(java.io.InputStream stream,
                                int reset)
                         throws oracle.dss.util.xml.BIIOException,
                                oracle.dss.util.xml.BISAXException,
                                oracle.dss.util.xml.BIParseException

Applies XML to this Dataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this Dataview. The reset parameter determines how much of the Dataview to reset before applying XML. In general, you can:

• Apply the XML to the current Dataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Dataview

Resetting returns property values in the Dataview to the default values for the version that is specified in the XML.

Parameters:

stream - The XML to apply to this Dataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Dataview, false if an IO exception occurs.

Throws:

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

setXML

public abstract boolean setXML(java.lang.String xmlString,
                               int reset)
                        throws oracle.dss.util.xml.BIIOException,
                               oracle.dss.util.xml.BISAXException,
                               oracle.dss.util.xml.BIParseException

Applies XML to this Dataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this Dataview. The reset parameter determines how much of the Dataview to reset before applying XML. In general, you can:

• Apply the XML to the current Dataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Dataview

Resetting returns property values in the Dataview to the default values for the version that is specified in the XML.

Parameters:

xmlString - The XML to apply to this Dataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Dataview, false if an IO exception occurs.

Throws:

oracle.dss.util.xml.BIIOException - If an error occurs in reading xmlString.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

DataviewConstants.RESET_NONE, DataviewConstants.RESET_XML_PROPERTIES, DataviewConstants.RESET_EVERYTHING

setXML

protected void setXML(oracle.dss.util.xml.ObjectNode node)

setStyleXML

protected void setStyleXML(oracle.dss.util.xml.ObjectNode node)

setSwapAllowed

public abstract void setSwapAllowed(boolean swap)

Specifies whether users can swap layers in this view. When SwapAllowed is true, then users can click the two layers that they want to swap, in order to swap the layers. The view will then ask the data source to perform a pivot of type DataDirector.PIVOT_SWAP.

When SwapAllowed is false, then users must move the two layers separately, and the view will ask for two separate pivot actions of type DataDirector.PIVOT_MOVE_BEFORE or DataDirector.PIVOT_MOVE_AFTER.

By default, swapping is disabled.

Parameters:

swap - true to enable swapping, false to disable it.

See Also:

isSwapAllowed(), DataDirector

isSwapAllowed

public abstract boolean isSwapAllowed()

Indicates whether swapping is allowed in this view. When this method returns true, then users can swap items by clicking the two items. When this method returns false, then users must move each item separately.

Returns:

true if swapping is enabled, false if it is not.

See Also:

setSwapAllowed(boolean)

cleanUp

public void cleanUp()

Clears the memory of the view. Call this method when you no longer need this view.

isDataUnavailable

public boolean isDataUnavailable()

initialize

public void initialize(java.util.Hashtable env)

Specified by:

initialize in interface oracle.dss.util.persistence.SimplePersistable

setContext

protected abstract void setContext()

getPersistableAttributes

public abstract oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)

Retrieves the attributes of this Dataview, for searching. This method adds the attributes that this Dataview defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

attrs - The searchable attributes that the application has specified for this Dataview.

Returns:

A PersistableAttributes that includes the application specified attributes as well as the attributes that are specific to this Dataview.

setPersistableAttributes

public void setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)

Specifies persistable attributes that can be used in searches of the repository. This implementation does nothing. Only properties of the Dataview itself can be used as persistable attributes.

Specified by:

setPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

attrs - Any PersistableAttributes.

setXMLAsString

public abstract boolean setXMLAsString(java.lang.String xml)
                                throws oracle.dss.util.persistence.BIPersistenceException

Specifies the XML representation of this Dataview. The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method. To load XML from a file, call setXML or readXML.

Specified by:

setXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, int), setXML(java.lang.String, int)

getPersistableComponents

public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()

Retrieves the persistable components that this Dataview aggregates. Dataview objects aggregate the data source that defines the data that view displays.

The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Specified by:

getPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Returns:

The data source for this Dataview, in an AggregateInfo array.

setPersistableComponents

public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)

Specified by:

setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Parameters:

aggregates - a AggregateInfo[] value that represents the components to assign to the view.

getXMLAsString

public java.lang.String getXMLAsString()

Retrieves the XML representation of this Dataview. This method is called by the persistence service when you save the Dataview to the BI Beans Catalog.

This method calls getXML(false), so the XML that is stored in the Catalog has only property values that are different from the default values.

Application developers should not call this method. To create a file that has the XML for this Dataview, call the writeXML method or the getXML method.

Specified by:

getXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this Dataview.

See Also:

getXML(boolean), writeXML(java.io.OutputStream, boolean)

setLoadingDataSourceFromPersistence

protected void setLoadingDataSourceFromPersistence(boolean bLoading)

Parameters:

bLoading - true if the data source is being loaded through persistence, false otherwise

isLoadingDataSourceFromPersistence

protected boolean isLoadingDataSourceFromPersistence()

Returns:

true if the data source is being loaded from persistence, false otherwise

createTitles

protected void createTitles()

createFootnote

protected void createFootnote()

getObjectNode

protected oracle.dss.util.xml.ObjectNode getObjectNode(oracle.dss.util.xml.ObjectNode node,
                                                       boolean allProperties)

getStyleXML

protected boolean getStyleXML(boolean allProperties,
                              oracle.dss.util.xml.ObjectNode node)

getObjectNode

protected abstract oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)

getViewXML

protected abstract DataviewXML getViewXML()

setDataUnformattedSupported

protected void setDataUnformattedSupported(boolean supported)

isDataUnformattedSupported

public boolean isDataUnformattedSupported()

Specified by:

isDataUnformattedSupported in interface DataviewCommon

isDataViewFormatSupported

public boolean isDataViewFormatSupported()

Specified by:

isDataViewFormatSupported in interface DataviewCommon

Returns:

true if DATA_VIEWFORMAT is supported, else false

setMetadataLongLabelSupported

protected void setMetadataLongLabelSupported(boolean supported)

isMetadataLongLabelSupported

public boolean isMetadataLongLabelSupported()

setMetadataMediumLabelSupported

protected void setMetadataMediumLabelSupported(boolean supported)

isMetadataMediumLabelSupported

public boolean isMetadataMediumLabelSupported()

setMetadataShortLabelSupported

protected void setMetadataShortLabelSupported(boolean supported)

isMetadataShortLabelSupported

public boolean isMetadataShortLabelSupported()

Specified by:

isMetadataShortLabelSupported in interface DataviewCommon

isMetadataViewStyleSupported

public boolean isMetadataViewStyleSupported()

Specified by:

isMetadataViewStyleSupported in interface DataviewCommon

Returns:

true if METADATA_VIEWSTYLE is supported, else false

setMetadataViewStyleSupported

public void setMetadataViewStyleSupported(boolean supported)

setMetadataValueSupported

protected void setMetadataValueSupported(boolean supported)

isMetadataValueSupported

public boolean isMetadataValueSupported()

Returns:

true if METADATA_VALUE is supported, else false

setLayerMetaLongLabelSupported

protected void setLayerMetaLongLabelSupported(boolean supported)

isLayerMetaLongLabelSupported

public boolean isLayerMetaLongLabelSupported()

setLayerMetaMediumLabelSupported

protected void setLayerMetaMediumLabelSupported(boolean supported)

isLayerMetaMediumLabelSupported

public boolean isLayerMetaMediumLabelSupported()

setLayerMetaShortLabelSupported

protected void setLayerMetaShortLabelSupported(boolean supported)

isLayerMetaShortLabelSupported

public boolean isLayerMetaShortLabelSupported()

Specified by:

isLayerMetaShortLabelSupported in interface DataviewCommon

setLayerMetaNameSupported

protected void setLayerMetaNameSupported(boolean supported)

isLayerMetaNameSupported

public boolean isLayerMetaNameSupported()

setLayerMetaViewStyleSupported

public void setLayerMetaViewStyleSupported(boolean supported)

isLayerMetaViewStyleSupported

public boolean isLayerMetaViewStyleSupported()

Specified by:

isLayerMetaViewStyleSupported in interface DataviewCommon

isMemberMetadataLabelTypeSupported

public boolean isMemberMetadataLabelTypeSupported(java.lang.String type)

Specified by:

isMemberMetadataLabelTypeSupported in interface DataviewCommon

Parameters:

type - type of member metadata label

Returns:

true if the type is supported, false if not

isLayerMetadataLabelTypeSupported

public boolean isLayerMetadataLabelTypeSupported(java.lang.String type)

Specified by:

isLayerMetadataLabelTypeSupported in interface DataviewCommon

Parameters:

type - type of layer metadata label

Returns:

true if the type is supported, false if not

isJavaComponent

protected boolean isJavaComponent()

setHTMLPagingControlAutosubmit

public void setHTMLPagingControlAutosubmit(boolean autosubmit)

Specifies whether the paging control automatically submits information when someone changes a page dimension member. By default, automatic submission is disabled.

This property is used for the thin beans only.

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewAttributes

Specified by:

setHTMLPagingControlAutosubmit in interface DataviewCommon

Parameters:

autosubmit - true to enable automatic submission, false to disable it.

isHTMLPagingControlAutosubmit

public boolean isHTMLPagingControlAutosubmit()

Indicates whether automatic submssion of information is enabled for the paging control. This property is used for the thin beans only.

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewAttributes

Specified by:

isHTMLPagingControlAutosubmit in interface DataviewCommon

Returns:

true if automatic submission is enabled, false if it is disabled.

setHTMLPagingControlWidth

public void setHTMLPagingControlWidth(int width)

Specifies the number of page items that are displayed in the paging control before it wraps to the next line. If you set width to -1, then all page items will be displayed on the same line. By default, width is set to 3. This property is used for the thin beans only.

Specified by:

setHTMLPagingControlWidth in interface DataviewAttributes

Specified by:

setHTMLPagingControlWidth in interface DataviewCommon

Parameters:

width - The number of page items to display before wrapping.

getHTMLPagingControlWidth

public int getHTMLPagingControlWidth()

Retrieves the number of page items that are displayed in the paging control before it wraps to the next line. The default value is 3. This property is used for the thin beans only.

Specified by:

getHTMLPagingControlWidth in interface DataviewAttributes

Specified by:

getHTMLPagingControlWidth in interface DataviewCommon

Returns:

The number of page items to display before wrapping. A return of -1 indicates that all page items appear on the same line.

setMemberMetadataLabelType

public void setMemberMetadataLabelType(int edge,
                                       java.lang.String type)

Specifies the type of labels to display for dimension members on the specified edge in this view. The default value for all edges is METADATA_LONGLABEL. If the edge or type is invalid, then this method logs a message with the error handler, and it does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedMetadataMap, and then call the containsType method of the returned map.

Specified by:

setMemberMetadataLabelType in interface DataviewAttributes

Parameters:

edge - A constant that represents the edge that the metadata label type applies to. Valid constants are listed in the See Also section, and they end in "EDGE".

type - A constant that represents the type of metadata label to show. Valid constants are listed in the See Also section, and they begin with "METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE, DataDirector.getSupportedMetadataMap()

getMemberMetadataLabelType

public java.lang.String getMemberMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension members on the specified edge. The default value for all edges is METADATA_LONGLABEL. Returns null if the specified edge is invalid.

Specified by:

getMemberMetadataLabelType in interface DataviewAttributes

Specified by:

getMemberMetadataLabelType in interface DataviewCommon

Parameters:

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".

Returns:

A constant that represents the type of metadata label to display. Valid constants are listed in the See Also section, and they begin with "METADATA".

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE

setLayerMetadataLabelType

public void setLayerMetadataLabelType(int edge,
                                      java.lang.String type)

Specifies the type of labels to display for dimension names on the specified edge in this view. The default value for all edges is LAYER_METADATA_LONGLABEL. If the edge or type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedLayerMetadataMap, and then call the containsType method of the returned map.

Specified by:

setLayerMetadataLabelType in interface DataviewAttributes

Parameters:

edge - A constant that represents the edge that the metadata label type applies to. Valid constants are listed in the See Also section, and they end with "EDGE".

type - A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section, and they begin with "LAYER_METADATA".

See Also:

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, DataDirector.getSupportedLayerMetadataMap()

getLayerMetadataLabelType

public java.lang.String getLayerMetadataLabelType(int edge)

Retrieves the type of labels that this view displays for dimension names on the specified edge. The default value for all edges is LAYER_METADATA_LONGLABEL. Returns null if the given edge is invalid.

Specified by:

getLayerMetadataLabelType in interface DataviewAttributes

Specified by:

getLayerMetadataLabelType in interface DataviewCommon

Parameters:

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".

Returns:

A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section, and they begin with "LAYER_METADATA".

See Also:

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

setMemberMetadataLabelType

public void setMemberMetadataLabelType(java.lang.String type)

Specifies the type of labels to display for dimension members on all edges in this view. This is a convenience method to use instead of calling setMemberMetadataLabelType(int, String) on every edge. The default value for all edges is METADATA_LONGLABEL. If the type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedMetadataMap, and then call the containsType method of the returned map.

Parameters:

type - A constant that represents the type of metadata label to show. Valid constants are listed in the See Also section.

See Also:

setMemberMetadataLabelType(int, String), MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE, DataDirector.getSupportedMetadataMap()

getMemberMetadataLabelType

public java.lang.String getMemberMetadataLabelType()

Retrieves the type of labels that this view displays for dimension members. If this view displays the same label type on all edges, then this method returns that type. If different label types are used on different edges, then this method returns null. If this method returns null, then call the getMemberMetadataLabelType(int) method for each edge to get the label types. The default value for all edges is METADATA_LONGLABEL.

Returns:

A constant that represents the type of metadata label that is displayed on all edges, or null if different label types are used for different edges.

See Also:

getMemberMetadataLabelType(int), MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_VALUE

setLayerMetadataLabelType

public void setLayerMetadataLabelType(java.lang.String type)

Specifies the type of labels to display for dimension names on all edges in this view. This is a convenience method to use instead of calling setLayerMetadataLabelType(int, String) on every edge. The default value for all edges is LAYER_METADATA_LONGLABEL. If the type is invalid, then this method logs a message with the error handler and does not change the current label type.

Note: Not all data sources support all types of labels. Before you call this method, ensure that the data source supports the label type that you want to set. Call DataDirector.getSupportedLayerMetadataMap, and then call the containsType method of the returned map.

Parameters:

type - A constant that represents the type of layer metadata label to show. Valid constants are listed in the See Also section.

See Also:

setLayerMetadataLabelType(int, String), LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME, DataDirector.getSupportedLayerMetadataMap()

metadataLabelTypeChanged

protected void metadataLabelTypeChanged()

getLayerMetadataLabelType

public java.lang.String getLayerMetadataLabelType()

Retrieves the type of labels that this view displays for dimension names on all edges. If the same label type is shown on all edges, then this method returns that type. If different label types are used on different edges, then this method returns null. If this method returns null, then call getLayerMetadataLabelType(int) for each edge to get the label types. The default value for all edges is LAYER_METADATA_LONGLABEL.

Returns:

A constant that represents the type of layer metadata label that this view uses for all dimension names, or null if different edges use different label types.

See Also:

getLayerMetadataLabelType(int), LayerMetadataMap.LAYER_METADATA_LONGLABEL, LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL, LayerMetadataMap.LAYER_METADATA_SHORTLABEL, LayerMetadataMap.LAYER_METADATA_NAME

createPropertyOverrideFlags

public java.util.BitSet createPropertyOverrideFlags(int maxID)

Specified by:

createPropertyOverrideFlags in interface DataviewCommon

setPropertyOverrideFlags

public void setPropertyOverrideFlags(int attrID,
                                     java.util.BitSet userFlags,
                                     java.util.BitSet styleFlags)

Specified by:

setPropertyOverrideFlags in interface DataviewCommon

isPropertyOverrideFlag

public boolean isPropertyOverrideFlag(int attrID,
                                      java.util.BitSet overrideFlags)

Specified by:

isPropertyOverrideFlag in interface DataviewCommon

clearPropertyOverrideFlag

public void clearPropertyOverrideFlag(int attrID,
                                      java.util.BitSet overrideFlags)

setStyleOverrideMode

protected void setStyleOverrideMode(boolean flag)

isStyleOverrideMode

protected boolean isStyleOverrideMode()

isStyleModified

protected boolean isStyleModified()

clearStyleModified

protected void clearStyleModified()

setUserOverrideMode

protected void setUserOverrideMode(boolean flag)

isUserOverrideMode

protected boolean isUserOverrideMode()