net.java.sip.communicator.impl.gui.main
Class MainFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      net.java.sip.communicator.util.swing.SIPCommFrame
                          net.java.sip.communicator.impl.gui.main.MainFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Observer, Accessible, RootPaneContainer, WindowConstants, PluginComponentListener, ExportedWindow, Skinnable

public class MainFrame
extends SIPCommFrame
implements ExportedWindow, PluginComponentListener, Skinnable

The main application window. This class is the core of this UI implementation. It stores all available protocol providers and their operation sets, as well as all registered accounts, the MetaContactListService and all sent messages that aren't delivered yet.

Author:

Yana Stamcheva, Lubomir Marinov, Adam Netocny

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.java.sip.communicator.util.swing.SIPCommFrame

SIPCommFrame.MainContentPane

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface net.java.sip.communicator.service.gui.ExportedWindow

ABOUT_WINDOW, ADD_CONTACT_WINDOW, CHAT_WINDOW, MAIN_WINDOW

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

MainFrame()
Creates an instance of MainFrame.

Method Summary

void	addAccount(ProtocolProviderService protocolProvider) Adds an account to the application.
void	addNativePlugins() Adds all native plugins to this container.
void	addProtocolProvider(ProtocolProviderService protocolProvider) Adds a protocol provider.
void	addProtocolSupportedOperationSets(ProtocolProviderService protocolProvider) Adds all protocol supported operation sets.
void	addProviderContactHandler(ProtocolProviderService protocolProvider, ContactEventHandler contactHandler) Adds the given contactHandler to handle contact events for the given protocolProvider.
void	addSearchFieldListener(TextFieldChangeListener l) Adds the given TextFieldChangeListener to listen for any changes that occur in the search field.
void	bringToFront() Brings this window to front.
void	clearCurrentSearchText() Clears the current text in the search field.
protected void	close(boolean isEscaped) Overwrites the SIPCommFrame close method.
void	ctrlEnterKeyTyped() Called when the CTRL-ENTER or CMD-ENTER keys were typed when this window was the focused window.
void	enableUnknownContactView(boolean isEnabled) Enters or exits the "unknown contact" view.
String	getAccountAddress(ProtocolProviderService protocolProvider) Returns the account user id for the given protocol provider.
String	getAccountDisplayName(ProtocolProviderService protocolProvider) Returns the account user display name for the given protocol provider.
AccountStatusPanel	getAccountStatusPanel() Returns the account status panel.
OperationSetAdHocMultiUserChat	getAdHocMultiUserChatOpSet(ProtocolProviderService protocolProvider) Returns the multi user chat operation set for the given protocol provider.
ContactEventHandler	getContactHandler(ProtocolProviderService protocolProvider) Returns the ContactEventHandler registered for this protocol provider.
ContactListPane	getContactListPanel() Returns the panel containing the ContactList.
String	getCurrentSearchText() Returns the text currently shown in the search field.
WindowID	getIdentifier() Returns the identifier of this window.
MainMenu	getMainMenu() Returns the main menu in the application window.
OperationSetMultiUserChat	getMultiUserChatOpSet(ProtocolProviderService protocolProvider) Returns the multi user chat operation set for the given protocol provider.
static OperationSetPresence	getProtocolPresenceOpSet(ProtocolProviderService protocolProvider) Returns the presence operation set for the given protocol provider.
ProtocolProviderService	getProtocolProviderForAccount(String accountName) Returns the protocol provider associated to the account given by the account user identifier.
Object	getProtocolProviderLastStatus(ProtocolProviderService protocolProvider) If the protocol provider supports presence operation set searches the last status which was selected, otherwise returns null.
Iterator<ProtocolProviderService>	getProtocolProviders() Returns a set of all protocol providers.
int	getProviderIndex(ProtocolProviderService protocolProvider) Returns the index of the given protocol provider.
Object	getSource() Returns this window.
OperationSetBasicTelephony<?>	getTelephonyOpSet(ProtocolProviderService protocolProvider) Returns the telephony operation set for the given protocol provider.
OperationSetWebContactInfo	getWebContactInfoOpSet(ProtocolProviderService protocolProvider) Returns the Web Contact Info operation set for the given protocol provider.
boolean	hasProtocolProvider(ProtocolProviderService protocolProvider) Checks whether we have already loaded the protocol provider.
void	initBounds() Sets frame size and position.
boolean	isFrameVisible() Implements isVisible in the UIService interface.
void	loadSkin() Reloads skin information
void	maximize() Maximizes this window.
void	minimize() Minimizes this window.
void	pluginComponentAdded(PluginComponentEvent event) Adds the associated with this PluginComponentEvent component to the appropriate container.
void	pluginComponentRemoved(PluginComponentEvent event) Removes the associated with this PluginComponentEvent component from this container.
void	removeProtocolProvider(ProtocolProviderService protocolProvider) Adds an account to the application.
void	removeProtocolSupportedOperationSets(ProtocolProviderService protocolProvider) Removes all protocol supported operation sets.
void	removeProviderContactHandler(ProtocolProviderService protocolProvider) Removes the ContactEventHandler corresponding to the given protocolProvider.
void	removeSearchFieldListener(TextFieldChangeListener l) Removes the given TextFieldChangeListener that listens for any changes that occur in the search field.
void	requestFocusInCenterPanel() Requests the focus in the center panel, which contains either the contact list or the unknown contact panel.
void	setContactList(MetaContactListService contactList) Initializes the contact list panel.
void	setFrameVisible(boolean isVisible) Implements setVisible in the UIService interface.
void	setParams(Object[] windowParams) Implementation of ExportedWindow.setParams(Object[]).
protected void	windowClosed(WindowEvent event)
protected void	windowClosing(WindowEvent event) Overrides SIPCommFrame#windowClosing(WindowEvent).

