net.java.sip.communicator.impl.gui.customcontrols
Class MessageDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      net.java.sip.communicator.util.swing.SIPCommDialog
                          net.java.sip.communicator.impl.gui.customcontrols.MessageDialog

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Skinnable

Direct Known Subclasses:

ChatOperationReasonDialog

public class MessageDialog
extends SIPCommDialog
implements ActionListener, Skinnable

The MessageDialog is a JDialog that contains a question message, two buttons to confirm or cancel the question and a check box that allows user to choose to not be questioned any more over this subject.

The message and the name of the "OK" button could be configured.

Author:

Yana Stamcheva, Adam Netocny

See Also:

Serialized Form

Nested Class Summary

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

SIPCommDialog.DialogWindowAdapter

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

static int	CANCEL_RETURN_CODE Indicates that the Cancel button is pressed.
static int	OK_DONT_ASK_CODE Indicates that the OK button is pressed and the Don't ask check box is checked.
static int	OK_RETURN_CODE Indicates that the OK button is pressed.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

MessageDialog(Frame owner)
Creates an instance of MessageDialog by specifying the owner window.

MessageDialog(Frame owner, String title, String message)
Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

MessageDialog(Frame owner, String title, String message, boolean isCancelButtonEnabled)
Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

MessageDialog(Frame owner, String title, String message, String okButtonName)
Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

MessageDialog(Frame owner, String title, String message, String okButtonName, boolean isConfirmationEnabled)
Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

Method Summary

void	actionPerformed(ActionEvent e) Handles the ActionEvent.
protected void	close(boolean isEscaped) Visually clicks the cancel button on close.
void	loadSkin() Reloads icon.
void	setMessage(String message) Sets the message to be displayed.
int	showDialog() Shows the dialog.

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

addKeyBinding, dispose, setVisible

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

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, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, validate, 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, remove, 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

Field Detail

OK_RETURN_CODE

public static final int OK_RETURN_CODE

Indicates that the OK button is pressed.

See Also:

Constant Field Values

CANCEL_RETURN_CODE

public static final int CANCEL_RETURN_CODE

Indicates that the Cancel button is pressed.

See Also:

Constant Field Values

OK_DONT_ASK_CODE

public static final int OK_DONT_ASK_CODE

Indicates that the OK button is pressed and the Don't ask check box is checked.

See Also:

Constant Field Values

Constructor Detail

MessageDialog

public MessageDialog(Frame owner)

Creates an instance of MessageDialog by specifying the owner window.

Parameters:

owner - This dialog owner.

MessageDialog

public MessageDialog(Frame owner,
                     String title,
                     String message)

Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

Parameters:

owner - the dialog owner

title - the title of the message

message - the message to be displayed

MessageDialog

public MessageDialog(Frame owner,
                     String title,
                     String message,
                     String okButtonName)

Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

Parameters:

owner - the dialog owner

title - the title of the message

message - the message to be displayed

okButtonName - ok button name

MessageDialog

public MessageDialog(Frame owner,
                     String title,
                     String message,
                     String okButtonName,
                     boolean isConfirmationEnabled)

Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

Parameters:

owner - the dialog owner

title - the title of the message

message - the message to be displayed

okButtonName - ok button name

isConfirmationEnabled - indicates whether the "Do not ask again" button should be enabled or not

MessageDialog

public MessageDialog(Frame owner,
                     String title,
                     String message,
                     boolean isCancelButtonEnabled)

Creates an instance of MessageDialog by specifying the owner window and the message to be displayed.

Parameters:

owner - the dialog owner

title - the title of the message

message - the message to be displayed

isCancelButtonEnabled - true to show the Cancel button, false - otherwise

Method Detail

setMessage

public void setMessage(String message)

Sets the message to be displayed.

Parameters:

message - The message to be displayed.

showDialog

public int showDialog()

Shows the dialog.

Returns:

The return code that should indicate what was the choice of the user. If the user chooses cancel, the return code is the CANCEL_RETURN_CODE.

actionPerformed

public void actionPerformed(ActionEvent e)

Handles the ActionEvent. Depending on the user choice sets the return code to the appropriate value.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - the ActionEvent that notified us

close

protected void close(boolean isEscaped)

Visually clicks the cancel button on close.

Overrides:

close in class SIPCommDialog

Parameters:

isEscaped - indicates if the window was close by pressing the escape button

loadSkin

public void loadSkin()

Reloads icon.

Specified by:

loadSkin in interface Skinnable