org.jminor.swing.framework.ui

Class EntityApplicationPanel<M extends SwingEntityApplicationModel>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jminor.swing.framework.ui.EntityApplicationPanel<M>

Type Parameters:

M - the application model type

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, DialogExceptionHandler, MasterDetailPanel

public abstract class EntityApplicationPanel<M extends SwingEntityApplicationModel>
extends javax.swing.JPanel
implements DialogExceptionHandler, MasterDetailPanel

A central application panel class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityApplicationPanel.ApplicationFrameProvider Provides the JFrame instance to use for the application

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
static PropertyValue<java.lang.Boolean>	CONFIRM_EXIT Indicates whether the application should ask for confirmation when exiting Value type: Boolean Default value: false
static PropertyValue<java.lang.Boolean>	PERSIST_ENTITY_PANELS Specifies if EntityPanels opened via the EntityApplicationPanel.showEntityPanelDialog method should be persisted, or kept in memory, when the dialog is closed. Value type: Boolean Default value: false
static PropertyValue<java.lang.Boolean>	SHOW_STARTUP_DIALOG Specifies whether a startup dialog should be shown Value type: Boolean Default value: true
static PropertyValue<java.lang.Integer>	TAB_PLACEMENT Specifies the tab placement Value type: Integer (JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, JTabbedPane.RIGHT) Default value: JTabbedPane.TOP

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
EntityApplicationPanel() A default constructor
EntityApplicationPanel(EntityApplicationPanel.ApplicationFrameProvider frameProvider)

Method Summary

