com.ontimize.gui
Class ApToolBarNavigator

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ontimize.gui.ApToolBarNavigator

All Implemented Interfaces:

javax.accessibility.Accessible, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, java.io.Serializable

public class ApToolBarNavigator

extends javax.swing.JPanel

implements FormComponent, IdentifiedElement, SecureElement, Internationalization

This class implements a navigation bar in application toolbar like a browser, to move between last visited forms. It is composed by three buttons, to see the previous, the next and the list of recent forms.

Since:

5.2057EN-1.0

Author:

Imatia Innovation SL

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

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

protected java.awt.event.ActionListener	actionListButton
protected java.awt.event.ActionListener	actionNextButton
protected java.awt.event.ActionListener	actionPrevButton
protected java.lang.String	attribute
protected boolean	borderbuttons
protected int	currentSelectedItem
static javax.swing.border.Border	defaultButtonsBorder
static boolean	defaultEnabledShorcuts
static java.lang.String	defaultListIconPath
static java.lang.String	defaultNextIconPath
static java.lang.String	defaultPrevIconPath
boolean	enabledShorcuts
protected java.lang.String	formManager
protected boolean	highlightButtons
java.util.List	keyBindings
static java.lang.String	LIST_BUTTON_BUNDLE_KEY
protected ButtonSelection	listButton
protected java.lang.String	listButtonKey
protected java.lang.String	listButtonPath
protected java.awt.event.MouseAdapter	listenerHighlightButtons
protected javax.swing.Icon	listIcon
boolean	navigationHasStarted When navigation process has not started, we must set the navigation position to the end of last visited formmanager vector.
static java.lang.String	NEXT_BUTTON_BUNDLE_KEY
protected javax.swing.AbstractButton	nextButton
protected java.lang.String	nextButtonKey
protected java.lang.String	nextButtonPath
protected javax.swing.Icon	nextIcon
protected boolean	opaquebuttons
protected javax.swing.JPopupMenu	popupMenu
static java.lang.String	PREV_BUTTON_BUNDLE_KEY
protected javax.swing.AbstractButton	prevButton
protected java.lang.String	prevButtonKey
protected java.lang.String	prevButtonPath
protected javax.swing.Icon	prevIcon

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 com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ApToolBarNavigator(java.util.Hashtable parameters)

Method Summary

