public abstract class Dataview extends javax.swing.JPanel implements ModelListener, ErrorHandlerCallback, ComponentTypeConverter, oracle.dss.util.persistence.Persistable, DataviewCommon, UIDataview, DataviewAttributes, DataviewConstants
Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.
javax.swing.JPanel.AccessibleJPaneljavax.swing.JComponent.AccessibleJComponent| Modifier and Type | Field and Description |
|---|---|
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 |
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 |
TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTAD_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, MAX_TEXTFIELD_CHARS, 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| Constructor and Description |
|---|
Dataview()
Constructor.
|
| 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.
|
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() |
javax.swing.JPanel |
getFootnotePanel() |
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) |
javax.swing.JPanel |
getTitlePanel() |
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)
Initializes the component with the persistence environment.
|
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)
Specifies a list of
Persistable components that the
component aggregates. |
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. |
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIaddAncestorListener, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, updateadd, 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, transferFocusDownCycle, validate, validateTreeaction, 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, 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, transferFocusBackward, transferFocusUpCycleclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitrepaintprotected transient oracle.dss.util.persistence.PersistableAttributes m_attrs
PersistableAttributes component of this view.
This structure holds searchable attributes relevant to this view.protected boolean m_bSuperCalled
public static final java.lang.String d_name
public static final java.lang.String d_localName
public static final java.lang.String d_description
public static final boolean d_pagingControlVisible
public static final boolean d_swapAllowed
public static final java.lang.String a_name
public static final java.lang.String a_localName
public static final java.lang.String a_description
public static final java.lang.String a_pagingControlVisible
public static final java.lang.String a_swapAllowed
public static final java.lang.String a_version
protected javax.swing.event.EventListenerList listenerList
protected javax.swing.event.EventListenerList propertyChangeListenerList
protected javax.swing.event.EventListenerList vetoableChangeListenerList
protected transient java.beans.PropertyChangeSupport boundSupport
protected transient java.beans.VetoableChangeSupport vetoSupport
protected transient javax.swing.undo.UndoManager undoSupport
protected java.util.Vector subcomponent
protected oracle.dss.pagingControl.ViewPagingControl pagingControl
protected TokenSubstitution m_tokenSubstitution
protected boolean m_stopRepaints
protected boolean m_customColorsEnabled
public static final java.lang.String m_method_setViewStyle
protected static final java.lang.String m_method_resetToDefault
protected static final java.lang.String m_method_readXML
protected static final java.lang.String m_method_setXML
protected static final java.lang.String m_method_setpagingcontrolposition
protected DataviewTitles m_dataviewTitle
protected DataviewTitles m_dataviewSubtitle
protected DataviewTitles m_dataviewFootnote
protected CommonDataview m_commonDataview
protected boolean m_dataViewFormatSupported
protected javax.swing.JPanel titlePanel
protected javax.swing.JPanel footnotePanel
protected boolean printOrPreviewMode
protected java.util.Hashtable m_context
public static final java.lang.String above_title
public static final java.lang.String below_title
public Dataview()
New subclasses of this Dataview should also set a controller
and a model in their constructors.
public void setCommonDataview(CommonDataview commonDataview)
public void setPagingControlPosition(int loc)
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.setPagingControlPosition in interface DataviewAttributesloc - A constant that indicates the location for the paging control.
Constants begin with PAGING_CONTROL.public int getPagingControlPosition()
Dataview.getPagingControlPosition in interface DataviewAttributespublic 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 DataviewCommonsetTokenSubstitution in interface UIDataviewtoken - The token substitution handler for this view.public TokenSubstitution getTokenSubstitution()
TokenSubstitution.getTokenSubstitution in interface DataviewCommongetTokenSubstitution in interface UIDataviewTokenSubstitutionAdapter.public void setDataSource(DataSource ds)
Model class in a visualization bean represents the
DataSource to the view, but the DataSource
is the real source of the data.setDataSource in interface DataviewCommonds - The data source for this view.public DataSource getDataSource()
getDataSource in interface DataviewCommonDataSource for this view.
If no model or data source has been set for this view,
this method returns null.public DataviewTitles getDataviewTitle()
getDataviewTitle in interface DataviewCommongetDataviewTitle in interface UIDataviewpublic DataviewTitles getDataviewSubtitle()
getDataviewSubtitle in interface DataviewCommongetDataviewSubtitle in interface UIDataviewpublic DataviewTitles getDataviewFootnote()
getDataviewFootnote in interface DataviewCommongetDataviewFootnote in interface UIDataviewpublic void setDataDirector(DataDirector dd)
dd - The data director for this view.public DataDirector getDataDirector()
public void addControllerListener(ControllerListener l)
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.addControllerListener in interface UIViewl - The listener to add.ControllerListener.componentSelected(oracle.dss.dataView.ControllerEvent),
ControllerListenerAdapterpublic void removeControllerListener(ControllerListener l)
removeControllerListener in interface UIViewl - The listener to remove.public void addDataListener(DataListener l)
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.
l - The listener to add.DataListener.viewDrillRequesting(oracle.dss.dataView.DrillEvent),
DataListenerAdapterpublic void removeDataListener(DataListener l)
l - The listener to remove.public void addErrorHandler(ErrorHandler eh)
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.
addErrorHandler in interface ErrorHandlerCallbackeh - The error handler to use.public void removeErrorHandler()
Model.
The default error handler prints information to the console.removeErrorHandler in interface ErrorHandlerCallbackpublic ErrorHandler getErrorHandler()
DataviewCommongetErrorHandler in interface DataviewCommonpublic void addViewMouseListener(ViewMouseListener l)
ViewMouseListener to this view.l - The listener to add.public void removeViewMouseListener(ViewMouseListener l)
ViewMouseListener from this view.l - The listener to remove.public void addViewMouseMotionListener(ViewMouseMotionListener l)
ViewMouseMotionListener to this view.l - The listener to remove.public void removeViewMouseMotionListener(ViewMouseMotionListener l)
ViewMouseMotionListener from this view.l - The listener to remove.public void addViewKeyListener(ViewKeyListener l)
ViewKeyListener to this view.l - The listener to add.public void removeViewKeyListener(ViewKeyListener l)
ViewKeyListener from this view.l - The listener to remove.public void addViewFocusListener(ViewFocusListener l)
ViewFocusListener to this view.l - The listener to add.public void removeViewFocusListener(ViewFocusListener l)
ViewFocusListener from this view.l - The listener to remove.public void addViewListener(ViewListener l)
ViewListener to the listener list.l - The listener to add.public void removeViewListener(ViewListener l)
l - The listener to remove.public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
addPropertyChangeListener in class java.awt.Containerl - The listener to add.public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
removePropertyChangeListener in class java.awt.Componentl - The listener to remove.public void addVetoableChangeListener(java.beans.VetoableChangeListener l)
addVetoableChangeListener in class javax.swing.JComponentl - The listener to add.public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
removeVetoableChangeListener in class javax.swing.JComponentl - The listener to remove.public void setXMLValidated(boolean validate)
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.validate - true to have XML validated,
false to have the Dataview ignore invalid XML.setXML(java.lang.String, int)public boolean isXMLValidated()
Dataview validates XML against its DTD.true if the Dataview validates XML,
false if the Dataview applies XML without validation.protected void positionPagingControl(int location)
location - the location of the paging control with respect to the title and
subtitle, as specified by the PagingControlPosition propertyprotected void firePrintBegin(java.lang.Object source)
source - The source of the print event.source parameter in the event that
it creates.
It passes the event to the listeners.protected void firePrintEnd(java.lang.Object source)
source - source of the eventprotected void copyAdornment(BaseTitle to, BaseTitle from)
to - adornment to copy properties tofrom - adornment to copy properties fromprotected java.lang.Object getComponentFromID(int ID)
protected java.lang.String getNameFromID(int ID)
protected abstract void firePropertyChange(java.lang.Object obj,
java.lang.String propName,
java.lang.Object oldValue,
java.lang.Object newValue)
obj - the object which has the getter/setter for this propertypropName - the name of the property (minus get/set)oldValue - the previous value of the propertynewValue - the new value of the propertypublic abstract boolean selectObject(ComponentHandle id)
id - A ComponentHandle that represents the component to
select.true if the component is successfully selected,
false if not.public abstract ComponentHandle getSelectedObject()
getSelectedObject in interface UIViewComponentHandle.public abstract int getPresentationHeight()
public abstract int getPresentationWidth()
public final void setName(java.lang.String n)
setName in interface oracle.dss.presutil.CommonViewAttributessetName in class java.awt.Componentn - The name to use for this view.public final java.lang.String getName()
getName in interface oracle.dss.presutil.CommonViewAttributesgetName in class java.awt.Componentpublic final void setLocalName(java.lang.String n)
setLocalName in interface oracle.dss.presutil.CommonViewAttributesn - The local name of this view bean.public final java.lang.String getLocalName()
getLocalName in interface oracle.dss.presutil.CommonViewAttributespublic final void setDescription(java.lang.String n)
setDescription in interface oracle.dss.presutil.CommonViewAttributesn - The description to use for this view.public final java.lang.String getDescription()
getDescription in interface oracle.dss.presutil.CommonViewAttributespublic void setDrillingEnabled(boolean b)
setDrillingEnabled in interface DataviewAttributesb - true to enable drilling;
false to disable drilling.public final boolean isDrillingEnabled()
isDrillingEnabled in interface DataviewAttributestrue if drilling is enabled,
false if drilling is disabled.public boolean isDrillingSupported()
isDrillingSupported in interface DataviewAttributestrue if drilling is supported,
false if drilling is not supported.public void setPopupManager(PopupManager p)
p - The popup manager for this view.public PopupManager getPopupManager()
public void setRolloverTextManager(RolloverTextManager rm)
rm - The rollover text manager for this view.public RolloverTextManager getRolloverTextManager()
protected abstract void refreshData()
Dataview must implement this method.public abstract boolean isPrintOrPreviewMode()
public void modelDataChanged(DataChangedEvent e)
ModelListenermodelDataChanged in interface ModelListenere - Information about the data change.ModelAdapterModelAdapter class will call this method.
Application developers do not need to call this method.
public void modelDataAvailable(DataAvailableEvent e)
ModelListenermodelDataAvailable in interface ModelListenere - Information about the change in data availability.ModelAdapterModelAdapter class will call this method.
Application developers do not need to call this method.
public void modelWaitDataAvailable(WaitDataAvailableEvent e)
ModelListenermodelWaitDataAvailable in interface ModelListenere - Information about the fetch.Application developers do not need to call this method.
public void setWaitDataForRow(int row,
WaitData waitData)
setWaitDataForRow in interface DataviewCommonrow - 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 WaitData getWaitDataForRow(int row)
getWaitDataForRow in interface DataviewCommonrow - 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 clearWaitDataForAllRows()
Application developers do not need to call this method.
protected WaitData[] getWaitData()
public FontList getFontList()
getFontList in interface DataviewCommonpublic java.util.Vector getPhysicalComponents()
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.
public java.lang.String getIntlString(java.lang.String key)
getIntlString in interface DataviewCommonkey - the String that needs to be translated.public java.lang.String getIntlString(java.lang.String key,
java.util.ResourceBundle rBundle)
getIntlString in interface DataviewCommonkey - the String that needs to be translated.rBundle - the bundle to look inpublic void setModel(Model m)
m - the new model for the viewpublic Model getModel()
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.getModel in interface DataviewCommongetModel in interface UIViewModel for this Dataview.public void setController(Controller c)
c - the new controller for the viewpublic Controller getController()
Dataview.
In the Model-View-Controller architecture, the controller is
responsible for attending to mouse events and key events.Controller for this Dataview.public void updatePagingControlStyles()
Dataview.
The style manager calls this method whenever the style rules have
been updated, in order to apply the new styles.public void metadataStyleChanged()
metadataStyleChanged in interface DataviewCommonpublic void dataStyleChanged()
dataStyleChanged in interface DataviewCommonpublic void dataFormatChanged()
dataFormatChanged in interface DataviewCommonpublic void setLocale(java.util.Locale loc)
Locale for this Dataview.setLocale in class java.awt.Componentloc - The Locale for this Dataview.public java.util.Locale getLocale()
Locale that this Dataview uses.getLocale in interface DataviewCommongetLocale in interface UIViewgetLocale in class java.awt.ComponentLocale for this Dataview.public java.lang.String getXML(boolean allProperties)
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.
allProperties - true to retrieve XML for all properties,
false to retrieve XML only for
properties whose values are different from the
default property values.Dataview.public void writeXML(java.io.OutputStream stream,
boolean allProperties)
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.
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.protected void addSubcomponent(java.lang.Object s)
s - subcomponent objectprotected ViewComponent getSubcomponent(int id)
id - subcomponent id to findnull if notprotected ViewComponent getSubcomponent(java.lang.String name)
name - name to findnull if notpublic oracle.dss.pagingControl.ViewPagingControl getPagingControl()
null.public void setPagingControlVisible(boolean v)
setPagingControlVisible in interface DataviewAttributessetPagingControlVisible in interface DataviewCommonsetPagingControlVisible in interface PagingControlAttributesv - true to make the paging control visible,
false to hide it.public boolean isPagingControlVisible()
isPagingControlVisible in interface DataviewAttributesisPagingControlVisible in interface DataviewCommonisPagingControlVisible in interface PagingControlAttributestrue if the paging control appears in this view,
false if it does not.public abstract int getViewType()
Dataview.
This method is implemented in subclasses of Dataview.getViewType in interface DataviewCommongetViewType in interface UIViewDataviewConstants.VIEW_TYPE_CROSSTAB,
DataviewConstants.VIEW_TYPE_GRAPH,
DataviewConstants.VIEW_TYPE_TABLEpublic java.awt.Font scaleFont(java.awt.Font f,
int zoomFactor)
scaleFont in interface DataviewCommonf - 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 int getZoomFactor()
getZoomFactor in interface DataviewCommonscaleFont method.public void setEnabled(boolean enabled)
Dataview is enabled.
When a Dataview is disabled, it is visible, but users
cannot operate on the Dataview.setEnabled in class javax.swing.JComponentenabled - true to enable this Dataview,
false to disable it.public void setCustomColorsEnabled(boolean enabled)
setCustomColorsEnabled in interface UIViewenabled - true to enable custom color option on all color choice pickers
false to disable itpublic boolean isCustomColorsEnabled()
isCustomColorsEnabled in interface UIViewtrue custom color option is enabled on all color choice pickers
false custom color option is disabledpublic int convertComponentTypeToInteger(java.lang.String type)
ComponentTypeConverterString.convertComponentTypeToInteger in interface ComponentTypeConverterpublic java.lang.String convertComponentTypeToString(int type)
ComponentTypeConverterString representation of a view component,
from an integer.convertComponentTypeToString in interface ComponentTypeConvertertype - An identifier for a view component.public void resetToDefault(int reset)
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.
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.DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGprotected void resetToDefault(int reset,
java.lang.String version)
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.
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.DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGprotected void removeListeners(int reset)
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.DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGDataview.public abstract java.lang.String getVersion()
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
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:
Dataview without
resetting anything to default values
Dataview
Resetting returns property values in the Dataview to the
default values for the version that is specified in the XML.
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.true if the XML is successfully applied to
this Dataview,
false if an IO exception occurs.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.DataviewConstants.RESET_NONE,
DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGpublic 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
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:
Dataview without
resetting anything to default values
Dataview
Resetting returns property values in the Dataview to the
default values for the version that is specified in the XML.
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.true if the XML is successfully applied to
this Dataview,
false if an IO exception occurs.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.DataviewConstants.RESET_NONE,
DataviewConstants.RESET_XML_PROPERTIES,
DataviewConstants.RESET_EVERYTHINGprotected void setXML(oracle.dss.util.xml.ObjectNode node)
protected void setStyleXML(oracle.dss.util.xml.ObjectNode node)
public abstract void setSwapAllowed(boolean swap)
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.
swap - true to enable swapping,
false to disable it.isSwapAllowed(),
DataDirectorpublic abstract boolean isSwapAllowed()
true, then users can swap items
by clicking the two items.
When this method returns false, then users must move each
item separately.true if swapping is enabled,
false if it is not.setSwapAllowed(boolean)public void cleanUp()
public boolean isDataUnavailable()
public void initialize(java.util.Hashtable env)
oracle.dss.util.persistence.SimplePersistableContext interface in
JNDI.initialize in interface oracle.dss.util.persistence.SimplePersistableenv - Environment properties.protected abstract void setContext()
public abstract oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)
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.getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistableattrs - The searchable attributes that the application has
specified for this Dataview.PersistableAttributes that includes the application
specified attributes as well as the attributes that are
specific to this Dataview.public void setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)
Dataview itself can be used as
persistable attributes.setPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistableattrs - Any PersistableAttributes.public abstract boolean setXMLAsString(java.lang.String xml)
throws oracle.dss.util.persistence.BIPersistenceException
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.setXMLAsString in interface oracle.dss.util.persistence.StringXMLizablexml - The XML representation of the view.true if the XML was successfully set,
false if not.oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.readXML(java.io.InputStream, int),
setXML(java.lang.String, int)public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()
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.
getPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContractDataview, in an
AggregateInfo array.public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)
oracle.dss.util.persistence.contract.AggregableContractPersistable components that the
component aggregates.setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContractaggregates - a AggregateInfo[] value that represents the
components to assign to the view.public java.lang.String getXMLAsString()
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.
getXMLAsString in interface oracle.dss.util.persistence.StringXMLizableDataview.getXML(boolean),
writeXML(java.io.OutputStream, boolean)protected void setLoadingDataSourceFromPersistence(boolean bLoading)
bLoading - true if the data source is being loaded through
persistence, false otherwiseprotected boolean isLoadingDataSourceFromPersistence()
protected void createTitles()
protected void createFootnote()
protected oracle.dss.util.xml.ObjectNode getObjectNode(oracle.dss.util.xml.ObjectNode node,
boolean allProperties)
protected boolean getStyleXML(boolean allProperties,
oracle.dss.util.xml.ObjectNode node)
protected abstract oracle.dss.util.xml.ObjectNode getObjectNode(boolean allProperties)
protected abstract DataviewXML getViewXML()
protected void setDataUnformattedSupported(boolean supported)
public boolean isDataUnformattedSupported()
isDataUnformattedSupported in interface DataviewCommonpublic boolean isDataViewFormatSupported()
isDataViewFormatSupported in interface DataviewCommonprotected void setMetadataLongLabelSupported(boolean supported)
public boolean isMetadataLongLabelSupported()
protected void setMetadataMediumLabelSupported(boolean supported)
public boolean isMetadataMediumLabelSupported()
protected void setMetadataShortLabelSupported(boolean supported)
public boolean isMetadataShortLabelSupported()
isMetadataShortLabelSupported in interface DataviewCommonpublic boolean isMetadataViewStyleSupported()
isMetadataViewStyleSupported in interface DataviewCommonpublic void setMetadataViewStyleSupported(boolean supported)
protected void setMetadataValueSupported(boolean supported)
public boolean isMetadataValueSupported()
protected void setLayerMetaLongLabelSupported(boolean supported)
public boolean isLayerMetaLongLabelSupported()
protected void setLayerMetaMediumLabelSupported(boolean supported)
public boolean isLayerMetaMediumLabelSupported()
protected void setLayerMetaShortLabelSupported(boolean supported)
public boolean isLayerMetaShortLabelSupported()
isLayerMetaShortLabelSupported in interface DataviewCommonprotected void setLayerMetaNameSupported(boolean supported)
public boolean isLayerMetaNameSupported()
public void setLayerMetaViewStyleSupported(boolean supported)
public boolean isLayerMetaViewStyleSupported()
isLayerMetaViewStyleSupported in interface DataviewCommonpublic boolean isMemberMetadataLabelTypeSupported(java.lang.String type)
isMemberMetadataLabelTypeSupported in interface DataviewCommontype - type of member metadata labelpublic boolean isLayerMetadataLabelTypeSupported(java.lang.String type)
isLayerMetadataLabelTypeSupported in interface DataviewCommontype - type of layer metadata labelprotected boolean isJavaComponent()
public void setHTMLPagingControlAutosubmit(boolean autosubmit)
This property is used for the thin beans only.
setHTMLPagingControlAutosubmit in interface DataviewAttributessetHTMLPagingControlAutosubmit in interface DataviewCommonautosubmit - true to enable automatic submission,
false to disable it.public boolean isHTMLPagingControlAutosubmit()
isHTMLPagingControlAutosubmit in interface DataviewAttributesisHTMLPagingControlAutosubmit in interface DataviewCommontrue if automatic submission is enabled,
false if it is disabled.public void setHTMLPagingControlWidth(int width)
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.setHTMLPagingControlWidth in interface DataviewAttributessetHTMLPagingControlWidth in interface DataviewCommonwidth - The number of page items to display before wrapping.public int getHTMLPagingControlWidth()
getHTMLPagingControlWidth in interface DataviewAttributesgetHTMLPagingControlWidth in interface DataviewCommonpublic void setMemberMetadataLabelType(int edge,
java.lang.String type)
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.
setMemberMetadataLabelType in interface DataviewAttributesedge - 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".DataDirector.COLUMN_EDGE,
DataDirector.ROW_EDGE,
DataDirector.PAGE_EDGE,
MetadataMap.METADATA_LONGLABEL,
MetadataMap.METADATA_MEDIUMLABEL,
MetadataMap.METADATA_SHORTLABEL,
MetadataMap.METADATA_VALUE,
DataDirector.getSupportedMetadataMap()public java.lang.String getMemberMetadataLabelType(int edge)
METADATA_LONGLABEL.
Returns null if the specified edge is invalid.getMemberMetadataLabelType in interface DataviewAttributesgetMemberMetadataLabelType in interface DataviewCommonedge - 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_VALUEpublic void setLayerMetadataLabelType(int edge,
java.lang.String type)
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.
setLayerMetadataLabelType in interface DataviewAttributesedge - 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".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()public java.lang.String getLayerMetadataLabelType(int edge)
LAYER_METADATA_LONGLABEL.
Returns null if the given edge is invalid.getLayerMetadataLabelType in interface DataviewAttributesgetLayerMetadataLabelType in interface DataviewCommonedge - 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_NAMEpublic void setMemberMetadataLabelType(java.lang.String type)
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.
type - A constant that represents the type of metadata label to show.
Valid constants are listed in the See Also section.setMemberMetadataLabelType(int, String),
MetadataMap.METADATA_LONGLABEL,
MetadataMap.METADATA_MEDIUMLABEL,
MetadataMap.METADATA_SHORTLABEL,
MetadataMap.METADATA_VALUE,
DataDirector.getSupportedMetadataMap()public java.lang.String getMemberMetadataLabelType()
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.null if different
label types are used for different edges.getMemberMetadataLabelType(int),
MetadataMap.METADATA_LONGLABEL,
MetadataMap.METADATA_MEDIUMLABEL,
MetadataMap.METADATA_SHORTLABEL,
MetadataMap.METADATA_VALUEpublic void setLayerMetadataLabelType(java.lang.String type)
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.
type - A constant that represents the type of layer metadata label to show.
Valid constants are listed in the See Also section.setLayerMetadataLabelType(int, String),
LayerMetadataMap.LAYER_METADATA_LONGLABEL,
LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL,
LayerMetadataMap.LAYER_METADATA_SHORTLABEL,
LayerMetadataMap.LAYER_METADATA_NAME,
DataDirector.getSupportedLayerMetadataMap()protected void metadataLabelTypeChanged()
public java.lang.String getLayerMetadataLabelType()
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.null if
different edges use different label types.getLayerMetadataLabelType(int),
LayerMetadataMap.LAYER_METADATA_LONGLABEL,
LayerMetadataMap.LAYER_METADATA_MEDIUMLABEL,
LayerMetadataMap.LAYER_METADATA_SHORTLABEL,
LayerMetadataMap.LAYER_METADATA_NAMEpublic java.util.BitSet createPropertyOverrideFlags(int maxID)
createPropertyOverrideFlags in interface DataviewCommonpublic void setPropertyOverrideFlags(int attrID,
java.util.BitSet userFlags,
java.util.BitSet styleFlags)
setPropertyOverrideFlags in interface DataviewCommonpublic boolean isPropertyOverrideFlag(int attrID,
java.util.BitSet overrideFlags)
isPropertyOverrideFlag in interface DataviewCommonpublic void clearPropertyOverrideFlag(int attrID,
java.util.BitSet overrideFlags)
protected void setStyleOverrideMode(boolean flag)
protected boolean isStyleOverrideMode()
protected boolean isStyleModified()
protected void clearStyleModified()
protected void setUserOverrideMode(boolean flag)
protected boolean isUserOverrideMode()
public javax.swing.JPanel getTitlePanel()
public javax.swing.JPanel getFootnotePanel()