Modifier and Type	Method and Description
void	activatePanel() Activates this panel, showing it and preparing it for input
void	addAlwaysOnTopListener(EventDataListener<java.lang.Boolean> listener)
void	addApplicationStartedListener(EventListener listener)
EntityApplicationPanel<M>	addEntityPanelProvider(EntityPanelProvider panelProvider) Adds a main application panel, displayed on application start
EntityApplicationPanel<M>	addEntityPanelProviders(EntityPanelProvider... panelProviders) Adds main application panels, displayed on application start
protected void	addOnExitListener(EventListener listener) Adds a listener notified when the application is about to exit.
EntityApplicationPanel<M>	addSupportPanelProvider(EntityPanelProvider panelProvider) Adds a support application panel, available via a support panel menu
EntityApplicationPanel<M>	addSupportPanelProviders(EntityPanelProvider... panelProviders) Adds support application panels, available via a support panel menu
protected void	bindEvents() Override to add event bindings after initialization
protected Control	createAboutControl()
protected Controls.ToggleControl	createAlwaysOnTopControl()
protected Control	createExitControl()
protected Control	createHelpControl()
protected Control	createLoggingLevelControl()
protected Control	createRefreshAllControl()
protected Control	createSelectFontSizeControl()
protected Control	createSelectLookAndFeelControl()
protected Control	createViewApplicationTreeControl()
protected Control	createViewDependencyTree()
void	displayAbout() Shows an about dialog
void	displayException(java.lang.Throwable exception, java.awt.Window dialogParent) Handle the given exception and display it to the user.
void	displayHelp() Shows a help dialog
void	exit() Exits this application
protected javax.swing.JPanel	getAboutPanel()
EntityPanel	getActiveDetailPanel()
protected java.util.List<ControlSet>	getAdditionalMenuControlSet()
protected java.lang.String	getApplicationIdentifier() Returns a String identifying the application this EntityApplicationPanel represents, by default the full class name is returned.
protected javax.swing.JTabbedPane	getApplicationTabPane() Returns the JTabbedPane used by the default UI, note that this can be null if the default UI initialization has been overridden.
protected Version	getClientVersion()
protected java.lang.Integer	getDefaultFontSize()
protected java.lang.String	getDefaultLookAndFeelClassName()
protected java.lang.String	getDefaultUsername()
javax.swing.tree.TreeModel	getDependencyTreeModel()
java.util.List<MasterDetailPanel>	getDetailPanels()
EntityPanel	getEntityPanel(java.lang.String entityId)
java.util.List<EntityPanel>	getEntityPanels()
protected ControlSet	getFileControlSet()
protected java.lang.String	getFrameTitle(java.lang.String frameCaption, EntityConnectionProvider connectionProvider)
protected ControlSet	getHelpControlSet()
protected javax.swing.JPanel	getHelpPanel()
protected java.lang.String	getHelpText()
protected ControlSet	getMainMenuControlSet()
MasterDetailPanel	getMasterPanel()
M	getModel()
MasterDetailPanel	getNextPanel()
java.awt.Window	getParentWindow()
MasterDetailPanel	getPreviousPanel()
protected ControlSet	getSettingsControlSet()
protected ControlSet	getSupportTableControlSet()
protected ControlSet	getToolsControlSet()
protected static User	getUser(java.lang.String[] args) Looks up user credentials via a CredentialsProvider service using an authentication token found in the program arguments list.
protected User	getUser(java.lang.String frameCaption, User defaultUser, javax.swing.ImageIcon applicationIcon) Returns the user, either via a login dialog or via override, called during startup
protected ControlSet	getViewControlSet()
protected void	initialize(M applicationModel) Initializes this application panel
protected abstract M	initializeApplicationModel(EntityConnectionProvider connectionProvider) Initializes the application model
protected EntityConnectionProvider	initializeConnectionProvider(User user, java.lang.String clientTypeId) Initializes the entity connection provider
protected java.util.List<EntityPanel>	initializeEntityPanels(M applicationModel) By default this method returns the panels defined by the available EntityPanelProviders.
protected javax.swing.JMenuBar	initializeMenuBar() Initializes the JMenuBar to use on the application Frame
protected javax.swing.JPanel	initializeNorthPanel() Initializes a panel to display in the NORTH position of this application panel.
protected javax.swing.JPanel	initializeSouthPanel() Initializes a panel to display in the SOUTH position of this application frame, override to provide a south panel.
protected javax.swing.JDialog	initializeStartupDialog(javax.swing.Icon icon, java.lang.String startupMessage) Initializes the startup dialog
protected javax.swing.JPanel	initializeStartupProgressPanel(javax.swing.Icon icon) Initializes the progress panel to show in the startup dialog
protected void	initializeUI() Initializes this EntityApplicationPanel
boolean	isAlwaysOnTop()
protected boolean	isLoginRequired()
protected boolean	isShowStartupDialog()
void	login() Performs a login, fetching user information via getUser(java.lang.String, org.jminor.common.User, javax.swing.ImageIcon)
void	logout() Performs a logout
protected javax.swing.JFrame	prepareFrame(java.lang.String title, boolean maximize, boolean showMenuBar, java.awt.Dimension size, javax.swing.ImageIcon applicationIcon, boolean setVisible) Initializes a JFrame according to the given parameters, containing this EntityApplicationPanel
void	removeAlwaysOnTopListener(EventListener listener)
void	removeApplicationStartedListener(EventListener listener)
protected void	saveDefaultUsername(java.lang.String username) Saves the username so that it can be used as default the next time this application is started.
protected void	savePreferences() Called during the exit() method, override to save user preferences on program exit, remember to call super.savePreferences() when overriding
void	selectFontSize() Display a dialog for selecting the application font size
void	selectLookAndFeel() Allows the user the select between the system and cross platform Look and Feel, activated on next appliation start
void	setActiveDetailPanel(MasterDetailPanel detailPanel) Activates (and shows) the given detail panel
void	setAlwaysOnTop(boolean value)
void	setLoggingLevel() Shows a dialog for setting the logging level
protected void	setLoginRequired(boolean loginRequired) Sets whether or not this application requires a login dialog, setting this value after the application has been started has no effect
protected void	setShowStartupDialog(boolean startupDialog)
protected void	setupEntityPanelProviders() Called during initialization, after the application model has been initialized, override to keep all entity panel provider definitions in one place.
protected void	showEntityPanelDialog(EntityPanelProvider panelProvider) Shows a dialog containing the entity panel provided by the given panel provider
protected void	showEntityPanelDialog(EntityPanelProvider panelProvider, boolean modalDialog) Shows a dialog containing the entity panel provided by the given panel provider
javax.swing.JFrame	startApplication(java.lang.String frameCaption, java.lang.String iconName, boolean maximize, java.awt.Dimension frameSize) Starts this application.
javax.swing.JFrame	startApplication(java.lang.String frameCaption, java.lang.String iconName, boolean maximize, java.awt.Dimension frameSize, User defaultUser) Starts this application.
javax.swing.JFrame	startApplication(java.lang.String frameCaption, java.lang.String iconName, boolean maximize, java.awt.Dimension frameSize, User defaultUser, boolean showFrame) Starts this application.
javax.swing.JFrame	startApplication(java.lang.String frameCaption, java.lang.String iconName, boolean maximize, java.awt.Dimension frameSize, User defaultUser, boolean showFrame, User silentLoginUser) Starts this application.
void	viewApplicationTree() Displays in a dialog a tree describing the application layout
void	viewDependencyTree() Shows a dialog containing a dependency tree view of all defined entities

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

