Skip navigation links

com.essbase.eas.client.intf
Interface Console

public interface Console

This interface defines what an administration console is. This interface should be used in the following manner:

An application should have a class that implements this interface. When the application starts it will create a single instance of the class, and register that instance with the ConsoleManager class.

Any other objects/components that need access to areas of the console call the ConsoleManager and request the instance of the object that implements the Console interface.

Notes:

Version:

1.00, 07/21/2000

Author:

Hank Cox

See Also:

ConsoleManager

Field Summary

static int	ID_ACTIONS_MENU
static int	ID_CLOSE_MENU
static int	ID_EDIT_MENU
static int	ID_EDITCOPY_MENU
static int	ID_EDITCUT_MENU
static int	ID_EDITORS_MENU
static int	ID_EDITPASTE_MENU
static int	ID_EDITREDO_MENU
static int	ID_EDITUNDO_MENU
static int	ID_EMAIL_MENU
static int	ID_EXIT_MENU
static int	ID_EXPORTTOXML_MENU
static int	ID_FILE_MENU
static int	ID_HELP_MENU
static int	ID_NEW_MENU
static int	ID_OPEN_MENU
static int	ID_PAGESETUP_MENU
static int	ID_PRINT_MENU
static int	ID_PRINTPREVIEW_MENU
static int	ID_SAVE_MENU
static int	ID_SAVEAS_MENU
static int	ID_TOOLS_MENU
static int	ID_VIEW_MENU
static int	ID_WINDOW_MENU
static int	ID_WIZARD_MENU

Method Summary

void	addEASServerListener(EASServerListener listener)
void	addFrameListener(java.awt.event.WindowListener l)
boolean	connectServer(java.lang.String server, java.lang.String user, java.lang.String password, boolean sslEnabled)
boolean	disconnectServer()
void	fireEASServerConnected()
void	fireEASServerDisconnected()
javax.swing.JMenu	getActionMenu() gets a reference to the console's action menu.
java.lang.String	getDefaultCaption() gets a default caption for dialog boxes, message boxes, etc.
CDesktopPane	getDesktopPane() gets a reference to the work area panel that the console is required to provide.
javax.swing.JMenu	getEditMenu() gets a reference to the console's edit menu.
javax.swing.JMenu	getFileMenu() gets a reference to the console's file menu.
java.awt.Component	getFocusOwner() Returns the current component that has the focus
java.awt.Component	getFrameComponent() gets a reference to the top-level frame window.
javax.swing.JMenu	getHelpMenu() gets a reference to the console's help menu.
javax.swing.ImageIcon	getIcon() Returns the frame icon if any
MessagePanel	getMessagePane() gets a reference to the console's message panel.
javax.swing.JTabbedPane	getNavigationPane() gets a reference to the tabbed panel in the navigation pane.
java.io.OutputStream	getOutputStreamForFile(java.lang.String category, java.lang.String filename)
javax.swing.JMenuBar	getPrimaryMenuBar() gets a reference to the console's main menu bar.
javax.swing.JTree	getPrimaryTree() gets a reference to the primary tree in the navigation panel.
java.io.Reader	getReaderForFile(java.lang.String category, java.lang.String filename, java.lang.String charset)
javax.swing.JRootPane	getRootPane()
java.lang.String	getSettingsPath() gets a path that can be used for a user's individual preferences.
StatusBar	getStatusBar() gets a reference to the console's status bar.
java.lang.String	getTitle() Gives the frame title
CToolBar	getToolbar() gets a reference to the console's tool bar.
javax.swing.JMenu	getToolsMenu() gets a reference to the console's tools menu.
javax.swing.JMenu	getViewMenu() gets a reference to the console's view menu.
javax.swing.JMenu	getWindowMenu() gets a reference to the console's window menu.
boolean	isConnected()
void	mergeActionMenu(java.awt.Component[] items) asks console object to merge these items on to the action menu.
void	mergeMenus(CInternalFrame f) lets the console object know that it needs to merge menus.
void	mergeMenus(java.awt.Component[] items) lets the console object know that it needs to merge menus.
java.lang.String	readSettings(java.lang.String filename)
void	removeEASServerListener(EASServerListener listener)
void	removeFrameListener(java.awt.event.WindowListener l)
void	resetBusyCursor() Resets the busy cursor to the default
java.lang.String	retrieveData(java.lang.String key)
boolean	retrieveData(java.lang.String key, java.lang.StringBuffer value) provides a persistence mechanism for retrieving stored data.
void	setActive() Makes the frame visible and brings the frame to the front.
void	setBusyCursor() Sets up the busy cursor
void	showMessagePanel(boolean bShow)
void	showNavigation(boolean bShow)
void	showOptions(java.lang.Class initialTab) shows the console optiontab
void	showStatusbar(boolean bShow)
void	showToolbar(boolean bShow)
boolean	storeData(java.lang.String key, java.lang.String value) provides a persistence mechanism for storing data.
void	unmergeActionMenu(java.lang.Object owner) asks the console object to menu items owned by this object from the action menu.
void	unmergeMenus(CInternalFrame f) lets the console object know that it needs to remove merged menus.
void	writeSettings(java.lang.String filename, java.lang.String content)

