oracle.dss.dataView.gui
Class ToolBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JToolBar
                          |
                          +--oracle.dss.dataView.gui.ToolBar

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, javax.swing.SwingConstants

Direct Known Subclasses:

GraphToolBar, GridViewToolBar

public class ToolBar

extends javax.swing.JToolBar

implements java.beans.PropertyChangeListener

The toolbar for a UIDataview. By default, the toolbar is empty.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JToolBar

javax.swing.JToolBar.Separator

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ToolBar()
Constructor that does not specify a UIDataview.

ToolBar(UIDataview dataView)
Constructor that specifies a UIDataview.

Method Summary

java.awt.Component	add(java.awt.Component tool) Adds a tool to this toolbar.
void	addComDataviewTools() Adds a pre-defined set of commonly used tools to the toolbar.
void	cleanUp() Cleans up the memory of this toolbar.
UIDataview	getDataView() Retrieves the current view with which this toolbar is used.
boolean	isRolloverIconEnabled() Indicates whether a larger versions of icons in this ToolBar appear when the mouse is over the icons.
void	remove(java.awt.Component tool) Removes a tool from this toolbar.
void	setDataView(UIDataview dataView) Specifies the UIDataview with which to use this Toolbar.
void	setLocale(java.util.Locale loc) Specifies the locale for this ToolBar.
void	setRolloverIconEnabled(boolean bEnabled) Specifies whether to use large icons when the mouse is over a tool.
void	update() Updates each tool to correspond with the currently selected object.

Methods inherited from class javax.swing.JToolBar

add, addSeparator, addSeparator, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, setBorderPainted, setFloatable, setMargin, setOrientation, setUI, 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, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, 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 java.beans.PropertyChangeListener

propertyChange

Constructor Detail

ToolBar

public ToolBar()

Constructor that does not specify a UIDataview. If you use this constructor, then call the setDataView method to specify the UIDataview that uses this ToolBar.

See Also:

setDataView(oracle.dss.dataView.UIDataview)

ToolBar

public ToolBar(UIDataview dataView)

Constructor that specifies a UIDataview.

Parameters:

dataView - The UIDataview whose properties this ToolBar changes.

Method Detail

setDataView

public void setDataView(UIDataview dataView)

Specifies the UIDataview with which to use this Toolbar.

Parameters:

dataView - The view with which you want to use this Toolbar.

getDataView

public UIDataview getDataView()

Retrieves the current view with which this toolbar is used.

Returns:

The current view with which this toolbar is used.

setLocale

public void setLocale(java.util.Locale loc)

Specifies the locale for this ToolBar. The ToolBar, in turn, sets the locale on each of its tools.

Overrides:

setLocale in class java.awt.Component

Parameters:

loc - The locale for this ToolBar.

update

public void update()

Updates each tool to correspond with the currently selected object. This method calls the update method of each tool in this toolbar.

setRolloverIconEnabled

public void setRolloverIconEnabled(boolean bEnabled)

Specifies whether to use large icons when the mouse is over a tool. This method, in turn, calls the setRolloverIconEnabled method of each of its tools to specify the icon type.

By default, the toolbar uses a raised or lowered look.

Parameters:

bEnabled - true to use larger icons, false to use a raised or lowered look instead.

isRolloverIconEnabled

public boolean isRolloverIconEnabled()

Indicates whether a larger versions of icons in this ToolBar appear when the mouse is over the icons.

Returns:

true if a larger icon appears when the mouse is over a tool icon, false if a raised or lowered look appears instead.

add

public java.awt.Component add(java.awt.Component tool)

Adds a tool to this toolbar. The tool must implement the DataviewTool interface.

Overrides:

add in class java.awt.Container

Parameters:

tool - The tool that you want to add to this toolbar.

Returns:

The tool that you just added to this toolbar.

See Also:

DataviewTool

remove

public void remove(java.awt.Component tool)

Removes a tool from this toolbar.

Overrides:

remove in class java.awt.Container

Parameters:

tool - The tool that you want to remove from the toolbar.

cleanUp

public void cleanUp()

Cleans up the memory of this toolbar. Call this method to start over with a fresh toolbar.

addComDataviewTools

public void addComDataviewTools()

Adds a pre-defined set of commonly used tools to the toolbar. The following table describes the tools that this method adds to the toolbar:

Toolbar tool	Description
FontNameTool	Specifies the font name for the text of the selected object, such as Serif or San Serif
FontSizeTool	Specifies the font size for the text of the selected object, such as 8, 10, 12, and so on
BoldFontTool	Specifies whether the text of the selected object is bold
ItalicFontTool	Specifies whether the text of the selected object is italicized
HorizontalAlignmentTool	A set of three alignment tools that specify whether the text of the selected object is aligned left, center, or right.