CONFIRM_EXIT

public static final PropertyValue<java.lang.Boolean> CONFIRM_EXIT

Indicates whether the application should ask for confirmation when exiting
Value type: Boolean
Default value: false

SHOW_STARTUP_DIALOG

public static final PropertyValue<java.lang.Boolean> SHOW_STARTUP_DIALOG

Specifies whether a startup dialog should be shown
Value type: Boolean
Default value: true

PERSIST_ENTITY_PANELS

public static final PropertyValue<java.lang.Boolean> PERSIST_ENTITY_PANELS

Specifies if EntityPanels opened via the EntityApplicationPanel.showEntityPanelDialog method should be persisted, or kept in memory, when the dialog is closed.
Value type: Boolean
Default value: false

See Also:

showEntityPanelDialog(EntityPanelProvider)

TAB_PLACEMENT

public static final PropertyValue<java.lang.Integer> TAB_PLACEMENT

Specifies the tab placement
Value type: Integer (JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, JTabbedPane.RIGHT)
Default value: JTabbedPane.TOP

Constructor Detail

EntityApplicationPanel

public EntityApplicationPanel()

A default constructor

EntityApplicationPanel

public EntityApplicationPanel(EntityApplicationPanel.ApplicationFrameProvider frameProvider)

Method Detail

displayException

public final void displayException(java.lang.Throwable exception,
                                   java.awt.Window dialogParent)

Handle the given exception and display it to the user.

Specified by:

displayException in interface DialogExceptionHandler

Parameters:

exception - the exception

dialogParent - the Window to use as parent to the exception dialog

getModel

public final M getModel()

Returns:

the application model this application panel is based on

addEntityPanelProviders

public final EntityApplicationPanel<M> addEntityPanelProviders(EntityPanelProvider... panelProviders)

Adds main application panels, displayed on application start

Parameters:

panelProviders - the main application panel providers

Returns:

this application panel instance

addEntityPanelProvider

public final EntityApplicationPanel<M> addEntityPanelProvider(EntityPanelProvider panelProvider)

Adds a main application panel, displayed on application start

Parameters:

panelProvider - the main application panel provider

Returns:

this application panel instance

addSupportPanelProviders

public final EntityApplicationPanel<M> addSupportPanelProviders(EntityPanelProvider... panelProviders)

Adds support application panels, available via a support panel menu

Parameters:

panelProviders - the support application panel providers

Returns:

this application panel instance

addSupportPanelProvider

public final EntityApplicationPanel<M> addSupportPanelProvider(EntityPanelProvider panelProvider)

Adds a support application panel, available via a support panel menu

Parameters:

panelProvider - the support application panel provider

Returns:

this application panel instance

getEntityPanel

public final EntityPanel getEntityPanel(java.lang.String entityId)

Parameters:

entityId - the entity ID

Returns:

the first entity panel found based on the given entity type, null if none is found

getEntityPanels

public final java.util.List<EntityPanel> getEntityPanels()

Returns:

an unmodifiable view of the main application panels

getParentWindow

public final java.awt.Window getParentWindow()

Returns:

the parent window of this panel, if one exists, null otherwise

