com.togethersoft.openapi.ide.message
Interface IdeMessageManager

public interface IdeMessageManager

Interface IdeMessageManager controls the visibility of Together's message pane and
defines methods for getting a default message page and adding/removing the user-defined message pages.

Current IdeMessageManager can be obtained via IdeMessageManagerAccess.getMessageManager method.

Author:

TogetherSoft

Since: Together 3.0

See Also: IdeMessageManagerAccess.getMessageManager()

public void closePage(IdeMessagePage page)

Closes specified page.

Parameters:

page IdeMessagePage to close

public IdeMessagePage findPage(Object pageID)

Finds IdeMessagePage with the specified ID.

Parameters:

pageID Object ID of a page

Returns: IdeMessagePage with the specified ID or null if such page doesn't exist

See Also:

openPage(java.lang.Object), closePage(com.togethersoft.openapi.ide.message.IdeMessagePage)

public IdeMessagePage getActivePage()

Returns the active IdeMessagePage.

Returns: IdeMessagePage

public IdeMessagePage getDefaultPage()

Returns Together's message page, where all the Together messages are displayed.

Returns: the default IdeMessagePage

See Also:

IdeMessagePage

public Component getUIComponent()

Returns AWT component that represents this message pane.

Since:

Together 3.1

public boolean isPaneVisible()

Checks whether the Together's message pane is visible on the screen.

Returns: true if the message pane if visible, false otherwise

public IdeMessagePage openPage(Object pageID)

Opens a message page with the specified ID. If such page doesn't exist, then creates and opens a new page. This method
creates a standard Together message page (similar to the default page). To create user-defined pages, method
openPage(Object, Component, IdeMessageView) is used.

Parameters:

pageID Object ID of the page to be opened

Returns: opened IdeMessagePage

See Also:

openPage(java.lang.Object,java.awt.Component,com.togethersoft.openapi.ide.message.IdeMessageView), closePage(com.togethersoft.openapi.ide.message.IdeMessagePage)

public IdeMessagePage openPage(Object pageID, Component page, IdeMessageView messageView)

Adds a user-definded message page to the Together's message pane.

Parameters:

pageID Object ID of the page to be added

page Component object

messageView IdeMessageView object containing user-defined implementaion
of the message printing methods. If null, the standard implementation of methods
printMessage(int type, String text, String sourceURL, String helpURL) and
printMessage(int type, String text) will be used.

Returns: opened IdeMessagePage

See Also:

openPage(java.lang.Object), setActivePage(com.togethersoft.openapi.ide.message.IdeMessagePage), IdeMessageView

public void requestFocus()

Requests that the message pane get the focus. The message pane must be visible on the screen for
this request to be granted.

public void setActivePage(IdeMessagePage page)

Sets specified message page active. If this page was previously closed using
closePage method, it has to be reopened using openPage method before activating.

Parameters:

page IdeMessagePage to set active

See Also:

closePage(com.togethersoft.openapi.ide.message.IdeMessagePage), openPage(java.lang.Object), openPage(java.lang.Object,java.awt.Component,com.togethersoft.openapi.ide.message.IdeMessageView), IdeMessagePage

public void setPaneVisible(boolean value)

Sets the visibility of the Together's message pane.

Parameters:

value boolean flag. If true then the message pane will be made
visible, invisible otherwise.