Field Detail

ID_FILE_MENU

static final int ID_FILE_MENU

See Also:

Constant Field Values

ID_EDIT_MENU

static final int ID_EDIT_MENU

See Also:

Constant Field Values

ID_VIEW_MENU

static final int ID_VIEW_MENU

See Also:

Constant Field Values

ID_ACTIONS_MENU

static final int ID_ACTIONS_MENU

See Also:

Constant Field Values

ID_TOOLS_MENU

static final int ID_TOOLS_MENU

See Also:

Constant Field Values

ID_WINDOW_MENU

static final int ID_WINDOW_MENU

See Also:

Constant Field Values

ID_HELP_MENU

static final int ID_HELP_MENU

See Also:

Constant Field Values

ID_NEW_MENU

static final int ID_NEW_MENU

See Also:

Constant Field Values

ID_OPEN_MENU

static final int ID_OPEN_MENU

See Also:

Constant Field Values

ID_CLOSE_MENU

static final int ID_CLOSE_MENU

See Also:

Constant Field Values

ID_SAVE_MENU

static final int ID_SAVE_MENU

See Also:

Constant Field Values

ID_SAVEAS_MENU

static final int ID_SAVEAS_MENU

See Also:

Constant Field Values

ID_PAGESETUP_MENU

static final int ID_PAGESETUP_MENU

See Also:

Constant Field Values

ID_EXPORTTOXML_MENU

static final int ID_EXPORTTOXML_MENU

See Also:

Constant Field Values

ID_PRINTPREVIEW_MENU

static final int ID_PRINTPREVIEW_MENU

See Also:

Constant Field Values

ID_PRINT_MENU

static final int ID_PRINT_MENU

See Also:

Constant Field Values

ID_WIZARD_MENU

static final int ID_WIZARD_MENU

See Also:

Constant Field Values

ID_EDITORS_MENU

static final int ID_EDITORS_MENU

See Also:

Constant Field Values

ID_EMAIL_MENU

static final int ID_EMAIL_MENU

See Also:

Constant Field Values

ID_EXIT_MENU

static final int ID_EXIT_MENU

See Also:

Constant Field Values

ID_EDITUNDO_MENU

static final int ID_EDITUNDO_MENU

See Also:

Constant Field Values

ID_EDITREDO_MENU

static final int ID_EDITREDO_MENU

See Also:

Constant Field Values

ID_EDITCUT_MENU

static final int ID_EDITCUT_MENU

See Also:

Constant Field Values

ID_EDITCOPY_MENU

static final int ID_EDITCOPY_MENU

See Also:

Constant Field Values

ID_EDITPASTE_MENU

static final int ID_EDITPASTE_MENU

See Also:

Constant Field Values

Method Detail

getDesktopPane

CDesktopPane getDesktopPane()

gets a reference to the work area panel that the console is required to provide.

getNavigationPane

javax.swing.JTabbedPane getNavigationPane()

gets a reference to the tabbed panel in the navigation pane.

getPrimaryTree

javax.swing.JTree getPrimaryTree()

gets a reference to the primary tree in the navigation panel.

getToolbar

CToolBar getToolbar()

gets a reference to the console's tool bar.

getStatusBar

StatusBar getStatusBar()

gets a reference to the console's status bar.

getMessagePane

MessagePanel getMessagePane()

gets a reference to the console's message panel.

getFrameComponent

java.awt.Component getFrameComponent()

gets a reference to the top-level frame window. In most cases this is the same object as implementing the console; however, it isn't a requirement, so ...

getPrimaryMenuBar

javax.swing.JMenuBar getPrimaryMenuBar()

gets a reference to the console's main menu bar. Note: we couldn't call this getMenuBar() since java.awt.Frame has a similar method.

getFileMenu

javax.swing.JMenu getFileMenu()