isAlwaysOnTop

public final boolean isAlwaysOnTop()

Returns:

true if the frame this application panel is shown in should be 'alwaysOnTop'

setAlwaysOnTop

public final void setAlwaysOnTop(boolean value)

Parameters:

value - the new value

See Also:

addAlwaysOnTopListener(EventDataListener)

login

public final void login()

Performs a login, fetching user information via getUser(java.lang.String, org.jminor.common.User, javax.swing.ImageIcon)

Throws:

CancelException - in case the login is cancelled

See Also:

getUser(String, User, javax.swing.ImageIcon)

logout

public final void logout()

Performs a logout

setLoggingLevel

public final void setLoggingLevel()

Shows a dialog for setting the logging level

viewApplicationTree

public final void viewApplicationTree()

Displays in a dialog a tree describing the application layout

viewDependencyTree

public final void viewDependencyTree()

Shows a dialog containing a dependency tree view of all defined entities

selectLookAndFeel

public final void selectLookAndFeel()

Allows the user the select between the system and cross platform Look and Feel, activated on next appliation start

selectFontSize

public final void selectFontSize()

Display a dialog for selecting the application font size

startApplication

public final javax.swing.JFrame startApplication(java.lang.String frameCaption,
                                                 java.lang.String iconName,
                                                 boolean maximize,
                                                 java.awt.Dimension frameSize)

Starts this application.

Parameters:

frameCaption - the caption to display on the frame

iconName - the name of the icon to use

maximize - if true the application frame is maximized on startup

frameSize - the frame size when not maximized

Returns:

the JFrame instance containing this application panel

startApplication

public final javax.swing.JFrame startApplication(java.lang.String frameCaption,
                                                 java.lang.String iconName,
                                                 boolean maximize,
                                                 java.awt.Dimension frameSize,
                                                 User defaultUser)

Starts this application.

Parameters:

frameCaption - the caption to display on the frame

iconName - the name of the icon to use

maximize - if true the application frame is maximized on startup

frameSize - the frame size when not maximized

defaultUser - the default user to display in the login dialog

Returns:

the JFrame instance containing this application panel

startApplication

public final javax.swing.JFrame startApplication(java.lang.String frameCaption,
                                                 java.lang.String iconName,
                                                 boolean maximize,
                                                 java.awt.Dimension frameSize,
                                                 User defaultUser,
                                                 boolean showFrame)

Starts this application.

Parameters:

frameCaption - the caption to display on the frame

iconName - the name of the icon to use

maximize - if true the application frame is maximized on startup

frameSize - the frame size when not maximized

defaultUser - the default user to display in the login dialog

showFrame - if true the frame is set visible

Returns:

the JFrame instance containing this application panel

startApplication

public final javax.swing.JFrame startApplication(java.lang.String frameCaption,
                                                 java.lang.String iconName,
                                                 boolean maximize,
                                                 java.awt.Dimension frameSize,
                                                 User defaultUser,
                                                 boolean showFrame,
                                                 User silentLoginUser)

Starts this application.

Parameters:

frameCaption - the caption to display on the frame

iconName - the name of the icon to use

maximize - if true the application frame is maximized on startup

frameSize - the frame size when not maximized

defaultUser - the default user to display in the login dialog

showFrame - if true the frame is set visible

silentLoginUser - if specified the application is started silently with that user, displaying no login or progress dialog

Returns:

the JFrame instance containing this application panel

getMasterPanel

public final MasterDetailPanel getMasterPanel()

Specified by:

getMasterPanel in interface MasterDetailPanel

Returns:

the parent master panel, if one exists

getActiveDetailPanel

public final EntityPanel getActiveDetailPanel()

Specified by:

getActiveDetailPanel in interface MasterDetailPanel

Returns:

a detail panel, if one exists, which child panel exactly is up the implementation

setActiveDetailPanel

public final void setActiveDetailPanel(MasterDetailPanel detailPanel)

Activates (and shows) the given detail panel

Specified by:

setActiveDetailPanel in interface MasterDetailPanel

Parameters:

detailPanel - the detail panel to activate and show

getPreviousPanel

