G9DialogController (g9 Swing 2.6.1 API)

All Known Implementing Classes:

AbstractG9DialogController
```
public interface G9DialogController
```
The general controller class for dialogs. Use this if need

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`blockDialog()` Blocks dialog from receving any events whatsoever
`ECheckResult`	`callHookCheckChange(String roleName)` Internal use.
`ECheckResult`	`callHookCheckClear(String roleName)` Internal use.
`ECheckResult`	`callHookCheckClose(String roleName)` Internal use.
`ECheckResult`	`callHookCheckDelete(String roleName)` Internal use.
`ECheckResult`	`callHookCheckFind(String roleName)` Internal use.
`ECheckResult`	`callHookCheckPrint(String roleName)` Internal use.
`ECheckResult`	`callHookCheckRowSelect(String roleName, int curSel, int newSel)` Internal use.
`ECheckResult`	`callHookCheckSave(String roleName)` Internal use.
`boolean`	`checkClear(String roleName)` Perfoms checkClear on the specified root role
`boolean`	`checkClose()` Performs checkClose on this dialog.
`void`	`clearDialog()` Clears all window blocks in this dialog.
`void`	`clearObjectSelection()` Recursivly clears all nodes from the object selection.
`boolean`	`dialogExceptionHandler(Throwable bad)` Default handler for alle Runtime Exceptions.
`void`	`display(String objSelAttr, Object value)` Performs display on the given object selection with the given value found in this controller.
`void`	`display(String objSelAttr, Object value, boolean resetState)` Updates the specified field from the object selection, and displays the new value.
`void`	`disposeDialog()` Destroys this dialog.
`boolean`	`g9Accelerator(KeyEvent event)` Callback from keyevents pass through this method.
`void`	`g9DataEvent(G9DataEvent eventData)` Is called when someone sends a data event to the application.
`ApplicationMethods`	`getApplication()` Returns the controller for the application
`String`	`getDialogName()` Returns the dialog name of the dialog as defined in g9.
`DomainObjectProxy`	`getNewProxy(Object o, String roleName)` Internal use, returns a new DomainObjectProxy for the specified object and role name
`ObjectSelectionNode`	`getObjectSelectionNode(String roleName)` Gets the role name method pointer, e.g if the roleName is "Order" it returns the field `theOrder`
`Map`	`getRoleObjects()` Returns a map of the role objects.
`List`	`getRoleObjects(Object anObject)` Returns the a list of role objects contained in this dialog representing the specified domain object.
`String`	`getServerApplicationName()` Returns the name of the server application for the dialogs object selection
`Vector`	`getToolBarElements()` Deprecated. use `G9DialogFrame.getG9ToolBar()`
`G9DialogFrame`	`getView()` Gets the dialog window representing this dialog.
`Container`	`getWindow()` Returns the window used by this controller.
`String`	`getWindowTitle()` Returns the title of the main window as defined in the WindowBlock in g9.
`boolean`	`ignoreCheckChanged()` Returns the ignoreCheckChanged property.
`void`	`init()` Called upon startup of the dialog - used by the runtime system.
`boolean`	`isBlocked()` Returns true if the dialog is blocked.
`boolean`	`isChanged(String osAttributeName)` Check if the specified role attribute is changed.
`String`	`obtain(String objSelAttr)` Performs obtain on the given object selection attribute found in this controller.
`void`	`returnToCaller(Object returnObject)` Handles the return from another dialog
`void`	`setAccessPolicy()` This method is invoked after the dialog is fully realized and drawn on screen, so that you migth modify fields, set values etc.
`void`	`setEnabledComponent(Component component, boolean enabled)` Recursivly enables or disables a component and all its children.
`void`	`setEnabledComponent(Component component, boolean enabled, boolean delay)` Internal use.
`void`	`setEnabledComponent(String name, boolean enable)` Recursivly enables or disables a component and all its children.
`void`	`setIgnoreCheckChanged(boolean ignoreCheckChange)` Sets whether check change is to be executed or not.
`void`	`setModal(boolean isModal)` Make this dialog modal.
`void`	`setNormalCursor()` Changes cursos for this dialog into a normal cursor.
`void`	`setServerApplicationName(String serverApplicationName)` Sets the server application name for the dialogs object selection
`void`	`setVisibleComponent(Component component, boolean visible)` Recursivly hides or shows a component and all its children.
`void`	`setVisibleComponent(Component component, boolean visible, boolean delay)` Internal use.
`void`	`setVisibleComponent(String name, boolean visible)` Recursivly hides or shows a component and all its children.
`void`	`setWaitCursor()` Changes cursor for this dialog into a wait cursor.
`void`	`setWindowTitle(String title)` Set the title of the dialog window.
`void`	`startInit(Object returnObject, Object startObject)` Handles initialization of a dialog from another dialog
`void`	`toBack()` Sends this dialog to the back of the MDI.
`void`	`toFront()` Sends this dialog to the front of the MDI.
`void`	`unblockDialog()` UnBlocks dialog so it may again receive events.

