ides.api.core
Interface UserInterface

public interface UserInterface

Interface for the services provided by the main window interface.

Author:

Lenko Grigorov

Method Summary

void	activateNotices() Bring forward the list of notices (NoticeBoard).
FontSizeSelector	getFontSelector() Access to the font selector element.
javax.swing.JComponent	getStatusBar() Access to the status bar.
java.awt.Frame	getWindow() Access to the main window.
ZoomControl	getZoomControl() Access to the zoom control element.
boolean	isWindowActivationAfterNoticePopup(java.awt.event.WindowEvent we) Returns true if the argument is a WindowEvent that describes the activation (gaining of focus) of the main window after the notices popup has just become deactivated (lost focus).
boolean	isWindowDeactivationDuetoNoticePopup(java.awt.event.WindowEvent we) Returns true if the argument is a WindowEvent that describes the deactivation (loss of focus) of the main window due to the notices popup becoming activated (gaining focus).

Method Detail

getWindow

java.awt.Frame getWindow()

Access to the main window.

Returns:

the main window of the application

getStatusBar

javax.swing.JComponent getStatusBar()

Access to the status bar.

Returns:

the status bar of the application

getZoomControl

ZoomControl getZoomControl()

Access to the zoom control element.

Returns:

the zoom control

getFontSelector

FontSizeSelector getFontSelector()

Access to the font selector element.

Returns:

the font selector

activateNotices

void activateNotices()

Bring forward the list of notices (NoticeBoard).

isWindowActivationAfterNoticePopup

boolean isWindowActivationAfterNoticePopup(java.awt.event.WindowEvent we)

Returns true if the argument is a WindowEvent that describes the activation (gaining of focus) of the main window after the notices popup has just become deactivated (lost focus).

This information is important in case some custom elements of the interface track the activation state of the main window. An activation of the main window can be followed by activation of the notices popup (main window becomes deactivated), which then switches focus back to the main window (main window becomes activated again). Thus, it may be necessary to differentiate between these two activation conditions.

Parameters:

we - event describing the change of window activation

Returns:

true if the argument is a WindowEvent that describes the activation (gaining of focus) of the main window after the notices popup has just become deactivated (lost focus); false otherwise

See Also:

isWindowDeactivationDuetoNoticePopup(WindowEvent)

isWindowDeactivationDuetoNoticePopup

boolean isWindowDeactivationDuetoNoticePopup(java.awt.event.WindowEvent we)

Returns true if the argument is a WindowEvent that describes the deactivation (loss of focus) of the main window due to the notices popup becoming activated (gaining focus).

This information is important in case some custom elements of the interface track the activation state of the main window. A deactivation of the main window may be due to the activation of the notices popup. Add-ons may wish to ignore this deactivation.

Parameters:

we - event describing the change of window activation

Returns:

true if the argument is a WindowEvent that describes the activation (gaining of focus) of the main window after the notices popup has just become deactivated (lost focus); false otherwise

See Also:

isWindowActivationAfterNoticePopup(WindowEvent)