public final MasterDetailPanel getPreviousPanel()

Specified by:

getPreviousPanel in interface MasterDetailPanel

Returns:

the previous detail panel, if one exists, with wrap around

getNextPanel

public final MasterDetailPanel getNextPanel()

Specified by:

getNextPanel in interface MasterDetailPanel

Returns:

the next detail panel, if one exists, with wrap around

getDetailPanels

public final java.util.List<MasterDetailPanel> getDetailPanels()

Specified by:

getDetailPanels in interface MasterDetailPanel

Returns:

the detail panels, an empty list if no detail panels exist

activatePanel

public final void activatePanel()

Activates this panel, showing it and preparing it for input

Specified by:

activatePanel in interface MasterDetailPanel

exit

public final void exit()

Exits this application

Throws:

CancelException - if the exit is cancelled

See Also:

addOnExitListener(EventListener), CONFIRM_EXIT, EntityApplicationModel.isWarnAboutUnsavedData()

displayHelp

public final void displayHelp()

Shows a help dialog

See Also:

getHelpPanel()

displayAbout

public final void displayAbout()

Shows an about dialog

See Also:

getAboutPanel()

addAlwaysOnTopListener

public final void addAlwaysOnTopListener(EventDataListener<java.lang.Boolean> listener)

Parameters:

listener - a listener notified each time the always on top status changes

removeAlwaysOnTopListener

public final void removeAlwaysOnTopListener(EventListener listener)

Parameters:

listener - the listener to remove

addApplicationStartedListener

public final void addApplicationStartedListener(EventListener listener)

Parameters:

listener - a listener notified when to application has been successfully started

removeApplicationStartedListener

public final void removeApplicationStartedListener(EventListener listener)

Parameters:

listener - the listener to remove

getDependencyTreeModel

public final javax.swing.tree.TreeModel getDependencyTreeModel()

Returns:

a tree model showing the dependencies between entities via foreign keys

getApplicationTabPane

protected final javax.swing.JTabbedPane getApplicationTabPane()

Returns the JTabbedPane used by the default UI, note that this can be null if the default UI initialization has been overridden. Returns null until initializeUI() has been called

Returns:

the default application tab pane

getMainMenuControlSet

protected ControlSet getMainMenuControlSet()

Returns:

the control set on which to base the main menu

See Also:

getFileControlSet(), getSettingsControlSet(), getViewControlSet(), getToolsControlSet(), getHelpControlSet()

getFileControlSet

protected ControlSet getFileControlSet()

Returns:

the ControlSet specifying the items in the 'File' menu

getSettingsControlSet

protected ControlSet getSettingsControlSet()

Returns:

the ControlSet specifying the items in the 'Settings' menu

getToolsControlSet

protected ControlSet getToolsControlSet()

Returns:

the ControlSet specifying the items in the 'Tools' menu

getViewControlSet

protected ControlSet getViewControlSet()

Returns:

the ControlSet specifying the items in the 'View' menu

getHelpControlSet

protected ControlSet getHelpControlSet()

Returns:

the ControlSet specifying the items in the 'Help' menu

createExitControl

protected final Control createExitControl()

Returns:

a Control for exiting the application

createLoggingLevelControl

protected final Control createLoggingLevelControl()

Returns:

a Control for setting the logging level

createRefreshAllControl

protected final Control createRefreshAllControl()

Returns:

a Control for refreshing the application model

createViewApplicationTreeControl

protected final Control createViewApplicationTreeControl()

Returns:

a Control for viewing the application structure tree

createViewDependencyTree

protected final Control createViewDependencyTree()

Returns:

a Control for viewing the application dependency tree

createSelectLookAndFeelControl

protected final Control createSelectLookAndFeelControl()

Returns:

a Control for selecting the application look and feel

createSelectFontSizeControl

protected final Control createSelectFontSizeControl()

Returns:

a Control for selecting the font size

createAlwaysOnTopControl

protected final Controls.ToggleControl createAlwaysOnTopControl()

Returns:

a Control controlling the always on top status

createAboutControl

protected final Control createAboutControl()

Returns:

a Control for viewing information about the application

createHelpControl

