net.java.sip.communicator.service.gui
Interface ExportedWindow

All Known Subinterfaces:

PopupDialog

All Known Implementing Classes:

AboutWindow, AbstractExportedWindow, AddContactDialog, ChatWindow, MainFrame, PopupDialogImpl

public interface ExportedWindow

A window that could be shown, hidden, resized, moved, etc. Meant to be used from other services to show an application window, like for example a "Configuration" or "Add contact" window.

Author:

Yana Stamcheva

Field Summary

static WindowID	ABOUT_WINDOW The about window identifier.
static WindowID	ADD_CONTACT_WINDOW The add contact window identifier.
static WindowID	CHAT_WINDOW The chat window identifier.
static WindowID	MAIN_WINDOW The main (contact list) window identifier.

Method Summary

void	bringToFront() Brings the focus to this window.
WindowID	getIdentifier() Returns the WindowID corresponding to this window.
Object	getSource() The source of the window
boolean	isFocused() Returns TRUE if this component is currently the focused component, FALSE - otherwise.
boolean	isVisible() Returns TRUE if the component is visible and FALSE otherwise.
void	maximize() Maximizes the window.
void	minimize() Minimizes the window.
void	setLocation(int x, int y) Moves the window to the given coordinates.
void	setParams(Object[] windowParams) This method can be called to pass any params to the exported window.
void	setSize(int width, int height) Resizes the window with the given width and height.
void	setVisible(boolean isVisible) Shows or hides this component.

Field Detail

ADD_CONTACT_WINDOW

static final WindowID ADD_CONTACT_WINDOW

The add contact window identifier.

ABOUT_WINDOW

static final WindowID ABOUT_WINDOW

The about window identifier.

CHAT_WINDOW

static final WindowID CHAT_WINDOW

The chat window identifier.

MAIN_WINDOW

static final WindowID MAIN_WINDOW

The main (contact list) window identifier.

Method Detail

getIdentifier

WindowID getIdentifier()

Returns the WindowID corresponding to this window. The window id should be one of the defined in this class XXX_WINDOW constants.

Returns:

the WindowID corresponding to this window

isVisible

boolean isVisible()

Returns TRUE if the component is visible and FALSE otherwise.

Returns:

true if the component is visible and false otherwise.

isFocused

boolean isFocused()

Returns TRUE if this component is currently the focused component, FALSE - otherwise.

Returns:

TRUE if this component is currently the focused component, FALSE - otherwise.

setVisible

void setVisible(boolean isVisible)

Shows or hides this component.

Parameters:

isVisible - indicates whether to set this window visible or hide it

bringToFront

void bringToFront()

Brings the focus to this window.

setSize

void setSize(int width,
             int height)

Resizes the window with the given width and height.

Parameters:

width - The new width.

height - The new height.

setLocation

void setLocation(int x,
                 int y)

Moves the window to the given coordinates.

Parameters:

x - The x coordinate.

y - The y coordinate.

minimize

void minimize()

Minimizes the window.

maximize

void maximize()

Maximizes the window.

getSource

Object getSource()

The source of the window

Returns:

the source of the window

setParams

void setParams(Object[] windowParams)

This method can be called to pass any params to the exported window. This method will be automatically called by UIService.getExportedWindow(WindowID, Object[]) in order to set the parameters passed.

Parameters:

windowParams - the parameters to pass.