com.apelon.apps.dts.editor.modules
Interface DTSEditorModuleMgr


public interface DTSEditorModuleMgr

Provides access to necessary DTSEditor functions and DTS Services to use in DTS Editor modules.

Since:
DTS 3.4.0
Version:
1.0
Author:
Apelon Inc.

Method Summary
 JDialog createDialog(JPanel panel, String panelName)
          Creates a new JDialog for the JPanel.
 JDialog createDialog(JPanel panel, String panelName, int width, int height)
          Creates a new JDialog for the JPanel.
 JDialog createDialog(JPanel panel, String panelName, int width, int height, boolean cascade)
          Creates a new JDialog for the JPanel.
 JDialog createDialog(JPanel panel, String panelName, int width, int height, boolean cascade, Preferences preference)
          Creates a new JDialog for the JPanel.
 DTSEditorConfig getDTSEditorConfig()
          Get the current DTS Editor Configuration settings.
 JTabbedPane getLeftTabbedPane()
          Get the JTabbedPane representing the left side panel configuration of the DTS Editor.
 JTabbedPane getRightTabbedPane()
          Get the JTabbedPane representing the right side panel configuration of the DTS Editor.
 ServerConnection getServerConnection()
          Get the DTS Editor's Current Connection to the Server
 void handleException(String msg, Exception ex)
          Handle any Exception.
 void registerConnectionListener(DtsConnectionListener listener)
          Register this DtsConnectionListener object.
 void showErrorMessage(String message)
          Displays an error message in a dialog by simply passing the message to be displayed.
 void showHelpPanel(URL url)
          This method shows the help page along with the default browser registered in the system.
 void unregisterConnectionListener(DtsConnectionListener listener)
          Unregister this DtsConnectionListener object.
 

Method Detail

getDTSEditorConfig

DTSEditorConfig getDTSEditorConfig()
Get the current DTS Editor Configuration settings.

Returns:
DTSEditorConfig
Since:
DTS 3.4.0

getLeftTabbedPane

JTabbedPane getLeftTabbedPane()
Get the JTabbedPane representing the left side panel configuration of the DTS Editor. Use the returned JTabbedPane object to add a panel to the left tabbed pane.

Returns:
JTabbedPane
Since:
DTS 3.4.0

getRightTabbedPane

JTabbedPane getRightTabbedPane()
Get the JTabbedPane representing the right side panel configuration of the DTS Editor. Use the returned JTabbedPane object to add a panel to the right tabbed pane.

Returns:
JTabbedPane
Since:
DTS 3.4.0

registerConnectionListener

void registerConnectionListener(DtsConnectionListener listener)
Register this DtsConnectionListener object.

Parameters:
listener - a valid DtsConnectionListenerObject
Since:
DTS 3.4.0
See Also:
DtsConnectionListener

unregisterConnectionListener

void unregisterConnectionListener(DtsConnectionListener listener)
Unregister this DtsConnectionListener object.

Parameters:
listener - a valid DtsConnectionListenerObject
Since:
DTS 3.4.0
See Also:
DtsConnectionListener

getServerConnection

ServerConnection getServerConnection()
Get the DTS Editor's Current Connection to the Server

Returns:
ServerConnection
Since:
DTS 3.4.0

createDialog

JDialog createDialog(JPanel panel,
                     String panelName)
Creates a new JDialog for the JPanel. The title of the dialog is set to the given Panel Name. The size of the dialog is set to 500x400.

Parameters:
panel - JPanel this dialog will contain
panelName - Name of the Panel. Set as the title of the Dialog
Returns:
New JDialog

createDialog

JDialog createDialog(JPanel panel,
                     String panelName,
                     int width,
                     int height)
Creates a new JDialog for the JPanel. The title of the dialog is set to the given Panel Name. The size of the dialog is set using the given width and height. The dialog is not cascaded to the dialog of the same name created earlier.

Parameters:
panel - JPanel this dialog will contain
panelName - Name of the Panel. Set as the title of the Dialog
width - Default width. This is used if a value is not obtained from saved setting.
height - Default height. This is used if a value is not obtained from saved setting.
Returns:
New JDialog

createDialog

JDialog createDialog(JPanel panel,
                     String panelName,
                     int width,
                     int height,
                     boolean cascade)
Creates a new JDialog for the JPanel. The title of the dialog is set to the given Panel Name. The size of the dialog is set using the given width and height. If cascade is true, the location of the dialog is set relative to the dialog of the same name created earlier.

The size and location of the dialog created is saved in Preference of the given panel class node.

Parameters:
panel - JPanel this dialog will contain
panelName - Name of the Panel. Set as the title of the Dialog
width - Default width. This is used if a value is not obtained from saved setting.
height - Default height. This is used if a value is not obtained from saved setting.
cascade - If true, cascade, else not
Returns:
New JDialog

createDialog

JDialog createDialog(JPanel panel,
                     String panelName,
                     int width,
                     int height,
                     boolean cascade,
                     Preferences preference)
Creates a new JDialog for the JPanel. The title of the dialog is set to the given Panel Name. The size of the dialog is set using the given width and height. If cascade is true, the location of the dialog is set relative to the dialog of the same name created earlier.

If a prefernce is supplied, the dialog will use the size and location from the preference. The size and location of the dialog created is saved in the given Preference when the dialog moves or is resized.

Parameters:
panel - JPanel this dialog will contain
panelName - Name of the Panel. Set as the title of the Dialog
width - Default width. This is used if a value is not obtained from saved setting.
height - Default height. This is used if a value is not obtained from saved setting.
cascade - If true, cascade, else not
preference - Preference to store location and size of the dialog
Returns:
New JDialog

showHelpPanel

void showHelpPanel(URL url)
This method shows the help page along with the default browser registered in the system. As of now this method supports windows and netscape under unix.

Parameters:
url - File URL of the help file.
Since:
DTS 3.4.0

showErrorMessage

void showErrorMessage(String message)
Displays an error message in a dialog by simply passing the message to be displayed.

Parameters:
message - message to be displayed
Since:
DTS 3.4.0

handleException

void handleException(String msg,
                     Exception ex)
Handle any Exception. Handler will display the error string msg and log the exception. It will attempt to decode the Exception, combine it with the message argument and display the extended message in an error dialog. It will pop up an error message if the DTS socket server connection has been lost.

Parameters:
msg - message to be displayed
ex - DTSException
Since:
DTS 3.4.0
See Also:
Exception


Copyright © 2011. All Rights Reserved.