energy.optionModel.gui

Class AbstractMainPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

energy.optionModel.gui.AbstractMainPanel

All Implemented Interfaces:

energyLicense.LicenseCheckerListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

GroupMainPanel, MainPanel, ScheduleMainPanel

public abstract class AbstractMainPanel
extends javax.swing.JPanel
implements energyLicense.LicenseCheckerListener

The abstract class AbstractMainPanel is a base class for all MainPanels (energy, energyGroup, schedule) It contains also the methods and fields related to licensing.

See Also:

Serialized Form

Nested Class Summary

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 boolean	isGroupIntegrated
protected boolean	isHostIntegrated
protected java.awt.Container	parentWindowOrContainer

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
AbstractMainPanel() Instantiates a new main panel.
AbstractMainPanel(java.awt.Container parentContainer) Instantiates a new abstract main panel that is embedded in a parent container.
AbstractMainPanel(EomController eomController) Instantiates a new basic main panel with the specified EomController.

Method Summary

Modifier and Type	Method and Description
protected void	addStatusBar() Adds the status bar if the current panel is not integrated.
boolean	closeEomUserInterface() Closes this panel and possibly also the whole program.
protected abstract EomController	getEomController() Has to return the current or new EomController (should never be null).
abstract AbstractMainPanelToolBar	getMainPanelToolBar() Has to returns the main panel tool bar.
java.awt.Container	getParentWindowOrContainer() Returns the parent window or container.
StatusBar	getStatusBar() Gets the status bar.
protected abstract void	initialize() Initialises the main panel.
boolean	isDoModelChangeCheckBeforeClosing() Checks if there is a model change check is to do before closing.
boolean	isGroupIntegrated() Checks if this panel is integrated into an aggregation.
boolean	isHostIntegrated() Checks if this Panel is integrated into the Agent.GUI framework.
boolean	isInClosableModelCondition() Checks if the currently edited model (TechnicalSystem, ScheduleList or TechnicalSystemGroup) is in a closable model condition.
void	licenseCheckIsDone() Will be invoked if the license check was done and new result could be available.
void	removeLicenseIndicator() Removes the license indicator.
void	removeListenerFromParentWindowOrContainer() Removes the listener from parent window or container.
void	setDoModelChangeCheckBeforeClosing(boolean doModelChangeCheckBeforeClosing) Sets to do a model change check before closing.
void	setGroupIntegrated() Sets that this panel is integrated into an aggregation.
void	setHostIntegrated() Sets that the MainPanel is integrated into a host (e.g.
void	setLicenseIndicator() Adds the license indicator if the license is invalid, removes it if it is valid.
void	setParentWindowOrContainer(java.awt.Container parentWindowOrContainer) Sets the parent window or container.
protected void	startUiAndNotifyObservers(java.lang.Object modelLoadNotification) Enables to register the actual EomController.

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

parentWindowOrContainer

protected java.awt.Container parentWindowOrContainer

isHostIntegrated

protected boolean isHostIntegrated

isGroupIntegrated

protected boolean isGroupIntegrated

Constructor Detail

AbstractMainPanel

public AbstractMainPanel()

Instantiates a new main panel.

AbstractMainPanel

public AbstractMainPanel(EomController eomController)

Instantiates a new basic main panel with the specified EomController.

Parameters:

eomController - the actual EomController

AbstractMainPanel

public AbstractMainPanel(java.awt.Container parentContainer)

Instantiates a new abstract main panel that is embedded in a parent container. Such a parent container may be a JFrame, a JDialog or a JInternalFrame

Parameters:

parentContainer - the parent container

Method Detail

startUiAndNotifyObservers

protected void startUiAndNotifyObservers(java.lang.Object modelLoadNotification)

Enables to register the actual EomController.

Parameters:

modelLoadNotification - the model load notification

initialize

protected abstract void initialize()

Initialises the main panel.

getEomController

protected abstract EomController getEomController()

Has to return the current or new EomController (should never be null).

Returns:

the current EomController

getMainPanelToolBar

public abstract AbstractMainPanelToolBar getMainPanelToolBar()

Has to returns the main panel tool bar.

Returns:

the main panel tool bar

getStatusBar

public StatusBar getStatusBar()

Gets the status bar.

Returns:

the status bar

addStatusBar

protected void addStatusBar()

Adds the status bar if the current panel is not integrated.

See Also:

isHostIntegrated(), isGroupIntegrated()

isDoModelChangeCheckBeforeClosing

public boolean isDoModelChangeCheckBeforeClosing()

Checks if there is a model change check is to do before closing.

Returns:

true, if is to do a model change check before closing

setDoModelChangeCheckBeforeClosing

public void setDoModelChangeCheckBeforeClosing(boolean doModelChangeCheckBeforeClosing)

Sets to do a model change check before closing.

Parameters:

doModelChangeCheckBeforeClosing - the new do model change check before closing

isInClosableModelCondition

public boolean isInClosableModelCondition()

Checks if the currently edited model (TechnicalSystem, ScheduleList or TechnicalSystemGroup) is in a closable model condition.

Returns:

true, if is closable model state

closeEomUserInterface

public boolean closeEomUserInterface()

Closes this panel and possibly also the whole program.

Returns:

true, if successful

removeListenerFromParentWindowOrContainer

public void removeListenerFromParentWindowOrContainer()

Removes the listener from parent window or container.

setParentWindowOrContainer

public void setParentWindowOrContainer(java.awt.Container parentWindowOrContainer)

Sets the parent window or container.

Parameters:

parentWindowOrContainer - the new parent window or container

getParentWindowOrContainer

public java.awt.Container getParentWindowOrContainer()

Returns the parent window or container.

Returns:

the parent window or container

setHostIntegrated

public void setHostIntegrated()

Sets that the MainPanel is integrated into a host (e.g. Agent.GUI).

isHostIntegrated

public boolean isHostIntegrated()

Checks if this Panel is integrated into the Agent.GUI framework.

Returns:

true, if is Agent.GUI integrated

setGroupIntegrated

public void setGroupIntegrated()

Sets that this panel is integrated into an aggregation.

isGroupIntegrated

public boolean isGroupIntegrated()

Checks if this panel is integrated into an aggregation.

Returns:

true, if is group integrated

licenseCheckIsDone

public void licenseCheckIsDone()

Description copied from interface: energyLicense.LicenseCheckerListener

Will be invoked if the license check was done and new result could be available.

Specified by:

licenseCheckIsDone in interface energyLicense.LicenseCheckerListener

setLicenseIndicator

public void setLicenseIndicator()

Adds the license indicator if the license is invalid, removes it if it is valid.

removeLicenseIndicator

public void removeLicenseIndicator()

Removes the license indicator.