Methods inherited from class net.java.sip.communicator.util.swing.SIPCommFrame

addKeybindingAction, dispose, setKeybindingInput, setSizeAndLocation, setVisible, setVisible, update, validate

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.java.sip.communicator.service.gui.ExportedWindow

isFocused, isVisible, setLocation, setSize, setVisible

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

MainFrame

public MainFrame()

Creates an instance of MainFrame.

Method Detail

requestFocusInCenterPanel

public void requestFocusInCenterPanel()

Requests the focus in the center panel, which contains either the contact list or the unknown contact panel.

initBounds

public void initBounds()

Sets frame size and position.

enableUnknownContactView

public void enableUnknownContactView(boolean isEnabled)

Enters or exits the "unknown contact" view. This view will propose to the user some specific operations if the current filter doesn't match any contacts.

Parameters:

isEnabled - true to enable the "unknown contact" view, false - otherwise.

setContactList

public void setContactList(MetaContactListService contactList)

Initializes the contact list panel.

Parameters:

contactList - The MetaContactListService containing the contact list data.

addProtocolSupportedOperationSets

public void addProtocolSupportedOperationSets(ProtocolProviderService protocolProvider)

Adds all protocol supported operation sets.

Parameters:

protocolProvider - The protocol provider.

removeProtocolSupportedOperationSets

public void removeProtocolSupportedOperationSets(ProtocolProviderService protocolProvider)

Removes all protocol supported operation sets.

Parameters:

protocolProvider - The protocol provider.

getProtocolProviders

public Iterator<ProtocolProviderService> getProtocolProviders()

Returns a set of all protocol providers.

Returns:

a set of all protocol providers.

getProtocolProviderForAccount

public ProtocolProviderService getProtocolProviderForAccount(String accountName)

Returns the protocol provider associated to the account given by the account user identifier.

Parameters:

accountName - The account user identifier.

Returns:

The protocol provider associated to the given account.

addProtocolProvider

public void addProtocolProvider(ProtocolProviderService protocolProvider)

Adds a protocol provider.

Parameters:

protocolProvider - The protocol provider to add.

hasProtocolProvider

public boolean hasProtocolProvider(ProtocolProviderService protocolProvider)

Checks whether we have already loaded the protocol provider.

Parameters:

protocolProvider - the provider to check.

Returns:

whether we have already loaded the specified provider.

removeProtocolProvider

public void removeProtocolProvider(ProtocolProviderService protocolProvider)

