ides.api.plugin.presentation
Interface UIDescriptor

public interface UIDescriptor

The descriptor of what UI elements will be available to the user when a model is activated. This descriptor is constructed by the Toolset for the specific type of model.

Author:

Lenko Grigorov

See Also:

Toolset

Method Summary

Presentation[]	getLeftPanePresentations() As of IDES version 3, this method does nothing.
Presentation[]	getMainPanePresentations() Retrieve the list of Presentations to be added to the main pane of the IDES interface when the model is activated.
javax.swing.JMenu[]	getMenus() Retrieve the menus to be added to the IDES menu when the model is activated.
Presentation[]	getRightPanePresentations() Retrieve the list of Presentations to appear on the right side of the main pane of IDES when the model is activated.
Presentation	getStatusBar() Retrieve the Presentation which will be added to the status bar of IDES when the model is activated.
javax.swing.JToolBar	getToolbar() Retrieve a toolbar with icons to be added to the IDES toolbar when the model is activated.

Method Detail

getMainPanePresentations

Presentation[] getMainPanePresentations()

Retrieve the list of Presentations to be added to the main pane of the IDES interface when the model is activated. Each Presentation will be added in a separate tab.

Note: This method may be called multiple times for the same model, so new Presentations should not be instantiated at each call.

Returns:

the list of Presentations to be added to the main pane of the IDES interface

getLeftPanePresentations

Presentation[] getLeftPanePresentations()

As of IDES version 3, this method does nothing.

Retrieve the list of Presentations to appear on the left side of the main pane of IDES when the model is activated. Each Presentation will be added in a separate tab.

Note: This method may be called multiple times for the same model, so new Presentations should not be instantiated at each call.

Returns:

the list of Presentations to appear on the left side of the main pane of IDES

getRightPanePresentations

Presentation[] getRightPanePresentations()

Retrieve the list of Presentations to appear on the right side of the main pane of IDES when the model is activated. Each Presentation will be added in a separate tab.

Note: This method may be called multiple times for the same model, so new Presentations should not be instantiated at each call.

Returns:

the list of Presentations to appear on the right side of the main pane of IDES

getMenus

javax.swing.JMenu[] getMenus()

Retrieve the menus to be added to the IDES menu when the model is activated.

Note: This method may be called multiple times for the same model, so new menus should not be instantiated at each call.

Returns:

the menus to be added to the IDES menu

getToolbar

javax.swing.JToolBar getToolbar()

Retrieve a toolbar with icons to be added to the IDES toolbar when the model is activated.

Note: This method may be called multiple times for the same model, so a new toolbar should not be instantiated at each call.

Returns:

the toolbar with icons to be added to the IDES toolbar

getStatusBar

Presentation getStatusBar()

Retrieve the Presentation which will be added to the status bar of IDES when the model is activated.

Note: This method may be called multiple times for the same model, so a new Presentation should not be instantiated at each call.

Returns:

the Presentation which will be added to the status bar of IDES

See Also:

Hub.getUserInterface(), UserInterface.getStatusBar()