- Method Detail
  - getWindow
```
Container getWindow()
```
    Returns the window used by this controller.
    
    Returns:
    
    The internal frame.
  - init
```
void init()
```
    Called upon startup of the dialog - used by the runtime system. Preferably use a window open event defined in dmdialog to add code to startup.
  - dialogExceptionHandler
```
boolean dialogExceptionHandler(Throwable bad)
```
    Default handler for alle Runtime Exceptions.
    
    Parameters:
    
    bad - the caught exception
    
    Returns:
    
    true to continue error handling, false if the error is handled
  - getToolBarElements
```
@Deprecated
Vector getToolBarElements()
```
    Deprecated. use G9DialogFrame.getG9ToolBar()
    
    The list of toolbar elements to be added to the dynamic list of menu elements for this dialog as it recieves focus. The default method is generated by g9.
    
    Returns:
    
    List of toolbar elements.
  - g9DataEvent
```
void g9DataEvent(G9DataEvent eventData)
```
    Is called when someone sends a data event to the application.
    
    Parameters:
    
    eventData - The data object - user defined.
  - disposeDialog
```
void disposeDialog()
```
    Destroys this dialog.
  - getWindowTitle
```
String getWindowTitle()
```
    Returns the title of the main window as defined in the WindowBlock in g9.
    
    Returns:
    
    The initial title for the dialog's window.
  - setWindowTitle
```
void setWindowTitle(String title)
```
    Set the title of the dialog window.
    
    Parameters:
    
    title - the new title.
  - getServerApplicationName
```
String getServerApplicationName()
```
    Returns the name of the server application for the dialogs object selection
    
    Returns:
    
    The server application name
  - setServerApplicationName
```
void setServerApplicationName(String serverApplicationName)
```
    Sets the server application name for the dialogs object selection
    
    Parameters:
    
    serverApplicationName - (missing javadoc)
  - getDialogName
```
String getDialogName()
```
    Returns the dialog name of the dialog as defined in g9.
    
    Returns:
    
    The dialog name
  - obtain
```
String obtain(String objSelAttr)
```
    Performs obtain on the given object selection attribute found in this controller.
    
    Parameters:
    
    objSelAttr - The object selection to obtain value from.
    
    Returns:
    
    A String with the formatted value.
  - display
```
void display(String objSelAttr,
             Object value)
```
    Performs display on the given object selection with the given value found in this controller.
    
    Parameters:
    
    objSelAttr - The object selection to display value to.
    
    value - The value to display.
  - display
```
void display(String objSelAttr,
             Object value,
             boolean resetState)
```
    Updates the specified field from the object selection, and displays the new value.
    
    Parameters:
    
    objSelAttr - the name of the attribute (as in the object selection)
    
    value - the (domain) object with the acutal value to display
    
    resetState - Set to false to avoid resetting the attribute state.
  - toBack
```
void toBack()
```
    Sends this dialog to the back of the MDI.
  - toFront
```
void toFront()
```
    Sends this dialog to the front of the MDI.
  - setEnabledComponent
```
void setEnabledComponent(Component component,
                         boolean enabled)
```
    Recursivly enables or disables a component and all its children.
    
    Parameters:
    
    component - the component to disable
    
    enabled - if true the component is enabled.
    
    Since:
    
    version 8.1
  - setEnabledComponent
```
void setEnabledComponent(Component component,
                         boolean enabled,
                         boolean delay)
```
    Internal use. Application developers should invoke setEnabledComponent(Component, boolean).
    
    Parameters:
    
    component - (missing javadoc)
    
    enabled - (missing javadoc)
    
    delay - (missing javadoc)
  - setEnabledComponent
```
void setEnabledComponent(String name,
                         boolean enable)
```
    Recursivly enables or disables a component and all its children.
    
    Parameters:
    
    name - the (logical) name of the component to disable
    
    enable - if true the component is enabled.
    
    Since:
    
    version 8.1
  - setVisibleComponent
