oracle.dss.graph.gui
Class GraphLayout

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.util.gui.layout.Layout
                                |
                                +--oracle.dss.graph.gui.GraphLayout

All Implemented Interfaces:

javax.accessibility.Accessible, DataDirectorListener, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class GraphLayout

extends Layout

implements HelpContext

Defines the Graph Layout panel. End users use the Graph Layout panel to specify how the data appears in the graph. For example, end users can use this panel to specify whether the different months are series or different groups.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Fields inherited from class oracle.dss.util.gui.layout.Layout

HIDDEN_EDGE, PAGEEDGEVISIBLE_CHANGED

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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 java.awt.image.ImageObserver

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

Constructor Summary

GraphLayout()
Constructor.

Method Summary

boolean	apply() Applies to the graph the layout changes that have been made to this panel.
void	cleanUp() Clean up memory and resources
java.lang.String	getApplicationName() Retrieves the name of the application that uses this panel.
java.lang.String	getDescriptionText() Retrieves the text that appears at the top of this layout panel.
ErrorHandler	getErrorHandler() Retrieves the error handler that this GraphLayoutPanel uses.
java.lang.String	getErrorString() Retrieves a message that explains the failure of a call to the apply method.
java.lang.String	getHelpContextID() Retrieves the Help context ID for this panel.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Gets the Help provider for this panel.
LayoutAccess	getLayoutAccess() Retrieves the LayoutAccess for this GraphLayout.
java.lang.String	getMeasureText() Retrieves the text that this panel displays to describe measures.
void	hidePagingControlOptions() Hides the option for showing or hiding the paging control.
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setApplicationName(java.lang.String name) Specifies the name of application that uses this panel.
void	setErrorHandler(ErrorHandler eh) Specifies an error handler for this GraphLayout.
void	setGraph(UIGraph graph) Specifies the graph whose properties this panel sets.
void	setHelpContextID(java.lang.String strHelpContextID) Sets the Help context ID for this panel.
void	setHelpEnabled(boolean bValue) Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Sets the Help provider for this panel.
void	setImageComponent(javax.swing.JComponent comp) Specifies the component to display in the image portion of the Graph Layout panel.
void	setLayoutContext(LayoutContext lc) Specifies the LayoutContext for this Layout.
boolean	setLayoutContext(LayoutContext lc, boolean showDialog, java.awt.Component c) Specifies the LayoutContext for this GraphLayout.
void	setLocale(java.util.Locale loc) Specifies the current Locale that this panel uses.
void	setMeasureText(java.lang.String text) Specifies the text that this panel should display to describe measures.

Methods inherited from class oracle.dss.util.gui.layout.Layout

addLayoutPivotingListener, getLayoutContext, isHideAvailable, isPagingControlVisible, removeLayoutPivotingListener, setDescriptionText, setHideAvailable, setLayoutAccess, setPagingControlVisible, viewDataAvailable, viewDataChanged, waitDataAvailable

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphLayout

public GraphLayout()

Constructor.

Method Detail

getDescriptionText

public java.lang.String getDescriptionText()

Retrieves the text that appears at the top of this layout panel. This text comes from the resource bundle, and so is translatable.

Overrides:

getDescriptionText in class Layout

Returns:

The description text.

setApplicationName

public void setApplicationName(java.lang.String name)

Specifies the name of application that uses this panel. Passing the name of your application to this message ensures that alerts that this panel produces are labeled as coming from your application.

Parameters:

name - The name to display in alerts that this panel produces. In localized versions, pass a localized String.

getApplicationName

public java.lang.String getApplicationName()

Retrieves the name of the application that uses this panel. This is the application that alerts appear to come from.

Returns:

The name of the application that uses this panel.

setGraph

public void setGraph(UIGraph graph)

Specifies the graph whose properties this panel sets. This panel gets information from the UIGraph that is specified in this method.

Parameters:

graph - The graph whose properties this panel sets.

getLayoutAccess

public LayoutAccess getLayoutAccess()

Retrieves the LayoutAccess for this GraphLayout. This method updated the LayoutAccess with the changes that the user has made. Then it returns the LayoutAccess.

Overrides:

getLayoutAccess in class Layout

Returns:

The updated LayoutAccess that this panel uses.

apply

public boolean apply()

