com.altair.hwm.interfaces
Interface IMenuToolBarCustomizer

All Known Implementing Classes:

HWMMenuToolBarCustomizerAdapter

public interface IMenuToolBarCustomizer

Title: IMenuToolBarCustomizer

Description: This interface allows customization of menu and toolbars

Company: Altair Engineering, Inc.

Field Summary

static java.lang.String	MENU_TOOLBAR_EDIT
static java.lang.String	MENU_TOOLBAR_EDIT_COPY
static java.lang.String	MENU_TOOLBAR_EDIT_CUT
static java.lang.String	MENU_TOOLBAR_EDIT_DELETE
static java.lang.String	MENU_TOOLBAR_EDIT_DESELETCTALL
static java.lang.String	MENU_TOOLBAR_EDIT_PASTE
static java.lang.String	MENU_TOOLBAR_EDIT_SELETCTALL
static java.lang.String	MENU_TOOLBAR_FILE Constants for the menu and toolbar names
static java.lang.String	MENU_TOOLBAR_FILE_SAVEAS
static java.lang.String	MENU_TOOLBAR_FILECLOSE
static java.lang.String	MENU_TOOLBAR_FILEEXIT
static java.lang.String	MENU_TOOLBAR_FILENEW
static java.lang.String	MENU_TOOLBAR_FILEOPEN
static java.lang.String	MENU_TOOLBAR_FILEPREVIEW
static java.lang.String	MENU_TOOLBAR_FILEREOPEN
static java.lang.String	MENU_TOOLBAR_FILESAVE
static java.lang.String	MENU_TOOLBAR_HELP
static java.lang.String	MENU_TOOLBAR_HELPABOUT
static java.lang.String	MENU_TOOLBAR_HWM_WINDOWSLYAOUT_OPEN_PERSPECTIVE
static java.lang.String	MENU_TOOLBAR_LOOKANDFEEL
static java.lang.String	MENU_TOOLBAR_OPTIONS
static java.lang.String	MENU_TOOLBAR_PLAY
static java.lang.String	MENU_TOOLBAR_PLAYFROM
static java.lang.String	MENU_TOOLBAR_RUN
static java.lang.String	MENU_TOOLBAR_RUNBREAK
static java.lang.String	MENU_TOOLBAR_RUNSTOP
static java.lang.String	MENU_TOOLBAR_SHOWDMVIEWER
static java.lang.String	MENU_TOOLBAR_TOOLS
static java.lang.String	MENU_TOOLBAR_TOOLSMIGRATE
static java.lang.String	MENU_TOOLBAR_TOOLSTPLPREF
static java.lang.String	MENU_TOOLBAR_VALIDATETPL
static java.lang.String	MENU_TOOLBAR_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_CONTORL_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_DATAMODEL_VIEWER
static java.lang.String	MENU_TOOLBAR_VIEW_GRAPH_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_LAYOUT_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_PAGE_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_PROCESS_VIEW
static java.lang.String	MENU_TOOLBAR_VIEW_PROPERTY_VIEW
static java.lang.String	MENU_TOOLBAR_VIEWFILE
static java.lang.String	MENU_TOOLBAR_VIEWMSGLOG
static java.lang.String	MENU_TOOLBAR_VIEWRUN
static java.lang.String	MENU_TOOLBAR_VIEWWORKFLOW
static java.lang.String	MENU_TOOLBAR_WINDOWS
static java.lang.String	MENU_TOOLBAR_WINDOWSLAYOUT

Method Summary