```
void setVisibleComponent(Component component,
                         boolean visible)
```
    Recursivly hides or shows a component and all its children.
    
    Parameters:
    
    component - the component to show or hide
    
    visible - if true the component is shown.
    
    Since:
    
    version 8.1
  - setVisibleComponent
```
void setVisibleComponent(Component component,
                         boolean visible,
                         boolean delay)
```
    Internal use. Application delvelopers should invoke setVisibleComponent(component, visible). Recursivly hides or shows a component and all its children.
    
    Parameters:
    
    component - the component to show or hide
    
    visible - if true the component is made visible, otherwise hidden
    
    delay - if true the visible task is delayed allowing other tasks on the EDT to finish.
  - setVisibleComponent
```
void setVisibleComponent(String name,
                         boolean visible)
```
    Recursivly hides or shows a component and all its children.
    
    Parameters:
    
    name - the (locical) name the component to show or hide
    
    visible - if true the component is shown.
    
    Since:
    
    version 8.1
  - setWaitCursor
```
void setWaitCursor()
```
    Changes cursor for this dialog into a wait cursor. It is advicable that the setNormalCursor is called before a new setWaitCursor call is made, even though the code attempts to clean up after multiple call to setWaitCursor prior to the call to setNormalCursor.
  - setModal
```
void setModal(boolean isModal)
```
    Make this dialog modal. It does this by calling blockDialog() in all dialogs open except the one that gets this call. pen dialogs exception the one receving this call to It remains modal until the dialog until the setModal(false) is performed. If a new dialog is created using the createDialog then it will not be part of the blocked windows. If the modal dialog is closed the blocked dialogs will reopen again.
    
    Parameters:
    
    isModal - True if modal, false to remove.
  - blockDialog
```
void blockDialog()
```
    Blocks dialog from receving any events whatsoever
  - unblockDialog
```
void unblockDialog()
```
    UnBlocks dialog so it may again receive events.
  - isBlocked
```
boolean isBlocked()
```
    Returns true if the dialog is blocked.
    
    Returns:
    
    Returns blocked status.
  - setNormalCursor
```
void setNormalCursor()
```
    Changes cursos for this dialog into a normal cursor.
  - g9Accelerator
```
boolean g9Accelerator(KeyEvent event)
```
    Callback from keyevents pass through this method. Used internally, do not use unless certain of effec.
    
    Parameters:
    
    event - The key event.
    
    Returns:
    
    True if the event was processed.
  - getView
```
G9DialogFrame getView()
```
    Gets the dialog window representing this dialog.
    
    Returns:
    
    the dialog window.
  - checkClear
```
boolean checkClear(String roleName)
```
    Perfoms checkClear on the specified root role
    
    Parameters:
    
    roleName - the name of the role
    
    Returns:
    
    true if it's ok to clear the role (and all children)
  - checkClose
```
boolean checkClose()
```
    Performs checkClose on this dialog.
    
    Returns:
    
    true if it's ok to close the dialog.
  - returnToCaller
```
void returnToCaller(Object returnObject)
```
    Handles the return from another dialog
    
    Parameters:
    
    returnObject - (missing javadoc)
  - startInit
```
void startInit(Object returnObject,
               Object startObject)
```
    Handles initialization of a dialog from another dialog
    
    Parameters:
    
    returnObject - (missing javadoc)
    
    startObject - (missing javadoc)
  - clearDialog
```
void clearDialog()
```
    Clears all window blocks in this dialog.
  - getObjectSelectionNode
```
ObjectSelectionNode getObjectSelectionNode(String roleName)
```
    Gets the role name method pointer, e.g if the roleName is "Order" it returns the field theOrder
    
    Parameters:
    
    roleName - the name of the role
    
    Returns:
    
    the ObjectSelectionNode associated with the roleName.
  - getApplication
```
ApplicationMethods getApplication()
```
    Returns the controller for the application
    
    Returns:
    
    the application controller.
  - getRoleObjects
```
List getRoleObjects(Object anObject)
```
    Returns the a list of role objects contained in this dialog representing the specified domain object.
    
    Parameters:
    
    anObject - the domain object
    
    Returns:
    
    a list of role objects.
  - getNewProxy
