com.ontimize.gui
Class ApplicationToolBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JToolBar
                  com.ontimize.gui.ApplicationToolBar

All Implemented Interfaces:

javax.accessibility.Accessible, FormComponent, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class ApplicationToolBar

extends javax.swing.JToolBar

implements FormComponent

This class implements a general toolbar for application.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JToolBar

javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

static int	DEFAULT_BUTTON_SIZE The toolbar button size.
static int	DEFAULT_TOOLBAR_HEIGHT
protected int	height
protected java.util.ResourceBundle	resources The reference to resource bundle file.
protected java.awt.TexturePaint	texturePaint

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.field.FormComponent

DEBUG

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, 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

ApplicationToolBar(java.util.Hashtable parameters)
The class constructor.

Method Summary

void	add(java.awt.Component c, java.lang.Object constraints)
javax.swing.AbstractButton	getButton(java.lang.String attr) Returns the reference to button specified.
javax.swing.JComponent	getComponent(java.lang.String attr) Returns the reference to component specified.
java.lang.Object	getConstraints(java.awt.LayoutManager layout) Description method to return the constraints component to place correctly in parent container.
java.lang.String	getHelpIdString() Gets the help identifier.
java.awt.Dimension	getPreferredSize()
java.util.Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
int	getToolbarHeight()
void	init(java.util.Hashtable parameters) Inits parameters.
void	installHelpId() Install the help identifier.
boolean	isToolbarHeightFix()
protected void	paintComponent(java.awt.Graphics g)
void	setComponentLocale(java.util.Locale l)
void	setFloatable(boolean floatable)
void	setResourceBundle(java.util.ResourceBundle resources) Sets the language resource bundle.

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setLayout, setMargin, setOrientation, setRollover, 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, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ontimize.gui.field.FormComponent

isEnabled, setEnabled, setVisible

Field Detail

DEFAULT_BUTTON_SIZE

public static int DEFAULT_BUTTON_SIZE

The toolbar button size. By default, 24.

DEFAULT_TOOLBAR_HEIGHT

public static int DEFAULT_TOOLBAR_HEIGHT

height

protected int height

resources

protected java.util.ResourceBundle resources

The reference to resource bundle file. By default, null.

texturePaint

protected java.awt.TexturePaint texturePaint

Constructor Detail

ApplicationToolBar

public ApplicationToolBar(java.util.Hashtable parameters)

The class constructor. Calls to super() and initializes parameters.

Parameters:

parameters - the Hashtable with parameters

Method Detail

getHelpIdString

public java.lang.String getHelpIdString()

Gets the help identifier.

Returns:

the help identifier

setFloatable

public void setFloatable(boolean floatable)

installHelpId

public void installHelpId()

Install the help identifier.

init

public void init(java.util.Hashtable parameters)

Inits parameters.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters. Adds the next parameters:

attribute	values	default	required	meaning
floatable	yes/no	no	no	Supports the change of the toolbar location.
buttonsize		24	no	Button size for toolbar.
opaque	yes/no	yes	no	The opacity for toolbar container.
border	default/none/raised/lowered or a color defined in ColorConstants. Moreover, it is also allowed a border defined in #BorderManager		no	The border for toolbar
bgcolor			no	The background color.
toolbarheight			no	The toolbar height. If this parameter doesn't established the toolbar height is calculated using toolbarbutton heights.
textureimage			no	Path to source icon to extract a image and create a TexturePaint

paintComponent

protected void paintComponent(java.awt.Graphics g)

isToolbarHeightFix

public boolean isToolbarHeightFix()

getToolbarHeight

public int getToolbarHeight()

getPreferredSize

public java.awt.Dimension getPreferredSize()

getConstraints

public java.lang.Object getConstraints(java.awt.LayoutManager layout)

Description copied from interface: FormComponent

Description method to return the constraints component to place correctly in parent container.

Specified by:

getConstraints in interface FormComponent

Parameters:

layout - the parent container reference

Returns:

the constraints for the component

getButton

public javax.swing.AbstractButton getButton(java.lang.String attr)

Returns the reference to button specified.

Parameters:

attr - the attribute

Returns:

the reference to button

getComponent

public javax.swing.JComponent getComponent(java.lang.String attr)

Returns the reference to component specified.

Parameters:

attr - the attribute

Returns:

the reference to component

add

public void add(java.awt.Component c,
                java.lang.Object constraints)

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resources)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Parameters:

resources - the new language bundle.

setComponentLocale

public void setComponentLocale(java.util.Locale l)

Specified by:

setComponentLocale in interface Internationalization

getTextsToTranslate

public java.util.Vector getTextsToTranslate()

Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:

all the texts in the element suitable for being translated.