void	EnableMenu(java.lang.String strName, boolean bEnable) Enable/disable menu with given name
void	EnableMenuItem(java.lang.String strMenuName, java.lang.String strMenuItemName, boolean bEnable) Enable/Disable menuitem with given name in the menu with given name
void	EnableMenuItems(java.lang.String strMenuName, java.lang.String[] arrstrMenuItemName, boolean bEnable) Enable/Disable array of menuitem with given names present in the menu
void	EnableToolBar(java.lang.String strName, boolean bEnable) Enable/disable the toolbar with given title
void	EnableToolBarComponent(java.lang.String strToolBarName, java.lang.String strCompName, boolean bEnable) Enable/disable a component in the toolbar, only if the toolbar is of type HWMToolBar
void	EnableToolBarComponents(java.lang.String strToolBarName, java.lang.String[] arrstrCompNames, boolean bEnable) Enable/disable components in the toolbar, only if the toolbar is of type HWMToolBar
javax.swing.JMenu	GetMenu(java.lang.String strName) Get the menu with given title
java.awt.Component	GetMenuComponent(java.lang.String strMenuName, java.lang.String strCompName) Return a component in the menu with given name.
AltairJToolBar	GetToolBar(java.lang.String strName) Get the toolbar with given title
java.awt.Component	GetToolBarComponent(java.lang.String strToolBarName, java.lang.String strCompName) Return a component in the toolbar with given name.
void	ShowMenu(java.lang.String strName, boolean bShow) Show/hide menu with given name
void	ShowMenuItem(java.lang.String strMenuName, java.lang.String strMenuItemName, boolean bShow) Show/hide menuitem with given name in the menu with given name
void	ShowMenuItems(java.lang.String strMenuName, java.lang.String[] arrstrMenuItemName, boolean bShow) Enable/Disable array of menuitem with given names present in the menu
void	ShowToolBar(java.lang.String strName, boolean bShow) Show the toolbar with given title
void	ShowToolBarComponent(java.lang.String strToolBarName, java.lang.String strCompName, boolean bShow) Show/hide a component in the toolbar, only if the toolbar is of type HWMToolBar
void	ShowToolBarComponents(java.lang.String strToolBarName, java.lang.String[] arrstrCompNames, boolean bShow) Show/hide components in the toolbar, only if the toolbar is of type HWMToolBar

Field Detail

MENU_TOOLBAR_FILE

static final java.lang.String MENU_TOOLBAR_FILE

Constants for the menu and toolbar names

See Also:

Constant Field Values

MENU_TOOLBAR_FILENEW

static final java.lang.String MENU_TOOLBAR_FILENEW

See Also:

Constant Field Values

MENU_TOOLBAR_FILEOPEN

static final java.lang.String MENU_TOOLBAR_FILEOPEN

See Also:

Constant Field Values

MENU_TOOLBAR_FILEPREVIEW

static final java.lang.String MENU_TOOLBAR_FILEPREVIEW

See Also:

Constant Field Values

MENU_TOOLBAR_FILECLOSE

static final java.lang.String MENU_TOOLBAR_FILECLOSE

See Also:

Constant Field Values

MENU_TOOLBAR_FILESAVE

static final java.lang.String MENU_TOOLBAR_FILESAVE

See Also:

Constant Field Values

MENU_TOOLBAR_FILEEXIT

static final java.lang.String MENU_TOOLBAR_FILEEXIT

See Also:

Constant Field Values

MENU_TOOLBAR_FILEREOPEN

static final java.lang.String MENU_TOOLBAR_FILEREOPEN

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEWFILE

static final java.lang.String MENU_TOOLBAR_VIEWFILE

See Also:

Constant Field Values

MENU_TOOLBAR_VIEWRUN

static final java.lang.String MENU_TOOLBAR_VIEWRUN

See Also:

Constant Field Values

MENU_TOOLBAR_VIEWWORKFLOW

static final java.lang.String MENU_TOOLBAR_VIEWWORKFLOW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEWMSGLOG

static final java.lang.String MENU_TOOLBAR_VIEWMSGLOG

See Also:

Constant Field Values

MENU_TOOLBAR_HELP

static final java.lang.String MENU_TOOLBAR_HELP

See Also:

Constant Field Values

MENU_TOOLBAR_LOOKANDFEEL

static final java.lang.String MENU_TOOLBAR_LOOKANDFEEL

See Also:

Constant Field Values

MENU_TOOLBAR_HELPABOUT

static final java.lang.String MENU_TOOLBAR_HELPABOUT

See Also:

Constant Field Values

MENU_TOOLBAR_WINDOWS

static final java.lang.String MENU_TOOLBAR_WINDOWS

See Also:

Constant Field Values

MENU_TOOLBAR_TOOLS

static final java.lang.String MENU_TOOLBAR_TOOLS

See Also:

Constant Field Values

MENU_TOOLBAR_TOOLSMIGRATE

static final java.lang.String MENU_TOOLBAR_TOOLSMIGRATE

See Also:

Constant Field Values

MENU_TOOLBAR_TOOLSTPLPREF

static final java.lang.String MENU_TOOLBAR_TOOLSTPLPREF

See Also:

Constant Field Values

MENU_TOOLBAR_VALIDATETPL

static final java.lang.String MENU_TOOLBAR_VALIDATETPL

See Also:

Constant Field Values