```
DomainObjectProxy getNewProxy(Object o,
                              String roleName)
```
    Internal use, returns a new DomainObjectProxy for the specified object and role name
    
    Parameters:
    
    o - the object
    
    roleName - the role name
    
    Returns:
    
    a object proxy
  - setAccessPolicy
```
void setAccessPolicy()
```
    This method is invoked after the dialog is fully realized and drawn on screen, so that you migth modify fields, set values etc.
    NoteThis method is called from the EDT, thus if you need to do some time consuming task, you should set up a dedicated thread and let the gui carry on (you might want to block the dialog though...).
    The pattern below show how to both set up a dedicated thread for the (possibly) time consuming task, and how to get back to the EDT for updating the dialog window.: // SET UP NEW THREAD CODE Runnable longTask = new Runnable() { public void run() { final Object someObject = LINES WITH TIME CONSUMING CODE... // G9_INTERNAL_DISPLAY CODE - GET BACK TO EDT SwingUtilities.invokeLater(new Runnable() { public void run() { // GUI CODE display(someObject); } }); } }; // INIT THREAD Thread longTimeThread = new Thread(longTask, "thread name"); longTimeThread.setPriority(Thread.NORM_PRIORITY); // START THREAD longTimeThread.start();
  - ignoreCheckChanged
```
boolean ignoreCheckChanged()
```
    Returns the ignoreCheckChanged property.
    
    Returns:
    
    the ignoreCheckChanged property
    
    See Also:
    
    setIgnoreCheckChanged(boolean)
  - setIgnoreCheckChanged
```
void setIgnoreCheckChanged(boolean ignoreCheckChange)
```
    Sets whether check change is to be executed or not. If the ignoreCheckChange property is set to true, check change will not be executed on nodes in the dialog.
    
    Parameters:
    
    ignoreCheckChange - the value of the checkChanged property.
  - clearObjectSelection
```
void clearObjectSelection()
```
    Recursivly clears all nodes from the object selection.
  - getRoleObjects
```
Map getRoleObjects()
```
    Returns a map of the role objects.
    
    Returns:
    
    a map of role objects.
  - isChanged
```
boolean isChanged(String osAttributeName)
           throws G9ClientException
```
    Check if the specified role attribute is changed. If the specified role attribute is not found a G9ClientException is thrown.
    
    Parameters:
    
    osAttributeName - the name of the attribute
    
    Returns:
    
    true if the field is changed, otherwise false
    
    Throws:
    
    G9ClientException - if the specified field is not found.
    
    See Also:
    
    ObjectSelectionNode.isChanged(String)
  - callHookCheckSave
```
ECheckResult callHookCheckSave(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckDelete
```
ECheckResult callHookCheckDelete(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckClose
```
ECheckResult callHookCheckClose(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckClear
```
ECheckResult callHookCheckClear(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckFind
```
ECheckResult callHookCheckFind(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckChange
```
ECheckResult callHookCheckChange(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check
  - callHookCheckRowSelect
```
ECheckResult callHookCheckRowSelect(String roleName,
                                    int curSel,
                                    int newSel)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    curSel - the current selection
    
    newSel - the new selection
    
    Returns:
    
    the result of the check
  - callHookCheckPrint
```
ECheckResult callHookCheckPrint(String roleName)
```
    Internal use. Forwards the call to the specified hook method.
    
    Parameters:
    
    roleName - the name of the node to check
    
    Returns:
    
    the result of the check

Interface G9DialogController

Method Summary

Method Detail

getWindow

init

dialogExceptionHandler

getToolBarElements

g9DataEvent

disposeDialog

getWindowTitle

setWindowTitle

getServerApplicationName

setServerApplicationName

getDialogName

obtain

display

display

toBack

toFront

setEnabledComponent

setEnabledComponent

setEnabledComponent

setVisibleComponent

setVisibleComponent

setVisibleComponent

setWaitCursor

setModal

blockDialog

unblockDialog

isBlocked

setNormalCursor

g9Accelerator

getView

checkClear

checkClose

returnToCaller

startInit

clearDialog

getObjectSelectionNode

getApplication

getRoleObjects

getNewProxy

setAccessPolicy

ignoreCheckChanged

setIgnoreCheckChanged

clearObjectSelection

getRoleObjects

isChanged

callHookCheckSave

callHookCheckDelete

callHookCheckClose

callHookCheckClear

callHookCheckFind

callHookCheckChange

callHookCheckRowSelect

callHookCheckPrint