gets a reference to the console's file menu.

getEditMenu

javax.swing.JMenu getEditMenu()

gets a reference to the console's edit menu.

getViewMenu

javax.swing.JMenu getViewMenu()

gets a reference to the console's view menu.

getActionMenu

javax.swing.JMenu getActionMenu()

gets a reference to the console's action menu.

getToolsMenu

javax.swing.JMenu getToolsMenu()

gets a reference to the console's tools menu.

getWindowMenu

javax.swing.JMenu getWindowMenu()

gets a reference to the console's window menu.

getHelpMenu

javax.swing.JMenu getHelpMenu()

gets a reference to the console's help menu.

mergeMenus

void mergeMenus(CInternalFrame f)

lets the console object know that it needs to merge menus.

unmergeMenus

void unmergeMenus(CInternalFrame f)

lets the console object know that it needs to remove merged menus.

mergeMenus

void mergeMenus(java.awt.Component[] items)

lets the console object know that it needs to merge menus.

mergeActionMenu

void mergeActionMenu(java.awt.Component[] items)

asks console object to merge these items on to the action menu.

unmergeActionMenu

void unmergeActionMenu(java.lang.Object owner)

asks the console object to menu items owned by this object from the action menu.

getDefaultCaption

java.lang.String getDefaultCaption()

gets a default caption for dialog boxes, message boxes, etc.

getSettingsPath

java.lang.String getSettingsPath()

gets a path that can be used for a user's individual preferences.

showNavigation

void showNavigation(boolean bShow)

showMessagePanel

void showMessagePanel(boolean bShow)

showToolbar

void showToolbar(boolean bShow)

showStatusbar

void showStatusbar(boolean bShow)

storeData

boolean storeData(java.lang.String key,
                  java.lang.String value)

provides a persistence mechanism for storing data. Call this method with a key that should be unique.

Parameters:

key - unique identifier for data to be stored.

value - string representation of the data to be stored.

Returns:

true if successful; false if not.

See Also:

retrieveData(java.lang.String, java.lang.StringBuffer)

retrieveData

boolean retrieveData(java.lang.String key,
                     java.lang.StringBuffer value)

provides a persistence mechanism for retrieving stored data. Call this method with a key that should be unique.

Parameters:

key - unique identifier for data to be retrieved.

value - buffer to place the data in.

Returns:

true if successful; false if not.

See Also:

storeData(java.lang.String, java.lang.String)

retrieveData

java.lang.String retrieveData(java.lang.String key)

showOptions

void showOptions(java.lang.Class initialTab)

shows the console optiontab

addFrameListener

void addFrameListener(java.awt.event.WindowListener l)

removeFrameListener

void removeFrameListener(java.awt.event.WindowListener l)

disconnectServer

boolean disconnectServer()

connectServer

boolean connectServer(java.lang.String server,
                      java.lang.String user,
                      java.lang.String password,
                      boolean sslEnabled)

isConnected

boolean isConnected()

getIcon

javax.swing.ImageIcon getIcon()

Returns the frame icon if any

Returns:

frame icon

setActive

void setActive()

Makes the frame visible and brings the frame to the front.

getTitle

java.lang.String getTitle()

Gives the frame title

Returns:

frame title

getFocusOwner

java.awt.Component getFocusOwner()

Returns the current component that has the focus

Returns:

the focus owner

setBusyCursor

void setBusyCursor()

Sets up the busy cursor

resetBusyCursor

void resetBusyCursor()

Resets the busy cursor to the default

getReaderForFile

java.io.Reader getReaderForFile(java.lang.String category,
                                java.lang.String filename,
                                java.lang.String charset)
                                throws java.io.IOException

Returns:

Throws:

java.io.IOException

getOutputStreamForFile

java.io.OutputStream getOutputStreamForFile(java.lang.String category,
                                            java.lang.String filename)
                                            throws java.io.IOException

Throws:

java.io.IOException

getRootPane

javax.swing.JRootPane getRootPane()

addEASServerListener

void addEASServerListener(EASServerListener listener)

removeEASServerListener

void removeEASServerListener(EASServerListener listener)

fireEASServerDisconnected

void fireEASServerDisconnected()

fireEASServerConnected

void fireEASServerConnected()

writeSettings

void writeSettings(java.lang.String filename,
                   java.lang.String content)
                   throws java.io.IOException

Throws:

java.io.IOException

readSettings

java.lang.String readSettings(java.lang.String filename)
                              throws java.io.IOException

Throws:

java.io.IOException

Skip navigation links