Adds an account to the application.

Parameters:

protocolProvider - The protocol provider of the account.

getProviderIndex

public int getProviderIndex(ProtocolProviderService protocolProvider)

Returns the index of the given protocol provider.

Parameters:

protocolProvider - the protocol provider to search for

Returns:

the index of the given protocol provider

addAccount

public void addAccount(ProtocolProviderService protocolProvider)

Adds an account to the application.

Parameters:

protocolProvider - The protocol provider of the account.

getAccountAddress

public String getAccountAddress(ProtocolProviderService protocolProvider)

Returns the account user id for the given protocol provider.

Parameters:

protocolProvider - the protocol provider corresponding to the account to add

Returns:

The account user id for the given protocol provider.

getAccountDisplayName

public String getAccountDisplayName(ProtocolProviderService protocolProvider)

Returns the account user display name for the given protocol provider.

Parameters:

protocolProvider - the protocol provider corresponding to the account to add

Returns:

The account user display name for the given protocol provider.

getProtocolPresenceOpSet

public static OperationSetPresence getProtocolPresenceOpSet(ProtocolProviderService protocolProvider)

Returns the presence operation set for the given protocol provider.

Parameters:

protocolProvider - The protocol provider for which the presence operation set is searched.

Returns:

the presence operation set for the given protocol provider.

getWebContactInfoOpSet

public OperationSetWebContactInfo getWebContactInfoOpSet(ProtocolProviderService protocolProvider)

Returns the Web Contact Info operation set for the given protocol provider.

Parameters:

protocolProvider - The protocol provider for which the TN is searched.

Returns:

OperationSetWebContactInfo The Web Contact Info operation set for the given protocol provider.

getTelephonyOpSet

public OperationSetBasicTelephony<?> getTelephonyOpSet(ProtocolProviderService protocolProvider)

Returns the telephony operation set for the given protocol provider.

Parameters:

protocolProvider - The protocol provider for which the telephony operation set is about.

Returns:

OperationSetBasicTelephony The telephony operation set for the given protocol provider.

getAdHocMultiUserChatOpSet

public OperationSetAdHocMultiUserChat getAdHocMultiUserChatOpSet(ProtocolProviderService protocolProvider)

Returns the multi user chat operation set for the given protocol provider.

Parameters:

protocolProvider - The protocol provider for which the multi user chat operation set is about.

Returns:

OperationSetAdHocMultiUserChat The telephony operation set for the given protocol provider.

getMultiUserChatOpSet

public OperationSetMultiUserChat getMultiUserChatOpSet(ProtocolProviderService protocolProvider)

Returns the multi user chat operation set for the given protocol provider.

Parameters:

protocolProvider - The protocol provider for which the multi user chat operation set is about.

Returns:

OperationSetMultiUserChat The telephony operation set for the given protocol provider.

getContactListPanel

public ContactListPane getContactListPanel()

Returns the panel containing the ContactList.

Returns:

ContactListPanel the panel containing the ContactList

getCurrentSearchText

public String getCurrentSearchText()

Returns the text currently shown in the search field.

Returns:

the text currently shown in the search field

clearCurrentSearchText

public void clearCurrentSearchText()

Clears the current text in the search field.

addSearchFieldListener

public void addSearchFieldListener(TextFieldChangeListener l)

Adds the given TextFieldChangeListener to listen for any changes that occur in the search field.

Parameters:

l - the TextFieldChangeListener to add

removeSearchFieldListener

public void removeSearchFieldListener(TextFieldChangeListener l)

Removes the given TextFieldChangeListener that listens for any changes that occur in the search field.

Parameters:

l - the TextFieldChangeListener to remove

getProtocolProviderLastStatus

public Object getProtocolProviderLastStatus(ProtocolProviderService protocolProvider)

If the protocol provider supports presence operation set searches the last status which was selected, otherwise returns null.

Parameters:

protocolProvider - the protocol provider we're interested in.

Returns:

the last protocol provider presence status, or null if this provider doesn't support presence operation set

close

protected void close(boolean isEscaped)

Overwrites the SIPCommFrame close method. This method is invoked when user presses the Escape key.

Overrides:

close in class SIPCommFrame

Parameters:

isEscaped - indicates if this window has been closed by pressing the escape key

getMainMenu

public MainMenu getMainMenu()

Returns the main menu in the application window.

Returns:

the main menu in the application window

addProviderContactHandler

public void addProviderContactHandler(ProtocolProviderService protocolProvider,
                                      ContactEventHandler contactHandler)

Adds the given contactHandler to handle contact events for the given protocolProvider.

Parameters:

protocolProvider - the ProtocolProviderService, which contacts should be handled by the given contactHandler

contactHandler - the ContactEventHandler that would handle events coming from the UI for any contacts belonging to the given provider

removeProviderContactHandler

public void removeProviderContactHandler(ProtocolProviderService protocolProvider)

Removes the ContactEventHandler corresponding to the given protocolProvider.

Parameters:

protocolProvider - the protocol provider, which contact handler we would like to remove

getContactHandler

public ContactEventHandler getContactHandler(ProtocolProviderService protocolProvider)

Returns the ContactEventHandler registered for this protocol provider.

Parameters:

protocolProvider - the ProtocolProviderService for which we are searching a ContactEventHandler.

Returns:

the ContactEventHandler registered for this protocol provider

pluginComponentAdded

public void pluginComponentAdded(PluginComponentEvent event)

Adds the associated with this PluginComponentEvent component to the appropriate container.

Specified by:

pluginComponentAdded in interface PluginComponentListener

Parameters:

event - the PluginComponentEvent that has notified us of the add of a plugin component

pluginComponentRemoved

public void pluginComponentRemoved(PluginComponentEvent event)

Removes the associated with this PluginComponentEvent component from this container.

Specified by:

pluginComponentRemoved in interface PluginComponentListener

Parameters:

event - the PluginComponentEvent that notified us of the remove of a plugin component

addNativePlugins

public void addNativePlugins()

Adds all native plugins to this container.

bringToFront

public void bringToFront()

Brings this window to front.

Specified by:

bringToFront in interface ExportedWindow

getIdentifier

public WindowID getIdentifier()

Returns the identifier of this window.

Specified by:

getIdentifier in interface ExportedWindow

Returns:

the identifier of this window

getSource

public Object getSource()

Returns this window.

Specified by:

getSource in interface ExportedWindow

Returns:

this window

maximize

public void maximize()

Maximizes this window.

Specified by:

maximize in interface ExportedWindow

minimize

public void minimize()

Minimizes this window.

Specified by:

minimize in interface ExportedWindow

isFrameVisible

public boolean isFrameVisible()

Implements isVisible in the UIService interface. Checks if the main application window is visible.

Returns:

true if main application window is visible, false otherwise

See Also:

UIService.isVisible()

setFrameVisible

public void setFrameVisible(boolean isVisible)

Implements setVisible in the UIService interface. Shows or hides the main application window depending on the parameter visible.

Parameters:

isVisible - true if we are to show the main application frame and false otherwise.

See Also:

UIService.setVisible(boolean)

getAccountStatusPanel

public AccountStatusPanel getAccountStatusPanel()

Returns the account status panel.

Returns:

the account status panel.

setParams

public void setParams(Object[] windowParams)

Implementation of ExportedWindow.setParams(Object[]).

Specified by:

setParams in interface ExportedWindow

Parameters:

windowParams - the parameters to pass.

windowClosed

protected void windowClosed(WindowEvent event)

Parameters:

event - Currently not used

windowClosing

protected void windowClosing(WindowEvent event)

Overrides SIPCommFrame#windowClosing(WindowEvent). Reflects the closed state of this MainFrame in the configuration in order to make it accessible to interested parties, displays the warning that the application will not quit.

Overrides:

windowClosing in class SIPCommFrame

Parameters:

event - the WindowEvent that notified us

ctrlEnterKeyTyped

public void ctrlEnterKeyTyped()

Called when the CTRL-ENTER or CMD-ENTER keys were typed when this window was the focused window. Performs the appropriate actions depending on the current state of the contact list.

loadSkin

public void loadSkin()

Reloads skin information

Specified by:

loadSkin in interface Skinnable