java.util.Vector	addButtons()
protected void	changeButtons(java.util.Vector buttons, boolean borderbuttons, boolean opaquebuttons, java.awt.event.MouseListener listenerHighlightButtons)
void	checkbuttons()
void	checkSelection()
void	createComponent()
java.lang.Object	getAttribute() Gets the object attribute.
java.lang.Object	getConstraints(java.awt.LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
java.awt.Dimension	getMaximumSize()
java.awt.Dimension	getMinimumSize()
java.util.Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(java.util.Hashtable parameters) This method gets the Hashtable and fixes parameters for navigation toolbar
void	initPermissions()
boolean	isEnabled() Description method to check when a component is or not enabled.
boolean	isRestricted()
void	moveBack()
void	moveForward()
void	moveInList(java.awt.event.ActionEvent e)
void	registerNavigationEvents()
void	setActionListeners()
void	setComponentLocale(java.util.Locale l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setResourceBundle(java.util.ResourceBundle resourceBundle) Sets the language resource bundle.
void	setVisible(boolean visible) Description method to set visible or not the component according the boolean condition in parameter.
protected void	unselectall()
void	updateComboList(java.lang.String formManager)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, getNextFocusableComponent, getPreferredSize, 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, paintBorder, paintChildren, paintComponent, 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, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, setLayout, 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, 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

Field Detail

defaultEnabledShorcuts

public static boolean defaultEnabledShorcuts

PREV_BUTTON_BUNDLE_KEY

public static final java.lang.String PREV_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

NEXT_BUTTON_BUNDLE_KEY

public static final java.lang.String NEXT_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

LIST_BUTTON_BUNDLE_KEY

public static final java.lang.String LIST_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

defaultButtonsBorder

public static javax.swing.border.Border defaultButtonsBorder

defaultPrevIconPath

public static java.lang.String defaultPrevIconPath

defaultNextIconPath

public static java.lang.String defaultNextIconPath

defaultListIconPath

public static java.lang.String defaultListIconPath

attribute

protected java.lang.String attribute

prevButtonPath

protected java.lang.String prevButtonPath

prevIcon

protected javax.swing.Icon prevIcon

prevButton

protected javax.swing.AbstractButton prevButton

prevButtonKey

protected java.lang.String prevButtonKey

nextButtonPath

protected java.lang.String nextButtonPath

nextIcon

protected javax.swing.Icon nextIcon

nextButton

protected javax.swing.AbstractButton nextButton

nextButtonKey

protected java.lang.String nextButtonKey

listIcon

protected javax.swing.Icon listIcon

listButton

protected ButtonSelection listButton

listButtonKey

protected java.lang.String listButtonKey

listButtonPath

protected java.lang.String listButtonPath

enabledShorcuts

public boolean enabledShorcuts

borderbuttons

protected boolean borderbuttons

opaquebuttons

protected boolean opaquebuttons

highlightButtons

protected boolean highlightButtons

listenerHighlightButtons

protected java.awt.event.MouseAdapter listenerHighlightButtons

actionNextButton

protected java.awt.event.ActionListener actionNextButton

actionPrevButton

protected java.awt.event.ActionListener actionPrevButton

actionListButton

protected java.awt.event.ActionListener actionListButton

formManager

protected java.lang.String formManager

popupMenu

protected javax.swing.JPopupMenu popupMenu

currentSelectedItem

protected int currentSelectedItem

navigationHasStarted

public boolean navigationHasStarted

When navigation process has not started, we must set the navigation position to the end of last visited formmanager vector.

keyBindings

public java.util.List keyBindings

Constructor Detail

ApToolBarNavigator

public ApToolBarNavigator(java.util.Hashtable parameters)

Method Detail

registerNavigationEvents

public void registerNavigationEvents()

setActionListeners

public void setActionListeners()

moveBack

public void moveBack()

moveForward

public void moveForward()

moveInList

public void moveInList(java.awt.event.ActionEvent e)

init

public void init(java.util.Hashtable parameters)

This method gets the Hashtable and fixes parameters for navigation toolbar

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	The attribute for component.
prevbutton			no	Path for previous button icon.
nextbutton			no	Path for next button icon.
listbutton			no	Path for button that shows the first form
size		120;40	no	Size for component
borderbuttons	default/none/raised/lowered or a color defined in ColorConstants. Moreover, it is also allowed a border defined in #BorderManager		no	The border for buttons in Form
highlightbuttons	yes/no	no	no	Sets the highlight in button property when mouse is entered. See AbstractButton#setContentAreaFilled(boolean)). This parameter requires opaque='no'.
opaquebuttons	yes/no	no	no	Data field opacity condition for Form buttons
maxpopupelements		15	no	Maximum number of elements of popup that is displayed
opaque	yes/no	no	no	Opacity condition for toolbar

checkSelection

public void checkSelection()

unselectall

protected void unselectall()

checkbuttons

public void checkbuttons()

createComponent

public void createComponent()

addButtons

public java.util.Vector addButtons()

updateComboList

public void updateComboList(java.lang.String formManager)

isEnabled

public boolean isEnabled()

Description copied from interface: FormComponent

Description method to check when a component is or not enabled.

Specified by:

isEnabled in interface FormComponent

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FormComponent

Description method to set enabled or not the component according the boolean condition in parameter.

Specified by:

setEnabled in interface FormComponent

setVisible

public void setVisible(boolean visible)

Description copied from interface: FormComponent

Description method to set visible or not the component according the boolean condition in parameter.

Specified by:

setVisible in interface FormComponent

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.

setComponentLocale

public void setComponentLocale(java.util.Locale l)

Specified by:

setComponentLocale in interface Internationalization

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resourceBundle)

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:

resourceBundle - the new language bundle.

changeButtons

protected void changeButtons(java.util.Vector buttons,
                             boolean borderbuttons,
                             boolean opaquebuttons,
                             java.awt.event.MouseListener listenerHighlightButtons)

getAttribute

public java.lang.Object getAttribute()

Description copied from interface: IdentifiedElement

Gets the object attribute. This attribute allows to identify the object

Specified by:

getAttribute in interface IdentifiedElement

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement

getConstraints

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

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:

parentLayout - the parent container reference

Returns:

the constraints for the component

getMinimumSize

public java.awt.Dimension getMinimumSize()

getMaximumSize

public java.awt.Dimension getMaximumSize()