protected final Control createHelpControl()

Returns:

a Control for displaying the help

getHelpPanel

protected javax.swing.JPanel getHelpPanel()

Returns:

the panel shown when Help -> Help is selected

getHelpText

protected java.lang.String getHelpText()
                                throws java.io.IOException

Returns:

the text to show in the help panel

Throws:

java.io.IOException - in case of an IO exception

getAboutPanel

protected javax.swing.JPanel getAboutPanel()

Returns:

the panel shown when Help -> About is selected

initializeConnectionProvider

protected EntityConnectionProvider initializeConnectionProvider(User user,
                                                                java.lang.String clientTypeId)

Initializes the entity connection provider

Parameters:

user - the user

clientTypeId - a string specifying the client type

Returns:

an initialized EntityConnectionProvider

Throws:

CancelException - in case the initialization is cancelled

getClientVersion

protected Version getClientVersion()

Returns:

the client version if specified, null by default

initialize

protected final void initialize(M applicationModel)

Initializes this application panel

Parameters:

applicationModel - the application model

Throws:

java.lang.IllegalStateException - if the application model has not been set

CancelException - in case the initialization is cancelled

bindEvents

protected void bindEvents()

Override to add event bindings after initialization

getAdditionalMenuControlSet

protected java.util.List<ControlSet> getAdditionalMenuControlSet()

Returns:

a List of ControlSet objects which are to be added to the main menu bar

getSupportTableControlSet

protected ControlSet getSupportTableControlSet()

Returns:

the ControlSet on which the Support Tables menu item is based on

showEntityPanelDialog

protected final void showEntityPanelDialog(EntityPanelProvider panelProvider)

Shows a dialog containing the entity panel provided by the given panel provider

Parameters:

panelProvider - the entity panel provider

showEntityPanelDialog

protected final void showEntityPanelDialog(EntityPanelProvider panelProvider,
                                           boolean modalDialog)

Shows a dialog containing the entity panel provided by the given panel provider

Parameters:

panelProvider - the entity panel provider

modalDialog - if true the dialog is made modal

setupEntityPanelProviders

protected void setupEntityPanelProviders()

Called during initialization, after the application model has been initialized, override to keep all entity panel provider definitions in one place.

See Also:

addEntityPanelProvider(EntityPanelProvider), addEntityPanelProviders(EntityPanelProvider...), addSupportPanelProvider(EntityPanelProvider), addSupportPanelProviders(EntityPanelProvider...)

initializeUI

protected void initializeUI()

Initializes this EntityApplicationPanel

initializeEntityPanels

protected java.util.List<EntityPanel> initializeEntityPanels(M applicationModel)

By default this method returns the panels defined by the available EntityPanelProviders.

Parameters:

applicationModel - the application model responsible for providing EntityModels for the panels

Returns:

a List containing the EntityPanels to include in this application panel

See Also:

addEntityPanelProvider(EntityPanelProvider)

isLoginRequired

protected final boolean isLoginRequired()

Returns:

true if a login dialog is required for this application, false if the user is supplied differently

setLoginRequired

protected final void setLoginRequired(boolean loginRequired)

Sets whether or not this application requires a login dialog, setting this value after the application has been started has no effect

Parameters:

loginRequired - the login required status

isShowStartupDialog

protected final boolean isShowStartupDialog()

Returns:

true if a startup dialog should be shown

setShowStartupDialog

protected final void setShowStartupDialog(boolean startupDialog)

Parameters:

startupDialog - true if a startup dialog should be shown

getDefaultLookAndFeelClassName

protected java.lang.String getDefaultLookAndFeelClassName()

Returns:

the look and feel class name to use

See Also:

UiUtil.getDefaultLookAndFeelClassName()

getDefaultFontSize

protected java.lang.Integer getDefaultFontSize()

Returns:

the default font size multiplier

See Also:

selectFontSize()

initializeNorthPanel

protected javax.swing.JPanel initializeNorthPanel()

Initializes a panel to display in the NORTH position of this application panel. override to provide a north panel.

Returns:

a panel for the NORTH position

initializeSouthPanel

