com.highqsoft.fwk

Class FwkRootPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.highqsoft.fwk.FwkRootPanel

All Implemented Interfaces:

FwkInterface, FwkRootPanelInterface, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FwkRootPanel
extends javax.swing.JPanel
implements FwkRootPanelInterface

The FWK root panel is responsible for managing the tool bar, the status bar, the logo and other components required by a GUI-based application. The functionality of this root panel is required for FwkFrame and FwkApplet. This class has been designed to avoid two identical implementations in both GUI components. It makes no sense for a FWK appliation programmer to subclass or call methods of this class, unless the interfaces of FwkApplet and FwkFrame are re-implemented for any reason.

Since:

$Date: 2017/04/28 08:47:41 $

Version:

$Revision: 1.16 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FwkRootPanel.HQLogo

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkPanelInterface	applicationPanel
protected java.awt.Component	eastToolBar
protected java.awt.Component	northToolBar
protected java.awt.Component	southToolBar
protected javax.swing.JPanel	statusContainer
protected javax.swing.JPanel	statusPanel
protected javax.swing.JPanel	toolbarPanel
protected FwkPanelInterface	userPanel
protected java.awt.GridBagLayout	userPanelGridBag
static java.lang.String	version
protected java.awt.Component	westToolBar

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FwkRootPanel()

Method Summary

Methods

Modifier and Type	Method and Description
FwkPanelInterface	getApplicationPanel() Get the application panel.
FwkPanelInterface	getStatusPanel() Get the status panel.
java.lang.String	getVersion() Return the version string of the FWK component.
void	release() Release the object.
void	setApplicationPanel(FwkPanelInterface applicationPanel) Set the application panel.
void	setStatusPanel(FwkPanelInterface userPanel) Set the status panel.
void	setToolBar(FwkCommandInterface[] commands) Set the toolbar.
void	setToolBar(java.lang.String position, FwkCommandInterface[] commands) Set the toolbar.

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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

version

public static final java.lang.String version

See Also:

Constant Field Values

applicationPanel

protected FwkPanelInterface applicationPanel

toolbarPanel

protected javax.swing.JPanel toolbarPanel

statusPanel

protected javax.swing.JPanel statusPanel

userPanel

protected FwkPanelInterface userPanel

statusContainer

protected javax.swing.JPanel statusContainer

userPanelGridBag

protected java.awt.GridBagLayout userPanelGridBag

eastToolBar

protected java.awt.Component eastToolBar

northToolBar

protected java.awt.Component northToolBar

southToolBar

protected java.awt.Component southToolBar

westToolBar

protected java.awt.Component westToolBar

Constructor Detail

FwkRootPanel

public FwkRootPanel()

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

getApplicationPanel

public FwkPanelInterface getApplicationPanel()

Get the application panel. An application implementing its own panel may use this panel as desired.

Specified by:

getApplicationPanel in interface FwkRootPanelInterface

Returns:

applicationPanel The application panel.

getStatusPanel

public FwkPanelInterface getStatusPanel()

Get the status panel. A status implementing its own panel may use this panel as desired.

Specified by:

getStatusPanel in interface FwkRootPanelInterface

Returns:

statusPanel The status panel.

setToolBar

public void setToolBar(FwkCommandInterface[] commands)

Set the toolbar. This method will set the toolbar to the NORTH of the toolbar panel.

Specified by:

setToolBar in interface FwkRootPanelInterface

Parameters:

toolbar - The toolbar to be set.

See Also:

#javax.swing.JToolBar

setToolBar

public void setToolBar(java.lang.String position,
              FwkCommandInterface[] commands)

Set the toolbar. This method will set the toolbar to the requested position of the toolbar panel.

Specified by:

setToolBar in interface FwkRootPanelInterface

Parameters:

position - The border layout position constants. Use NORTH, EAST, SOUTH or WEST only. CENTER is not supported and will be ignored.

toolbar - The toolbar to be set.

See Also:

#javax.swing.JToolBar

setApplicationPanel

public void setApplicationPanel(FwkPanelInterface applicationPanel)

Set the application panel. An application implementing its own panel may use this panel as desired.

Specified by:

setApplicationPanel in interface FwkRootPanelInterface

Parameters:

applicationPanel - The application panel.

setStatusPanel

public void setStatusPanel(FwkPanelInterface userPanel)

Set the status panel. A status implementing its own panel may use this panel as desired.

Specified by:

setStatusPanel in interface FwkRootPanelInterface

Parameters:

userPanel - The status panel.