no.g9.client.support

Interface ApplicationMethods

All Known Implementing Classes:

Application

public interface ApplicationMethods

Interface for application

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL Constant for CANCEL
static int	CLOSED_WINDOW Constant for if user closed window
static int	NO Constant for NO
static int	YES Constant for yes

Method Summary

Modifier and Type	Method and Description
void	actionExit() Internal use!
void	addWindow(G9DialogController dialogController) Internal use.
void	addWindow(G9DialogController dialogController, boolean doInit) Internal use.
boolean	applicationExceptionHandler(Throwable bad) Application-wide default handler for alle Runtime Exceptions.
boolean	checkForeignNodes() If the checkForeginNodes flag is true (the default value), foreign nodes are checked as part of the checkRowSelect when a selected line changes in a listblock.
void	commonViewStartup(JFrame frame, G9DialogController gc) This method is called each time a window is created outside of a MDI context.
void	commonViewStartup(JInternalFrame frame, G9DialogController gc) This method is called each time a window is created in an MDI setting.
G9DialogController	createDialog(String name) Creates a dialog with the given name.
G9DialogController	createDialog(String name, boolean add) Creates a dialog with the given name.
G9DialogController	getActiveInternalWindow()
List	getAddedWindows() Returns the windows present in the application.
G9MenuBar	getApplicationMenuBar() Returns the menu bar of the application.
String	getApplicationName() Get name of running application.
G9ToolBar	getApplicationToolBar() Returns the the application tool bar.
JFrame	getApplicationWindow() Returns the JFrame MDI appclication window.
G9DialogController	getDialog(String name) Searches through the added dialogs and returns that one if there exist a dialog with the given name.
G9Enums	getEnums() Access method for the dynamic enumeration helper.
G9DesktopPane	getG9DesktopPane() Returns the desktop pane of this application window.
RuntimeException	getLastException() Gets the last exception that occured.
G9DialogController	getModal() Returns the controller window that is modal if any.
G9DialogController	getOldDialogOrCreateNew(String name) Searches through the added dialogs and returns that one if there exist a dialog with the given name.
StatusBar	getStatusBar() Returns the status bar, used for displaying messages.
boolean	isWindowAdded(String name) Checks if there exist a dialog with the given name.
int	multiMessageBox(String message, Object[] params, Object[] choices, String standardChoice, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
int	multiMessageBox(String message, Object[] choices, String standardChoice, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
void	okMessageBox(String message, Object[] params, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
void	okMessageBox(String message, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
void	sendG9DataEvent(G9DataEvent eventObject) Calls g9DataEvent in all open window controllers with eventObject as parameter.
void	setCheckForeignNodes(boolean doCheck) Sets the checkForeignNodes flag.
void	setLastException(RuntimeException e) Sets the last exception that occured.
void	setModal(G9DialogController g, boolean isModal) Makes the window controlled by this controller modal.
void	statusBarMessage(String message, boolean bell) Deprecated. use the StatusBar instead.
void	statusBarMessage(String message, boolean bell, int seconds) Deprecated. use the StatusBar instead.
void	statusBarMessage(String message, Object[] params, boolean bell) Deprecated. use the StatusBar instead.
void	statusBarMessage(String message, Object[] params, boolean bell, int seconds) Deprecated. use the StatusBar instead.
void	toFront() Requests application to be moved to front and given focus
boolean	visitAll(DialogVisitor pVisitor) Run a visitor on all open dialogs.
int	yesNoCancelMessageBox(String message, int standardValue, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
int	yesNoCancelMessageBox(String message, Object[] params, int standardValue, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
int	yesNoMessageBox(String message, int standardValue, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.
int	yesNoMessageBox(String message, Object[] params, int standardValue, String title) Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Field Detail

YES

static final int YES

Constant for yes

See Also:

Constant Field Values

NO

static final int NO

Constant for NO

See Also:

Constant Field Values

CANCEL

static final int CANCEL

Constant for CANCEL

See Also:

Constant Field Values

CLOSED_WINDOW

static final int CLOSED_WINDOW

Constant for if user closed window

See Also:

Constant Field Values

Method Detail

applicationExceptionHandler

boolean applicationExceptionHandler(Throwable bad)

Application-wide default handler for alle Runtime Exceptions.

Parameters:

bad - the caught exception

Returns:

true to continue error handling, false if the error is handled

getApplicationName

String getApplicationName()

Get name of running application.

Returns:

the application name.

getApplicationWindow

JFrame getApplicationWindow()

Returns the JFrame MDI appclication window.

Returns:

The outermoust JFrame.

getEnums

G9Enums getEnums()

Access method for the dynamic enumeration helper. It is probably better to access the generated enumeration file directly in dialog code as it contains more spesific methods for working with the relevant enumerations.- this one is used by the runtime-system.

Returns:

The G9Enums object.

statusBarMessage

@Deprecated
void statusBarMessage(String message,
                                  boolean bell)

Deprecated. use the StatusBar instead.

Gives a message to a status bar, which will be removed after 5 seconds. If bell is flagged, an audio signal (alert/bell) will be sent to the user. Note that the users audio settings might mute the signal.

Parameters:

message - The message to display to the user.

bell - If true bell will be sent.

statusBarMessage

@Deprecated
void statusBarMessage(String message,
                                  Object[] params,
                                  boolean bell)

Deprecated. use the StatusBar instead.

Gives a message to a status bar, which will be removed after 5 seconds. The params[] option is an optional set of arguments which should be substituted in the message. If bell is flagged, an audio signal (alert/bell) will be sent to the user. Note that the users audio settings might * mute the signal.

Parameters:

message - The message to display.

params - The arguments to be substituted, as defined by java.text.MessageFormat.

bell - If true bell will be sent.

statusBarMessage

@Deprecated
void statusBarMessage(String message,
                                  boolean bell,
                                  int seconds)

Deprecated. use the StatusBar instead.

Gives a message to a status bar, which is removed after a given set of seconds. If bell is flagged, an audio signal (alert/bell) will be sent to the user. Note that the users audio settings might mute the signal.

Parameters:

message - The message to display.

bell - If true bell will be sent.

seconds - The amount of time in seconds the message will be visible.

toFront

void toFront()

Requests application to be moved to front and given focus

statusBarMessage

@Deprecated
void statusBarMessage(String message,
                                  Object[] params,
                                  boolean bell,
                                  int seconds)

Deprecated. use the StatusBar instead.

Gives a message to a status bar, which is removed after a given set of seconds. The params[] option is an optional set of arguments which should be substituted in the message. If bell is flagged, an audio signal (alert/bell) will be sent to the user. Note that the users audio settings might mute the signal.

Parameters:

message - The message to s

params - The arguments to be substituted, as defined by java.text.MessageFormat.

bell - If true bell will be sent.

seconds - The amount of time in seconds the message will be visible.

okMessageBox

@Deprecated
void okMessageBox(String message,
                              String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a ok button. This message box is modal.

Parameters:

message - The title of the displayed message box.

title - The title of the message box.

yesNoMessageBox

@Deprecated
int yesNoMessageBox(String message,
                                int standardValue,
                                String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a yes/no button. This message box is modal.

Parameters:

message - The message to display.

standardValue - The default choice of the buttons, as defined by Application.YES/Application.NO.

title - The title of the displayed message box.

Returns:

The value the user chosed, based on Application.YES, Application.NO or Application.CLOSED_WINDOW.

yesNoCancelMessageBox

@Deprecated
int yesNoCancelMessageBox(String message,
                                      int standardValue,
                                      String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a yes/no/cancel button.

Parameters:

message - The message to display.

standardValue - The default choice of the buttons, as defined by Application.YES/Application.CANCEL/Application.NO.

title - The title of the displayed message box.

Returns:

The value the user chosed, based on Application.YES, Application.NO, Application.CANCEL or Application.CLOSED_WINDOW if the user closed the window.

multiMessageBox

@Deprecated
int multiMessageBox(String message,
                                Object[] choices,
                                String standardChoice,
                                String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a given set of choices(buttons).

Parameters:

message - The message to display.

choices - The choices the user should have. This should be an array of Strings.

standardChoice - The choice that is the standard choice.

title - The title of the displayed message box.

Returns:

The Index position of the choices that the user selected or Application.CLOSED_WINDOW if the user closed the window.

okMessageBox

@Deprecated
void okMessageBox(String message,
                              Object[] params,
                              String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a ok button. The params[] option is an optional set of arguments which should be substituted in the message.

Parameters:

message - The message to display.

params - Options to be replaced in the message as defined by java.text.MessageFormat.

title - The title of the displayed message box.

yesNoMessageBox

@Deprecated
int yesNoMessageBox(String message,
                                Object[] params,
                                int standardValue,
                                String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a yes/no button. The params[] option is an optional set of arguments which should be substituted in the message.

Parameters:

message - The message to display.

params - Options to be replaced in the message as defined by java.text.MessageFormat.

standardValue - The standard value to display, Application.YES or Application.NO.

title - The title of the displayed message box.

Returns:

The value the user chosed, based on Application.YES, Application.NO or Application.CLOSED_WINDOW if the user closed the window.

yesNoCancelMessageBox

@Deprecated
int yesNoCancelMessageBox(String message,
                                      Object[] params,
                                      int standardValue,
                                      String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a yes/no/cancel button. The params[] option is an optional set of arguments which should be substituted in the message.

Parameters:

message - The message to display.

params - Options to be replaced in the message as defined by java.text.MessageFormat.

standardValue - The standard value to display, Application.YES, Application.NO or Application.CANCEL.

title - The title of the displayed message box.

Returns:

The value the user chosed, based on Application.YES, Application.NO or Application.CLOSED_WINDOW if the user closed the window.

multiMessageBox

@Deprecated
int multiMessageBox(String message,
                                Object[] params,
                                Object[] choices,
                                String standardChoice,
                                String title)

Deprecated. use the MessageDispatcher.dispatch(java.lang.String, java.lang.Object...) instead.

Gives user a message box with a given set of choices(buttons). The params[] option is an optional set of arguments which should be substituted in the message.

Parameters:

message - The message to display.

params - Options to be replaced in the message as defined by java.text.MessageFormat.

choices - Array of strings with the choices for the user.

standardChoice - The String that matches one of the strings sent in the params list that is to be the default choice of the message box.

title - The title of the displayed message box.

Returns:

The Index position of the choices that the user selected or Application.CLOSED_WINDOW if the user closed the window.

isWindowAdded

boolean isWindowAdded(String name)

Checks if there exist a dialog with the given name.

Parameters:

name - As defined in g9 (dmdialog).

Returns:

true if the dialog exists.

createDialog

G9DialogController createDialog(String name)

Creates a dialog with the given name.

Parameters:

name - The dialog name as defined in g9.

Returns:

The controller class of the newly created dialog.

createDialog

G9DialogController createDialog(String name,
                                boolean add)

Creates a dialog with the given name. If the second parameter is true the window is added to the application and made visible.

If the created dialog is a dialog box, and the dialog box is made visible (the second parameter is true the method will not return until the dialog is closed or made invisible.

Parameters:

name - The dialog name as defined in g9

add - if true the dialog is added and shown.

Returns:

The controller class of the newly created dialog.

getOldDialogOrCreateNew

G9DialogController getOldDialogOrCreateNew(String name)

Searches through the added dialogs and returns that one if there exist a dialog with the given name. If not it creates a new one.

If the dialog is a new, modal dialog box, this method will not return until the dialog is closed or hidden.

Parameters:

name - The dialog name as defined in g9.

Returns:

The controller class of the pre-existing or newly created dialog.

addWindow

void addWindow(G9DialogController dialogController)

Internal use. Adds a window to the list of application windows, initializes it and shows it.

Parameters:

dialogController - (missing javadoc)

addWindow

void addWindow(G9DialogController dialogController,
               boolean doInit)

Internal use. Adds a window to the list of application windows. Depending on the second parameter the window is either initialized or not.

Parameters:

dialogController - (missing javadoc)

doInit - (missing javadoc)

getDialog

G9DialogController getDialog(String name)

Searches through the added dialogs and returns that one if there exist a dialog with the given name. If not found it returns null.

Parameters:

name - The dialog name as defined in g9.

Returns:

The requested dialog controller.

sendG9DataEvent

void sendG9DataEvent(G9DataEvent eventObject)

Calls g9DataEvent in all open window controllers with eventObject as parameter. All dialogs will receive the event before new G9DataEvents are pumped to the dialogs.

Parameters:

eventObject - The data object that is to be sent. The message is user defined.

setModal

void setModal(G9DialogController g,
              boolean isModal)

Makes the window controlled by this controller modal. See doc on G9DialogController.

Parameters:

g - The controller to set.

isModal - True makes it modal, false makes it unmodal.

getModal

G9DialogController getModal()

Returns the controller window that is modal if any.

Returns:

The selected controller window if any.

commonViewStartup

void commonViewStartup(JInternalFrame frame,
                       G9DialogController gc)

This method is called each time a window is created in an MDI setting. This method is suitable for changing behaviour of internal frames, for instance setting resizeable, iconifiable and icon for window. Example:

 public void commonViewStartup(JInternalFrame frame, G9DialogController gc) {
     frame.setResizable(false);
     frame.setIconifiable(true);
     frame.setFrameIcon(getMyLogo());
 }
 

Parameters:

frame - The internal frame just activated.

gc - Its matching controller object.

commonViewStartup

void commonViewStartup(JFrame frame,
                       G9DialogController gc)

This method is called each time a window is created outside of a MDI context. See doc for commonViewStartup(JInternalFrame, G9DialogController) for example of usage.

Parameters:

frame - The frame just activated

gc - Its matching controller object.

getStatusBar

StatusBar getStatusBar()

Returns the status bar, used for displaying messages.

Returns:

the status bar for the application.

getAddedWindows

List getAddedWindows()

Returns the windows present in the application.

Returns:

a List of opened windows.

getActiveInternalWindow

G9DialogController getActiveInternalWindow()

Returns:

Returns the activeInternalWindow.

getG9DesktopPane

G9DesktopPane getG9DesktopPane()

Returns the desktop pane of this application window.

Returns:

the G9DesktopPane

getApplicationMenuBar

G9MenuBar getApplicationMenuBar()

Returns the menu bar of the application.

Returns:

the G9MenuBar

actionExit

void actionExit()

Internal use!

Exit the application. Open dialogs that have a WMClose event defined are closed gracefully. If all open dialogs where closed, the application exits (invokes System.exit(0)).

visitAll

boolean visitAll(DialogVisitor pVisitor)

Run a visitor on all open dialogs.

Parameters:

pVisitor - The actual DialogVisitor

Returns:

true if all visited dialogs returns true, otherwise false

getApplicationToolBar

G9ToolBar getApplicationToolBar()

Returns the the application tool bar.

Returns:

the G9ToolBar

setLastException

void setLastException(RuntimeException e)

Sets the last exception that occured.

Parameters:

e - the last exception

getLastException

RuntimeException getLastException()

Gets the last exception that occured.

Returns:

the last exception

checkForeignNodes

boolean checkForeignNodes()

If the checkForeginNodes flag is true (the default value), foreign nodes are checked as part of the checkRowSelect when a selected line changes in a listblock. The listblock might override this value.

Returns:

the checkForeignNodes flag

setCheckForeignNodes

void setCheckForeignNodes(boolean doCheck)

Sets the checkForeignNodes flag. If this flag is true (the default value) then all nodes that are visible in a listblock are checked for modifications when a listblock line select change occurs. If this flag is false the listblock role's node is checked among with its children (the nodes in the listblock role's object selection tree).

This value can be overridden by a listblock instance, in which case the overridden value will be used to determine the behaviour of the checkRowSelect method.

Parameters:

doCheck - the boolean value of the checkForeingNodesFlag