public class ChatContainer extends SparkTabbedPane implements MessageListener, javax.swing.event.ChangeListener, java.awt.event.KeyListener
ChatRoom
objects within Spark.javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
DEFAULT_CURSOR, HAND_CURSOR
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
ChatContainer()
Creates the ChatContainer to hold all ChatRooms.
|
Modifier and Type | Method and Description |
---|---|
void |
activateChatRoom(ChatRoom room)
Activates the specified ChatRoom.
|
void |
activateComponent(java.awt.Component component)
Activates the component in tabbed pane.
|
void |
addChatRoom(ChatRoom room)
Adds a new ChatRoom to Spark.
|
void |
addChatRoomListener(ChatRoomListener listener)
Adds a ChatRoom listener to ChatRooms.
|
void |
addContainerComponent(ContainerComponent comp) |
void |
blinkFrameIfNecessary(javax.swing.JFrame frame) |
void |
closeActiveRoom() |
void |
closeAllChatRooms()
Close all chat rooms.
|
void |
closeAllGroupChatRooms() |
void |
closeTab(java.awt.Component component)
Closes a tab of a room.
|
protected void |
fireChatRoomActivated(ChatRoom room)
Notifies users that a
ChatRoom has been activated. |
protected void |
fireChatRoomClosed(ChatRoom room)
Notifies users that a
ChatRoom has been closed. |
protected void |
fireChatRoomLeft(ChatRoom room)
Notifies users that a
ChatRoom has been left. |
protected void |
fireChatRoomOpened(ChatRoom room)
Notifies users that a
ChatRoom has been opened. |
void |
fireChatRoomStateUpdated(ChatRoom room) |
void |
fireNotifyOnMessage(ChatRoom chatRoom,
boolean customMsg,
java.lang.String customMsgText,
java.lang.String customMsgTitle)
Used for Tray Notifications.
|
protected void |
fireUserHasJoined(ChatRoom room,
java.lang.String userid)
Notifies users that a user has joined a
ChatRoom . |
protected void |
fireUserHasLeft(ChatRoom room,
java.lang.String userid)
Notifies users that a user has left a
ChatRoom . |
void |
focusChat()
Brings the chat into focus.
|
ChatRoom |
getActiveChatRoom()
Returns the Active ChatRoom.
|
java.awt.Component |
getActiveRoom()
Returns the Active Component.
|
ChatFrame |
getChatFrame() |
ChatRoom |
getChatRoom(int location)
Returns a ChatRoom in the specified tab location.
|
ChatRoom |
getChatRoom(java.lang.String roomName)
Returns a ChatRoom by name.
|
java.util.Collection<ChatRoom> |
getChatRooms() |
java.util.Collection<ChatRoom> |
getStaleChatRooms()
Returns a Collection of stale chat rooms.
|
int |
getTotalNumberOfUnreadMessages()
Returns the total number of unread messages in Spark.
|
boolean |
hasGroupChatRooms() |
boolean |
hasRooms()
Returns true if there are any Rooms present.
|
void |
keyPressed(java.awt.event.KeyEvent keyEvent) |
void |
keyReleased(java.awt.event.KeyEvent keyEvent) |
void |
keyTyped(java.awt.event.KeyEvent keyEvent) |
void |
leaveChatRoom(ChatRoom room)
Leaves a ChatRoom.
|
void |
messageReceived(ChatRoom room,
org.jivesoftware.smack.packet.Message message)
Used for Tray Notifications.
|
void |
messageSent(ChatRoom room,
org.jivesoftware.smack.packet.Message message)
Invoked by the
ChatRoom when a new message has
been sent. |
void |
removeChatRoomListener(ChatRoomListener listener)
Removes the specified
ChatRoomListener . |
void |
setChatRoomTitle(ChatRoom room,
java.lang.String title) |
void |
startFlashing(java.awt.Component comp,
boolean customMsg,
java.lang.String customMsgText,
java.lang.String customMsgTitle)
Starts flashing of MainWindow.
|
void |
stateChanged(javax.swing.event.ChangeEvent e)
Notification that the tab pane has been modified.
|
void |
stopFlashing(java.awt.Component component)
Checks to see if the
ChatFrame should stop flashing. |
java.lang.String |
toString() |
addSparkTabbedPaneListener, addTab, addTab, allTabsClosed, buildTabbedPane, close, enableDragAndDrop, fireTabAdded, fireTabRemoved, fireTabSelected, getComponentAt, getComponentInTab, getDefaultFontAt, getMainPanel, getSelectedComponent, getSelectedIndex, getTabAt, getTabbedPane, getTabComponentAt, getTabComponentAt, getTabContainingComponent, getTabCount, getTabPosition, getTitleAt, indexOfComponent, removeComponent, removeSparkTabbedPaneListener, removeTabAt, setCloseButtonEnabled, setIconAt, setSelectedIndex, setTitleAt, setTitleBoldAt, setTitleColorAt, setTitleFontAt, updateActiveTab
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
public ChatContainer()
public void addChatRoom(ChatRoom room)
room
- the ChatRoom to add.public void addContainerComponent(ContainerComponent comp)
public void closeAllChatRooms()
public void leaveChatRoom(ChatRoom room)
room
- the room to leave.public ChatRoom getChatRoom(java.lang.String roomName) throws ChatRoomNotFoundException
roomName
- the name of the ChatRoom.ChatRoomNotFoundException
- if the room was not found.public ChatRoom getChatRoom(int location) throws ChatRoomNotFoundException
location
- the tab location.ChatRoomNotFoundException
- thrown if the room is not found.public ChatRoom getActiveChatRoom() throws ChatRoomNotFoundException
ChatRoomNotFoundException
- is thrown if no chat room is found.public java.awt.Component getActiveRoom()
public void activateChatRoom(ChatRoom room)
room
- the ChatRoom to activate.public void activateComponent(java.awt.Component component)
component
- the component contained within the tab to activate.public void messageReceived(ChatRoom room, org.jivesoftware.smack.packet.Message message)
messageReceived
in interface MessageListener
room
- the ChatRoom where the message was received.message
- the message received.ChatRoom
public void fireNotifyOnMessage(ChatRoom chatRoom, boolean customMsg, java.lang.String customMsgText, java.lang.String customMsgTitle)
chatRoom
- the ChatRoom where the message was received.customMsg
- customMsgText
- customMsgTitle
- public void messageSent(ChatRoom room, org.jivesoftware.smack.packet.Message message)
MessageListener
ChatRoom
when a new message has
been sent.messageSent
in interface MessageListener
room
- message
- ChatRoom
public void stateChanged(javax.swing.event.ChangeEvent e)
stateChanged
in interface javax.swing.event.ChangeListener
e
- the ChangeEvent.public void closeTab(java.awt.Component component)
component
- the component inside of the tab to close.public void closeActiveRoom()
public java.lang.String toString()
toString
in class java.awt.Component
public boolean hasRooms()
public void addChatRoomListener(ChatRoomListener listener)
listener
- the ChatRoomListener
to registerpublic void removeChatRoomListener(ChatRoomListener listener)
ChatRoomListener
.listener
- the ChatRoomListener
to removeprotected void fireChatRoomOpened(ChatRoom room)
ChatRoom
has been opened.room
- - the ChatRoom
that has been opened.protected void fireChatRoomLeft(ChatRoom room)
ChatRoom
has been left.room
- - the ChatRoom
that has been leftprotected void fireChatRoomClosed(ChatRoom room)
ChatRoom
has been closed.room
- - the ChatRoom
that has been closed.protected void fireChatRoomActivated(ChatRoom room)
ChatRoom
has been activated.room
- - the ChatRoom
that has been activated.protected void fireUserHasJoined(ChatRoom room, java.lang.String userid)
ChatRoom
.room
- - the ChatRoom
that a user has joined.userid
- - the userid of the person.protected void fireUserHasLeft(ChatRoom room, java.lang.String userid)
ChatRoom
.room
- - the ChatRoom
that a user has left.userid
- - the userid of the person.public void startFlashing(java.awt.Component comp, boolean customMsg, java.lang.String customMsgText, java.lang.String customMsgTitle)
comp
- the Component to check if a message has been inserted
but the room is not the selected room.public void fireChatRoomStateUpdated(ChatRoom room)
public void stopFlashing(java.awt.Component component)
ChatFrame
should stop flashing.component
- the component that should be notified.public void setChatRoomTitle(ChatRoom room, java.lang.String title)
public void focusChat()
public java.util.Collection<ChatRoom> getChatRooms()
public ChatFrame getChatFrame()
public void blinkFrameIfNecessary(javax.swing.JFrame frame)
public java.util.Collection<ChatRoom> getStaleChatRooms()
public void keyTyped(java.awt.event.KeyEvent keyEvent)
keyTyped
in interface java.awt.event.KeyListener
public void keyPressed(java.awt.event.KeyEvent keyEvent)
keyPressed
in interface java.awt.event.KeyListener
public void keyReleased(java.awt.event.KeyEvent keyEvent)
keyReleased
in interface java.awt.event.KeyListener
public int getTotalNumberOfUnreadMessages()
public void closeAllGroupChatRooms()
public boolean hasGroupChatRooms()