protected javax.swing.JPanel initializeSouthPanel()

Initializes a panel to display in the SOUTH position of this application frame, override to provide a south panel.

Returns:

a panel for the SOUTH position

initializeStartupDialog

protected final javax.swing.JDialog initializeStartupDialog(javax.swing.Icon icon,
                                                            java.lang.String startupMessage)

Initializes the startup dialog

Parameters:

icon - the icon

startupMessage - the startup message

Returns:

the startup dialog

See Also:

initializeStartupProgressPanel(javax.swing.Icon)

initializeStartupProgressPanel

protected javax.swing.JPanel initializeStartupProgressPanel(javax.swing.Icon icon)

Initializes the progress panel to show in the startup dialog

Parameters:

icon - the icon

Returns:

an initialized startup progress panel

getFrameTitle

protected java.lang.String getFrameTitle(java.lang.String frameCaption,
                                         EntityConnectionProvider connectionProvider)

Parameters:

frameCaption - the caption for the frame

connectionProvider - the EntityConnectionProvider this application is using

Returns:

a frame title based on the logged in user

prepareFrame

protected final javax.swing.JFrame prepareFrame(java.lang.String title,
                                                boolean maximize,
                                                boolean showMenuBar,
                                                java.awt.Dimension size,
                                                javax.swing.ImageIcon applicationIcon,
                                                boolean setVisible)

Initializes a JFrame according to the given parameters, containing this EntityApplicationPanel

Parameters:

title - the title string for the JFrame

maximize - if true then the JFrame is maximized, overrides the prefSeizeAsRatioOfScreen parameter

showMenuBar - true if a menubar should be created

size - if the JFrame is not maximized then its preferredSize is set to this value

applicationIcon - the application icon

setVisible - if true then the JFrame is set visible

Returns:

an initialized, but non-visible JFrame

addOnExitListener

protected final void addOnExitListener(EventListener listener)

Adds a listener notified when the application is about to exit. To cancel the exit throw a CancelException.

Parameters:

listener - a listener notified when the application is about to exit

initializeMenuBar

protected javax.swing.JMenuBar initializeMenuBar()

Initializes the JMenuBar to use on the application Frame

Returns:

by default a JMenuBar based on the main menu control set

See Also:

getMainMenuControlSet()

initializeApplicationModel

protected abstract M initializeApplicationModel(EntityConnectionProvider connectionProvider)

Initializes the application model

Parameters:

connectionProvider - the db provider

Returns:

an initialized application model

Throws:

CancelException - in case the initialization is cancelled

getUser

protected User getUser(java.lang.String frameCaption,
                       User defaultUser,
                       javax.swing.ImageIcon applicationIcon)

Returns the user, either via a login dialog or via override, called during startup

Parameters:

frameCaption - the application frame caption

defaultUser - the default user

applicationIcon - the application icon

Returns:

the application user

Throws:

CancelException - in case a login dialog is cancelled

saveDefaultUsername

protected void saveDefaultUsername(java.lang.String username)

Saves the username so that it can be used as default the next time this application is started.

Parameters:

username - the username

getDefaultUsername

protected java.lang.String getDefaultUsername()

Returns:

a default username previously saved to user preferences or the OS username

getApplicationIdentifier

protected java.lang.String getApplicationIdentifier()

Returns a String identifying the application this EntityApplicationPanel represents, by default the full class name is returned.

Returns:

a String identifying the application type this panel represents

savePreferences

protected void savePreferences()

Called during the exit() method, override to save user preferences on program exit, remember to call super.savePreferences() when overriding

See Also:

EntityApplicationModel.savePreferences()

getUser

protected static User getUser(java.lang.String[] args)

Looks up user credentials via a CredentialsProvider service using an authentication token found in the program arguments list. Useful for single sign on application launch.

javaws -open authenticationToken:123-123-123 http://jminor.org/demo/demo.jnlp

java -jar application/getdown-1.7.1.jar app_dir app_id authenticationToken:123-123-123

Parameters:

args - the program arguments

Returns:

the User credentials associated with the authentication token, null if no authentication token is found, the user credentials have expired or if no authentication server is running