Applies to the graph the layout changes that have been made to this panel. Normally, you call this method in the listener for the container's OK button.

If this method returns false, then you should not dispose of this panel. Instead, display an error message dialog that prompts the user to correct the problem. To find the reason that the changes could not be made, call the getErrorString method.

Overrides:

apply in class Layout

Returns:

true if the operation is successful, false if the changes could not be applied.

See Also:

getErrorString()

setLayoutContext

public void setLayoutContext(LayoutContext lc)

Specifies the LayoutContext for this Layout.

Overrides:

setLayoutContext in class Layout

setLayoutContext

public boolean setLayoutContext(LayoutContext lc,
                                boolean showDialog,
                                java.awt.Component c)

Specifies the LayoutContext for this GraphLayout.

Parameters:

lc - the LayoutContext

showDialog - if true shows error dialog if there are insuffient number of measures. if false, does not show any error dialog.

c - the parent component to host the error dialog. If null, the error dialog will will be displayed in the center of the window.

Returns:

returns true if there are sufficient number of measures. false if there are insufficient number of measures.

setMeasureText

public void setMeasureText(java.lang.String text)

Specifies the text that this panel should display to describe measures. By default, this text is "Measures:". If your application uses a different term, then call this method to have this layout panel display the term that you use.

For localized versions of your application, pass a localized String to this method.

Call this method before you call the setLayoutContext method.

Parameters:

text - The text to display instead of "Measures".

See Also:

Layout.setLayoutContext(oracle.dss.util.LayoutContext)

getMeasureText

public java.lang.String getMeasureText()

Retrieves the text that this panel displays to describe measures.

Returns:

The text that is displayed instead of "Measures".

getErrorString

public java.lang.String getErrorString()

Retrieves a message that explains the failure of a call to the apply method. If the apply method returns false, then call this method to get a message that explains why apply returned false.

Returns:

Text that explains why a call to apply failed.

See Also:

apply()

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies an error handler for this GraphLayout. If an error handler has been set, then this GraphLayout reports error conditions to the handler. Otherwise, it prints the stack trace.

Overrides:

setErrorHandler in class Layout

Parameters:

eh - The error handler that this panel should use.

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the error handler that this GraphLayoutPanel uses.

Returns:

The error handler for this panel, or null if no error handler has been set.

setImageComponent

public void setImageComponent(javax.swing.JComponent comp)

Specifies the component to display in the image portion of the Graph Layout panel.

Parameters:

comp - the JComponent

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that this panel uses.

Overrides:

setLocale in class Layout

Parameters:

loc - The current Locale.

hidePagingControlOptions

public void hidePagingControlOptions()

Hides the option for showing or hiding the paging control. By default, users can specify whether the paging control appears with the view. If you want to hide the paging control and not let users display it, then call this method.

getHelpContextID

public java.lang.String getHelpContextID()

Retrieves the Help context ID for this panel. The Help context ID is the full class path for this panel. This Help context ID is used when listening for the user event to display Help for this panel.

Specified by:

getHelpContextID in interface HelpContext

Overrides:

getHelpContextID in class Layout

Returns:

The Help context ID for this panel.

setHelpContextID

public void setHelpContextID(java.lang.String strHelpContextID)

Sets the Help context ID for this panel.

Specified by:

setHelpContextID in interface HelpContext

Overrides:

setHelpContextID in class Layout

Following copied from interface: oracle.dss.util.help.HelpContext

Parameters:

strHelpContextID - a String value that represents the Help context ID.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Sets the Help provider for this panel.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Gets the Help provider for this panel.

setHelpEnabled

public void setHelpEnabled(boolean bValue)

Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, this panel has a Legend Font button that displays a Font dialog box. The Font dialog box displays a Help button by default. Setting the parameter value of this method to false would hide that Help button.

Overrides:

setHelpEnabled in class Layout

Parameters:

bValue - true to display the Help button, false to hide it.

isHelpEnabled

public boolean isHelpEnabled()

Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, this panel has a Legend Font button that displays a Font dialog box. The Font dialog box displays a Help button by default. If the return value of this method is false, then that Help button is hidden.

Overrides:

isHelpEnabled in class Layout

Returns:

true if the Help button is displayed, false if it is hidden.

cleanUp

public void cleanUp()

Clean up memory and resources