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:

FormComponent, IdentifiedElement, Internationalization, SecureElement, ImageObserver, MenuContainer, Serializable, Accessible

public class ApToolBarNavigator
extends 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/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionListener	actionListButton
protected ActionListener	actionNextButton
protected ActionListener	actionPrevButton
protected String	attribute
protected boolean	borderbuttons
protected int	currentSelectedItem
static boolean	defaultBorderButtons
static Border	defaultButtonsBorder
static boolean	defaultEnabledShorcuts
static boolean	defaultHighlightButtons
static String	defaultListIconPath
static String	defaultNextIconPath
static boolean	defaultOpaque
static boolean	defaultOpaqueButtons
static String	defaultPrevIconPath
boolean	enabledShorcuts
protected String	formManager
protected boolean	highlightButtons
List	keyBindings
static String	LIST_BUTTON_BUNDLE_KEY
protected ButtonSelection	listButton
protected String	listButtonKey
protected String	listButtonPath
protected MouseAdapter	listenerHighlightButtons
protected 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 String	NEXT_BUTTON_BUNDLE_KEY
protected AbstractButton	nextButton
protected String	nextButtonKey
protected String	nextButtonPath
protected Icon	nextIcon
protected boolean	opaquebuttons
protected JPopupMenu	popupMenu
static String	PREV_BUTTON_BUNDLE_KEY
protected AbstractButton	prevButton
protected String	prevButtonKey
protected String	prevButtonPath
protected 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.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

Constructors

Constructor and Description
ApToolBarNavigator(Hashtable parameters)

Method Summary

Methods

Modifier and Type	Method and Description
Vector	addButtons()
protected void	changeButtons(Vector buttons, boolean borderbuttons, boolean opaquebuttons, MouseListener listenerHighlightButtons)
void	checkbuttons()
void	checkSelection()
void	createComponent()
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
Dimension	getMaximumSize()
Dimension	getMinimumSize()
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(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(ActionEvent e)
void	registerNavigationEvents()
void	setActionListeners()
void	setComponentLocale(Locale l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setResourceBundle(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(String formManager)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, 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 String PREV_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

NEXT_BUTTON_BUNDLE_KEY

public static final String NEXT_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

LIST_BUTTON_BUNDLE_KEY

public static final String LIST_BUTTON_BUNDLE_KEY

See Also:

Constant Field Values

defaultButtonsBorder

public static Border defaultButtonsBorder

defaultPrevIconPath

public static String defaultPrevIconPath

defaultNextIconPath

public static String defaultNextIconPath

defaultListIconPath

public static String defaultListIconPath

defaultOpaque

public static boolean defaultOpaque

defaultBorderButtons

public static boolean defaultBorderButtons

defaultOpaqueButtons

public static boolean defaultOpaqueButtons

defaultHighlightButtons

public static boolean defaultHighlightButtons

attribute

protected String attribute

prevButtonPath

protected String prevButtonPath

prevIcon

protected Icon prevIcon

prevButton

protected AbstractButton prevButton

prevButtonKey

protected String prevButtonKey

nextButtonPath

protected String nextButtonPath

nextIcon

protected Icon nextIcon

nextButton

protected AbstractButton nextButton

nextButtonKey

protected String nextButtonKey

listIcon

protected Icon listIcon

listButton

protected ButtonSelection listButton

listButtonKey

protected String listButtonKey

listButtonPath

protected String listButtonPath

enabledShorcuts

public boolean enabledShorcuts

borderbuttons

protected boolean borderbuttons

opaquebuttons

protected boolean opaquebuttons

highlightButtons

protected boolean highlightButtons

listenerHighlightButtons

protected MouseAdapter listenerHighlightButtons

actionNextButton

protected ActionListener actionNextButton

actionPrevButton

protected ActionListener actionPrevButton

actionListButton

protected ActionListener actionListButton

formManager

protected String formManager

popupMenu

protected 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 List keyBindings

Constructor Detail

ApToolBarNavigator

public ApToolBarNavigator(Hashtable parameters)

Method Detail

registerNavigationEvents

public void registerNavigationEvents()

setActionListeners

public void setActionListeners()

moveBack

public void moveBack()

moveForward

public void moveForward()

moveInList

public void moveInList(ActionEvent e)

init

public void init(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 Vector addButtons()

updateComboList

public void updateComboList(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

Overrides:

isEnabled in class Component

Returns:

the enabled condition

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

Overrides:

setEnabled in class JComponent

Parameters:

enabled - the enabled condition

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

Overrides:

setVisible in class JComponent

Parameters:

visible - the visibility condition

getTextsToTranslate

public 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(Locale l)

Specified by:

setComponentLocale in interface Internationalization

setResourceBundle

public void setResourceBundle(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(Vector buttons,
                 boolean borderbuttons,
                 boolean opaquebuttons,
                 MouseListener listenerHighlightButtons)

getAttribute

public 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 Object getConstraints(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 Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getMaximumSize

public Dimension getMaximumSize()

Overrides:

getMaximumSize in class JComponent