oracle.dss.graph.gui
Class GraphType

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.graph.gui.BasePanel
                                |
                                +--oracle.dss.graph.gui.GraphType

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, HelpContext, java.awt.image.ImageObserver, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, java.io.Serializable

public class GraphType

extends BasePanel

implements javax.swing.event.ListSelectionListener, HelpContext

Defines the Graph Type panel. End users use the Graph Type panel to select a graph type category for their graph. Graph type categories contain subtypes that specialize the display of a graph. For example, the graph subtypes Pie and Multiple Pie belong to the graph type category Pie. The subtypes correspond to the values of the GraphType property in the Graph class. This class maintains a list of graph types that are available to the user.

This class fires propertyChange events for every property that is exposed in this panel.

See Also:

DOUBLE_CLICK, SUBTYPE_CHANGED, TYPE_CHANGED, Graph.setGraphType(int), Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static java.lang.String	DOUBLE_CLICK Property to listen for when the user double-clicks a graph subtype icon.
static java.lang.String	SUBTYPE_CHANGED Property name to listen for when the subtype is changed.
static java.lang.String	TYPE_CHANGED Property name to listen for when the type is 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

GraphType(UIGraph graph)
Constructor.

Method Summary

void	apply() Applies to the graph the changes that have been made in this panel.
void	cleanUp() Clean up memory and resources used by GraphType panel
int	getCurrentSubtype() Retrieves the index of the currently selected Subtype.
int	getCurrentType() Retrieves the index of the currently selected Type.
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.
java.awt.Dimension	getMinimumSize() Retrieves the minimum size of the Graph Type panel.
java.awt.Dimension	getPreferredSize() Retrieves the size at which the Graph Type panel looks best.
boolean	isHelpEnabled() Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
void	refresh() Refreshes the Graph Type panel to reflect any changes that have been made in the panel.
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	setLocale(java.util.Locale loc) Specifies the current Locale that the graph uses.

Methods inherited from class oracle.dss.graph.gui.BasePanel

createSeparator, setTitleText

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, getNextFocusableComponent, 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

Methods inherited from interface javax.swing.event.ListSelectionListener

valueChanged

Field Detail

DOUBLE_CLICK

public static final java.lang.String DOUBLE_CLICK

Property to listen for when the user double-clicks a graph subtype icon. This action selects the subtype.

SUBTYPE_CHANGED

public static final java.lang.String SUBTYPE_CHANGED

Property name to listen for when the subtype is changed. To apply this change, the apply method of this panel sets the GraphType property of the graph.

See Also:

Graph.setGraphType(int)

TYPE_CHANGED

public static final java.lang.String TYPE_CHANGED

Property name to listen for when the type is changed. When a user selects a different type, this panel refreshes the subtype box so that it displays the subtypes that belong to the new type.

Constructor Detail

GraphType

public GraphType(UIGraph graph)

Constructor.

Parameters:

graph - The graph to which this panel belongs.

Method Detail

setGraph

public void setGraph(UIGraph graph)

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

Overrides:

setGraph in class BasePanel

Parameters:

graph - The graph whose properties this panel sets.

cleanUp

public void cleanUp()

Clean up memory and resources used by GraphType panel

Overrides:

cleanUp in class BasePanel

getCurrentType

public int getCurrentType()

Retrieves the index of the currently selected Type.

Returns:

The index of the currently selected Type.

See Also:

Type

getCurrentSubtype

public int getCurrentSubtype()

Retrieves the index of the currently selected Subtype.

Returns:

The index of the currently selected Subtype.

See Also:

Subtype

refresh

public void refresh()

Refreshes the Graph Type panel to reflect any changes that have been made in the panel. Call this method after each call to the addType method or the removeType method.

See Also:

GraphTypeConverterAdapter.addType(oracle.dss.graph.Type), GraphTypeConverterAdapter.removeType(int)

setLocale

public void setLocale(java.util.Locale loc)

Specifies the current Locale that the graph uses.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The current Locale.

apply

public void apply()

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

Overrides:

apply in class BasePanel

getPreferredSize

public java.awt.Dimension getPreferredSize()

Retrieves the size at which the Graph Type panel looks best. The size is expressed as a Dimension object. If no panel size has been specified, then the preferred size is the default size of the panel.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

A Dimension object that specifies the size for the Graph Type panel.

getMinimumSize

public java.awt.Dimension getMinimumSize()

Retrieves the minimum size of the Graph Type panel. The minimum size is the smallest size that the panel can be made without truncating its components in the UI. The size is expressed as a Dimension object.

Overrides:

getMinimumSize in class javax.swing.JComponent

Returns:

A Dimension object that specifies the smallest size that the panel can be made without truncating its components in the UI.

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

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

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.

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.

Returns:

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