MENU_TOOLBAR_SHOWDMVIEWER

static final java.lang.String MENU_TOOLBAR_SHOWDMVIEWER

See Also:

Constant Field Values

MENU_TOOLBAR_RUN

static final java.lang.String MENU_TOOLBAR_RUN

See Also:

Constant Field Values

MENU_TOOLBAR_PLAY

static final java.lang.String MENU_TOOLBAR_PLAY

See Also:

Constant Field Values

MENU_TOOLBAR_PLAYFROM

static final java.lang.String MENU_TOOLBAR_PLAYFROM

See Also:

Constant Field Values

MENU_TOOLBAR_RUNSTOP

static final java.lang.String MENU_TOOLBAR_RUNSTOP

See Also:

Constant Field Values

MENU_TOOLBAR_RUNBREAK

static final java.lang.String MENU_TOOLBAR_RUNBREAK

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_PROCESS_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_PROCESS_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_PROPERTY_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_PROPERTY_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_LAYOUT_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_LAYOUT_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_CONTORL_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_CONTORL_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_PAGE_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_PAGE_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_GRAPH_VIEW

static final java.lang.String MENU_TOOLBAR_VIEW_GRAPH_VIEW

See Also:

Constant Field Values

MENU_TOOLBAR_OPTIONS

static final java.lang.String MENU_TOOLBAR_OPTIONS

See Also:

Constant Field Values

MENU_TOOLBAR_WINDOWSLAYOUT

static final java.lang.String MENU_TOOLBAR_WINDOWSLAYOUT

See Also:

Constant Field Values

MENU_TOOLBAR_HWM_WINDOWSLYAOUT_OPEN_PERSPECTIVE

static final java.lang.String MENU_TOOLBAR_HWM_WINDOWSLYAOUT_OPEN_PERSPECTIVE

See Also:

Constant Field Values

MENU_TOOLBAR_VIEW_DATAMODEL_VIEWER

static final java.lang.String MENU_TOOLBAR_VIEW_DATAMODEL_VIEWER

See Also:

Constant Field Values

MENU_TOOLBAR_FILE_SAVEAS

static final java.lang.String MENU_TOOLBAR_FILE_SAVEAS

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT

static final java.lang.String MENU_TOOLBAR_EDIT

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_CUT

static final java.lang.String MENU_TOOLBAR_EDIT_CUT

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_COPY

static final java.lang.String MENU_TOOLBAR_EDIT_COPY

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_PASTE

static final java.lang.String MENU_TOOLBAR_EDIT_PASTE

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_DELETE

static final java.lang.String MENU_TOOLBAR_EDIT_DELETE

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_SELETCTALL

static final java.lang.String MENU_TOOLBAR_EDIT_SELETCTALL

See Also:

Constant Field Values

MENU_TOOLBAR_EDIT_DESELETCTALL

static final java.lang.String MENU_TOOLBAR_EDIT_DESELETCTALL

See Also:

Constant Field Values

Method Detail

ShowMenu

void ShowMenu(java.lang.String strName,
              boolean bShow)
              throws java.lang.Exception

Show/hide menu with given name

Parameters:

strName - The name of the menu to show/hide

bShow - If true, the menu is shown else hidden

Throws:

java.lang.Exception

ShowMenuItem

void ShowMenuItem(java.lang.String strMenuName,
                  java.lang.String strMenuItemName,
                  boolean bShow)
                  throws java.lang.Exception

Show/hide menuitem with given name in the menu with given name

Parameters:

strMenuName - The name of the menu in which the menu item is present

strMenuItemName - The name of the menu item to Show/hide

bShow - If true, the menu item is shown else hidden

Throws:

java.lang.Exception

ShowMenuItems

void ShowMenuItems(java.lang.String strMenuName,
                   java.lang.String[] arrstrMenuItemName,
                   boolean bShow)
                   throws java.lang.Exception

Enable/Disable array of menuitem with given names present in the menu

Parameters:

strMenuName - The name of the menu in which the menu items are present

arrstrMenuItemName - The array of names of the menu items to enable/disable

bShow - If true, the menu is shown else hidden

Throws:

java.lang.Exception

EnableMenu

void EnableMenu(java.lang.String strName,
                boolean bEnable)
                throws java.lang.Exception

Enable/disable menu with given name

Parameters:

strName - The name of the menu to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

EnableMenuItem

void EnableMenuItem(java.lang.String strMenuName,
                    java.lang.String strMenuItemName,
                    boolean bEnable)
                    throws java.lang.Exception

Enable/Disable menuitem with given name in the menu with given name

Parameters:

strMenuName - The name of the menu in which the menu item is present

strMenuItemName - The name of the menu item to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

EnableMenuItems

void EnableMenuItems(java.lang.String strMenuName,
                     java.lang.String[] arrstrMenuItemName,
                     boolean bEnable)
                     throws java.lang.Exception

Enable/Disable array of menuitem with given names present in the menu

Parameters:

strMenuName - The name of the menu in which the menu items are present

arrstrMenuItemName - The array of names of the menu items to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

GetMenu

javax.swing.JMenu GetMenu(java.lang.String strName)
                          throws java.lang.Exception

Get the menu with given title

Parameters:

strName - The name of the menu to return

Returns:

JMenu The menu with given name or null if it does not exist.

Throws:

java.lang.Exception

GetMenuComponent

java.awt.Component GetMenuComponent(java.lang.String strMenuName,
                                    java.lang.String strCompName)
                                    throws java.lang.Exception

Return a component in the menu with given name.

Parameters:

strMenuName - The name of the menu

strCompName - The name of the component to return

Returns:

Component The component with the given name. May be null.

Throws:

java.lang.Exception

ShowToolBar

void ShowToolBar(java.lang.String strName,
                 boolean bShow)
                 throws java.lang.Exception

Show the toolbar with given title

Parameters:

strName - The name of the toolbar to return

bShow - If true, the toolbar is shown else hidden

Throws:

java.lang.Exception

ShowToolBarComponent

void ShowToolBarComponent(java.lang.String strToolBarName,
                          java.lang.String strCompName,
                          boolean bShow)
                          throws java.lang.Exception

Show/hide a component in the toolbar, only if the toolbar is of type HWMToolBar

Parameters:

strToolBbarName - The name of the toolbar

strCompName - The name of the component to show/hide

bShow - If true, the comp is shown else hidden

Throws:

java.lang.Exception

ShowToolBarComponents

void ShowToolBarComponents(java.lang.String strToolBarName,
                           java.lang.String[] arrstrCompNames,
                           boolean bShow)
                           throws java.lang.Exception

Show/hide components in the toolbar, only if the toolbar is of type HWMToolBar

Parameters:

strToolBbarName - The name of the toolbar

arrstrCompNames - The array of names of the components to show/hide

bShow - If true, the comp is shown else hidden

Throws:

java.lang.Exception

EnableToolBar

void EnableToolBar(java.lang.String strName,
                   boolean bEnable)
                   throws java.lang.Exception

Enable/disable the toolbar with given title

Parameters:

strName - The name of the toolbar to return

bEnable - If true, the toolbar is enabled else disabled

Throws:

java.lang.Exception

EnableToolBarComponent

void EnableToolBarComponent(java.lang.String strToolBarName,
                            java.lang.String strCompName,
                            boolean bEnable)
                            throws java.lang.Exception

Enable/disable a component in the toolbar, only if the toolbar is of type HWMToolBar

Parameters:

strToolBbarName - The name of the toolbar

strCompName - The name of the component to enable/disable

bEnable - If true, the comp is enabled else disabled

Throws:

java.lang.Exception

EnableToolBarComponents

void EnableToolBarComponents(java.lang.String strToolBarName,
                             java.lang.String[] arrstrCompNames,
                             boolean bEnable)
                             throws java.lang.Exception

Enable/disable components in the toolbar, only if the toolbar is of type HWMToolBar

Parameters:

strToolBbarName - The name of the toolbar

arrstrCompNames - The array of names of the components to enable/disable

bEnable - If true, the comp is enabled else disabled

Throws:

java.lang.Exception

GetToolBar

AltairJToolBar GetToolBar(java.lang.String strName)
                          throws java.lang.Exception

Get the toolbar with given title

Parameters:

strName - The name of the toolbar to return

Returns:

JToolBar The toolbar with given name or null if it does not exist.

Throws:

java.lang.Exception

GetToolBarComponent

java.awt.Component GetToolBarComponent(java.lang.String strToolBarName,
                                       java.lang.String strCompName)
                                       throws java.lang.Exception

Return a component in the toolbar with given name. This works only if the toolbar is of type HWMToolBar

Parameters:

strToolBbarName - The name of the toolbar

strCompName - The name of the component to return

Returns:

Component The component with the given name. May be null.

Throws:

java.lang.Exception