com.alee.laf.window

Class WebDialog<T extends WebDialog<T>>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.alee.laf.window.WebDialog<T>

Type Parameters:

T - dialog type

All Implemented Interfaces:

WindowEventMethods, WindowMethods<T>, LanguageEventMethods, LanguageMethods, SettingsMethods, Styleable, MethodExtension, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

WebColorChooserDialog, WebDirectoryChooser, WebExtendedOptionPane, WebFadeDialog, WebPopOver, WebProgressDialog, WebToolBarUI.ToolBarDialog

public class WebDialog<T extends WebDialog<T>>
extends JDialog
implements Styleable, WindowEventMethods, LanguageMethods, LanguageEventMethods, SettingsMethods, WindowMethods<T>

JDialog extension class. It contains various useful methods to simplify core component usage. This component should never be used with a non-Web UIs as it might cause an unexpected behavior. You could still use that component even if WebLaF is not your application LaF as this component will use Web-UI in any case.

Author:

Mikle Garin

See Also:

JDialog, WebRootPaneUI, RootPanePainter, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebDialog.WebDialogRootPane Custom root pane for this WebDialog.

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, Window.Type

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

Modifier and Type	Field and Description
protected boolean	closeOnFocusLoss Whether should close dialog on focus loss or not.
protected DefaultFocusTracker	focusTracker Window focus tracker.

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

Constructors

Constructor and Description
WebDialog() Creates a modeless dialog without a title and without a specified Frame owner.
WebDialog(Component owner) Creates a dialog with the specified Component parent Window as owner.
WebDialog(Component owner, String title) Creates a dialog with the specified Component parent Window as owner.
WebDialog(Dialog owner) Creates a modeless dialog without a title with the specified Dialog as its owner.
WebDialog(Dialog owner, boolean modal) Creates a dialog with the specified Dialog as its owner.
WebDialog(Dialog owner, String title) Creates a dialog with the specified Dialog as its owner.
WebDialog(Dialog owner, String title, boolean modal) Creates a dialog with the specified Dialog as its owner.
WebDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified Dialog as its owner.
WebDialog(Frame owner) Creates a dialog with the specified owner Frame.
WebDialog(Frame owner, boolean modal) Creates a dialog with the specified owner Frame.
WebDialog(Frame owner, String title) Creates a dialog with the specified owner Frame.
WebDialog(Frame owner, String title, boolean modal) Creates a dialog with the specified owner Frame.
WebDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id) Creates a modeless dialog without a title and without a specified Frame owner.
WebDialog(StyleId id, Component owner) Creates a dialog with the specified Component parent Window as owner.
WebDialog(StyleId id, Component owner, String title) Creates a dialog with the specified Component parent Window as owner.
WebDialog(StyleId id, Dialog owner) Creates a modeless dialog without a title with the specified Dialog as its owner.
WebDialog(StyleId id, Dialog owner, boolean modal) Creates a dialog with the specified Dialog as its owner.
WebDialog(StyleId id, Dialog owner, String title) Creates a dialog with the specified Dialog as its owner.
WebDialog(StyleId id, Dialog owner, String title, boolean modal) Creates a dialog with the specified Dialog as its owner.
WebDialog(StyleId id, Dialog owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified Dialog as its owner.
WebDialog(StyleId id, Frame owner) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id, Frame owner, boolean modal) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id, Frame owner, String title) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id, Frame owner, String title, boolean modal) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id, Frame owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified owner Frame.
WebDialog(StyleId id, Window owner) Creates a modeless dialog with the specified owner Window.
WebDialog(StyleId id, Window owner, Dialog.ModalityType modalityType) Creates a dialog with the specified owner Window.
WebDialog(StyleId id, Window owner, String title) Creates a modeless dialog with the specified owner Window.
WebDialog(StyleId id, Window owner, String title, Dialog.ModalityType modalityType) Creates a dialog with the specified owner Window.
WebDialog(StyleId id, Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc) Creates a dialog with the specified owner Window.
WebDialog(Window owner) Creates a modeless dialog with the specified owner Window.
WebDialog(Window owner, Dialog.ModalityType modalityType) Creates a dialog with the specified owner Window.
WebDialog(Window owner, String title) Creates a modeless dialog with the specified owner Window.
WebDialog(Window owner, String title, Dialog.ModalityType modalityType) Creates a dialog with the specified owner Window.
WebDialog(Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc) Creates a dialog with the specified owner Window.

Method Summary

Modifier and Type	Method and Description
void	addDictionaryListener(DictionaryListener listener) Adds new DictionaryListener tied to the JComponent implementing this interface.
void	addFocusableChild(Component child) Adds focusable child that won't force dialog to close even if it set to close on focus loss.
void	addLanguageListener(LanguageListener listener) Adds new LanguageListener tied to the JComponent implementing this interface.
void	addStyleListener(StyleListener listener) Adds StyleListener.
T	center() Centers window relative to screen center.
T	center(Component relativeTo) Centers window relative to the specified component center.
T	center(Component relativeTo, int width, int height) Changes window size and centers it relative to the specified component center.
T	center(int width, int height) Changes window size and centers it relative to screen center.
protected JRootPane	createRootPane()
protected void	dialogInit()
JComponent	getButtonsPanel() Returns window buttons panel.
Painter	getCustomPainter() Returns custom Painter used for implementing JComponent.
StyleId	getDefaultStyleId() Returns default component StyleId.
List<Component>	getFocusableChildren() Returns focusable children that don't force dialog to close even if it set to close on focus loss.
String	getLanguage() Returns language key which was used to register specified component in LanguageManager.
Insets	getMargin() Returns current margin.
Insets	getPadding() Returns current padding.
Shape	getPainterShape() Returns component's Painter Shape.
Skin	getSkin() Returns skin currently applied to this component.
StyleId	getStyleId() Returns component StyleId.
JComponent	getTitleComponent() Returns window title component.
WRootPaneUI	getUI() Returns the look and feel (LaF) object that renders this component.
float	getWindowOpacity() Returns window opacity.
protected void	initialize(Window owner, StyleId id, String title) Additional initialization of WebDialog settings.
boolean	isCloseOnFocusLoss() Returns whether should close dialog on focus loss or not.
boolean	isDisplayCloseButton() Returns whether or not window close button should be displayed.
boolean	isDisplayMaximizeButton() Returns whether or not window maximize button should be displayed.
boolean	isDisplayMenuBar() Returns whether or not menu bar should be displayed.
boolean	isDisplayMinimizeButton() Returns whether or not window minimize button should be displayed.
boolean	isDisplayTitleComponent() Returns whether or not window title component should be displayed.
boolean	isDisplayWindowButtons() Returns whether or not window buttons should be displayed.
boolean	isLanguageSet() Returns whether this component registered in LanguageManager or not.
boolean	isShapeDetectionEnabled() Returns whether or not component's custom Shape is used for better mouse events detection.
boolean	isWindowOpaque() Returns whether window is opaque or not.
void	loadSettings() Loads previously saved settings for the specified JComponent if it is registered.
WindowCloseAdapter	onClose(ComponentEventRunnable runnable) Shortcut method for window close event.
WindowAdapter	onClosing(WindowEventRunnable runnable) Shortcut method for window closing event.
T	packToHeight(int height) Packs window to its preffered width and specified height.
T	packToWidth(int width) Packs window to its preffered height and specified width.
void	registerSettings(Configuration configuration) Registers JComponent for settings auto-save.
void	registerSettings(SettingsProcessor processor) Registers JComponent for settings auto-save.
void	removeDictionaryListener(DictionaryListener listener) Removes DictionaryListener tied to the JComponent implementing this interface.
void	removeDictionaryListeners() Removes all DictionaryListeners tied to the JComponent implementing this interface.
void	removeFocusableChild(Component child) Removes focusable child that doesn't force dialog to close even if it set to close on focus loss.
void	removeLanguage() Unregisters component from LanguageManager.
void	removeLanguageListener(LanguageListener listener) Removes LanguageListener tied to the JComponent implementing this interface.
void	removeLanguageListeners() Removes all LanguageListeners tied to the JComponent implementing this interface.
void	removeLanguageUpdater() Unregisters custom component LanguageUpdater.
void	removeStyleListener(StyleListener listener) Removes StyleListener.
boolean	resetCustomPainter() Resets custom Painter for implementing JComponent to default one.
Skin	resetSkin() Resets skin for this component and all of its children linked via StyleId.
StyleId	resetStyleId() Resets StyleId to default value.
void	saveSettings() Saves settings for the specified JComponent if it is registered.
void	setCloseOnFocusLoss(boolean closeOnFocusLoss) Sets whether should close dialog on focus loss or not.
Painter	setCustomPainter(Painter painter) Sets custom Painter for implementing JComponent.
void	setDisplayCloseButton(boolean display) Sets whether or not window close button should be displayed.
void	setDisplayMaximizeButton(boolean display) Sets whether or not window maximize button should be displayed.
void	setDisplayMenuBar(boolean display) Sets whether or not menu bar should be displayed.
void	setDisplayMinimizeButton(boolean display) Sets whether or not window minimize button should be displayed.
void	setDisplayTitleComponent(boolean display) Sets whether or not window title component should be displayed.
void	setDisplayWindowButtons(boolean display) Sets whether or not window buttons should be displayed.
void	setLanguage(String key, Object... data) Registers component in LanguageManager under specified key and with specified formatting data.
void	setLanguageUpdater(LanguageUpdater updater) Registers custom language updater for this component.
void	setMargin(Insets margin) Sets new margin.
void	setMargin(int margin) Sets new margin.
void	setMargin(int top, int left, int bottom, int right) Sets new margin.
void	setPadding(Insets padding) Sets new padding.
void	setPadding(int padding) Sets new padding.
void	setPadding(int top, int left, int bottom, int right) Sets new padding.
void	setShapeDetectionEnabled(boolean enabled) Sets whether or not component's custom Shape should be used for better mouse events detection.
Skin	setSkin(Skin skin) Applies specified custom skin to the styleable component and all of its children linked via StyleId.
Skin	setSkin(Skin skin, boolean recursively) Applies specified custom skin to the styleable component and all of its children linked via StyleId.
StyleId	setStyleId(StyleId id) Sets new component StyleId.
void	setTitleComponent(JComponent title) Sets window title component.
void	setUI(WRootPaneUI ui) Sets the LaF object that renders this component.
T	setWindowOpacity(float opacity) Sets window opacity if that option is supported by the underlying system.
T	setWindowOpaque(boolean opaque) Sets window opaque if that option is supported by the underlying system.
void	unregisterSettings() Unregisters JComponent from settings auto-save.
void	updateLanguage(Object... data) Updates component language and formatting data.
void	updateLanguage(String key, Object... data) Changes component language key and updates its language and formatting data.

Methods inherited from class javax.swing.JDialog

addImpl, 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, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

closeOnFocusLoss

protected boolean closeOnFocusLoss

Whether should close dialog on focus loss or not.

focusTracker

protected transient DefaultFocusTracker focusTracker

Window focus tracker.

Constructor Detail

WebDialog

public WebDialog(Component owner)

Creates a dialog with the specified Component parent Window as owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Component to use parent Window of as owner

WebDialog

public WebDialog(Component owner,
                 String title)

Creates a dialog with the specified Component parent Window as owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Component to use parent Window of as owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog()

Creates a modeless dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

WebDialog

public WebDialog(Frame owner)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Frame from which the dialog is displayed

WebDialog

public WebDialog(Frame owner,
                 boolean modal)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Frame from which the dialog is displayed

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(Frame owner,
                 String title)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

WebDialog

public WebDialog(Frame owner,
                 String title,
                 boolean modal)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(Frame owner,
                 String title,
                 boolean modal,
                 GraphicsConfiguration gc)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

WebDialog

public WebDialog(Dialog owner)

Creates a modeless dialog without a title with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

WebDialog

public WebDialog(Dialog owner,
                 boolean modal)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(Dialog owner,
                 String title)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog(Dialog owner,
                 String title,
                 boolean modal)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(Dialog owner,
                 String title,
                 boolean modal,
                 GraphicsConfiguration gc)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

WebDialog

public WebDialog(Window owner)

Creates a modeless dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

WebDialog

public WebDialog(Window owner,
                 Dialog.ModalityType modalityType)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

WebDialog

public WebDialog(Window owner,
                 String title)

Creates a modeless dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog(Window owner,
                 String title,
                 Dialog.ModalityType modalityType)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

WebDialog

public WebDialog(Window owner,
                 String title,
                 Dialog.ModalityType modalityType,
                 GraphicsConfiguration gc)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

WebDialog

public WebDialog(StyleId id,
                 Component owner)

Creates a dialog with the specified Component parent Window as owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Component to use parent Window of as owner

WebDialog

public WebDialog(StyleId id,
                 Component owner,
                 String title)

Creates a dialog with the specified Component parent Window as owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Component to use parent Window of as owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog(StyleId id)

Creates a modeless dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

WebDialog

public WebDialog(StyleId id,
                 Frame owner)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Frame from which the dialog is displayed

WebDialog

public WebDialog(StyleId id,
                 Frame owner,
                 boolean modal)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Frame from which the dialog is displayed

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(StyleId id,
                 Frame owner,
                 String title)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

WebDialog

public WebDialog(StyleId id,
                 Frame owner,
                 String title,
                 boolean modal)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(StyleId id,
                 Frame owner,
                 String title,
                 boolean modal,
                 GraphicsConfiguration gc)

Creates a dialog with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Frame from which the dialog is displayed

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

WebDialog

public WebDialog(StyleId id,
                 Dialog owner)

Creates a modeless dialog without a title with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

WebDialog

public WebDialog(StyleId id,
                 Dialog owner,
                 boolean modal)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(StyleId id,
                 Dialog owner,
                 String title)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog(StyleId id,
                 Dialog owner,
                 String title,
                 boolean modal)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

WebDialog

public WebDialog(StyleId id,
                 Dialog owner,
                 String title,
                 boolean modal,
                 GraphicsConfiguration gc)

Creates a dialog with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - owner Dialog from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

WebDialog

public WebDialog(StyleId id,
                 Window owner)

Creates a modeless dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Window from which the dialog is displayed or null if this dialog has no owner

WebDialog

public WebDialog(StyleId id,
                 Window owner,
                 Dialog.ModalityType modalityType)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Window from which the dialog is displayed or null if this dialog has no owner

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

WebDialog

public WebDialog(StyleId id,
                 Window owner,
                 String title)

Creates a modeless dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

WebDialog

public WebDialog(StyleId id,
                 Window owner,
                 String title,
                 Dialog.ModalityType modalityType)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

WebDialog

public WebDialog(StyleId id,
                 Window owner,
                 String title,
                 Dialog.ModalityType modalityType,
                 GraphicsConfiguration gc)

Creates a dialog with the specified owner Window.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - StyleId

owner - Window from which the dialog is displayed or null if this dialog has no owner

title - String to display in the dialog's title bar

modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

gc - GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used

Method Detail

dialogInit

protected void dialogInit()

Overrides:

dialogInit in class JDialog

initialize

protected void initialize(Window owner,
                          StyleId id,
                          String title)

Additional initialization of WebDialog settings.

Parameters:

owner - Window from which the dialog is displayed or null if this dialog has no owner

id - initial StyleId

title - dialog title

createRootPane

protected JRootPane createRootPane()

Overrides:

createRootPane in class JDialog

isCloseOnFocusLoss

public boolean isCloseOnFocusLoss()

Returns whether should close dialog on focus loss or not.

Returns:

true if should close dialog on focus loss, false otherwise

setCloseOnFocusLoss

public void setCloseOnFocusLoss(boolean closeOnFocusLoss)

Sets whether should close dialog on focus loss or not.

Parameters:

closeOnFocusLoss - whether should close dialog on focus loss or not

getFocusableChildren

public List<Component> getFocusableChildren()

Returns focusable children that don't force dialog to close even if it set to close on focus loss.

Returns:

focusable children that don't force dialog to close even if it set to close on focus loss

addFocusableChild

public void addFocusableChild(Component child)

Adds focusable child that won't force dialog to close even if it set to close on focus loss.

Parameters:

child - focusable child that won't force dialog to close even if it set to close on focus loss

removeFocusableChild

public void removeFocusableChild(Component child)

Removes focusable child that doesn't force dialog to close even if it set to close on focus loss.

Parameters:

child - focusable child that doesn't force dialog to close even if it set to close on focus loss

isDisplayTitleComponent

public boolean isDisplayTitleComponent()

Returns whether or not window title component should be displayed.

Returns:

true if window title component should be displayed, false otherwise

setDisplayTitleComponent

public void setDisplayTitleComponent(boolean display)

Sets whether or not window title component should be displayed.

Parameters:

display - whether or not window title component should be displayed

getTitleComponent

public JComponent getTitleComponent()

Returns window title component.

Returns:

window title component

setTitleComponent

public void setTitleComponent(JComponent title)

Sets window title component.

Parameters:

title - new window title component

isDisplayWindowButtons

public boolean isDisplayWindowButtons()

Returns whether or not window buttons should be displayed.

Returns:

true if window buttons should be displayed, false otherwise

setDisplayWindowButtons

public void setDisplayWindowButtons(boolean display)

Sets whether or not window buttons should be displayed.

Parameters:

display - whether or not window buttons should be displayed

isDisplayMinimizeButton

public boolean isDisplayMinimizeButton()

Returns whether or not window minimize button should be displayed.

Returns:

true if window minimize button should be displayed, false otherwise

setDisplayMinimizeButton

public void setDisplayMinimizeButton(boolean display)

Sets whether or not window minimize button should be displayed.

Parameters:

display - whether or not window minimize button should be displayed

isDisplayMaximizeButton

public boolean isDisplayMaximizeButton()

Returns whether or not window maximize button should be displayed.

Returns:

true if window maximize button should be displayed, false otherwise

setDisplayMaximizeButton

public void setDisplayMaximizeButton(boolean display)

Sets whether or not window maximize button should be displayed.

Parameters:

display - whether or not window maximize button should be displayed

isDisplayCloseButton

public boolean isDisplayCloseButton()

Returns whether or not window close button should be displayed.

Returns:

true if window close button should be displayed, false otherwise

setDisplayCloseButton

public void setDisplayCloseButton(boolean display)

Sets whether or not window close button should be displayed.

Parameters:

display - whether or not window close button should be displayed

getButtonsPanel

public JComponent getButtonsPanel()

Returns window buttons panel.

Returns:

window buttons panel

isDisplayMenuBar

public boolean isDisplayMenuBar()

Returns whether or not menu bar should be displayed.

Returns:

true if menu bar should be displayed, false otherwise

setDisplayMenuBar

public void setDisplayMenuBar(boolean display)

Sets whether or not menu bar should be displayed.

Parameters:

display - whether or not menu bar should be displayed

getDefaultStyleId

@NotNull
public StyleId getDefaultStyleId()

Description copied from interface: Styleable

Returns default component StyleId. This method is asked when initial component StyleId have to be provided.

Specified by:

getDefaultStyleId in interface Styleable

Returns:

default component StyleId

getStyleId

@NotNull
public StyleId getStyleId()

Description copied from interface: Styleable

Returns component StyleId.

Specified by:

getStyleId in interface Styleable

Returns:

component StyleId

setStyleId

@NotNull
public StyleId setStyleId(@NotNull
                                   StyleId id)

Description copied from interface: Styleable

Sets new component StyleId. If style for the specified ID cannot be found in skin then its default style will be used instead.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component StyleId

Returns:

previously used StyleId

resetStyleId

@NotNull
public StyleId resetStyleId()

Description copied from interface: Styleable

Resets StyleId to default value.

Specified by:

resetStyleId in interface Styleable

Returns:

previously used StyleId

getSkin

@NotNull
public Skin getSkin()

Description copied from interface: Styleable

Returns skin currently applied to this component.

Specified by:

getSkin in interface Styleable

Returns:

skin currently applied to this component

setSkin

@Nullable
public Skin setSkin(@NotNull
                              Skin skin)

Description copied from interface: Styleable

Applies specified custom skin to the styleable component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Styleable

Parameters:

skin - skin to be applied

Returns:

previously applied skin

setSkin

@Nullable
public Skin setSkin(@NotNull
                              Skin skin,
                              boolean recursively)

Description copied from interface: Styleable

Applies specified custom skin to the styleable component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Styleable

Parameters:

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

resetSkin

@Nullable
public Skin resetSkin()

Description copied from interface: Styleable

Resets skin for this component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Resetting component skin will also include it back into the skin update cycle in case global skin will be changed.

Specified by:

resetSkin in interface Styleable

Returns:

skin applied to this component after reset

addStyleListener

public void addStyleListener(@NotNull
                             StyleListener listener)

Description copied from interface: Styleable

Adds StyleListener.

Specified by:

addStyleListener in interface Styleable

Parameters:

listener - StyleListener to add

removeStyleListener

public void removeStyleListener(@NotNull
                                StyleListener listener)

Description copied from interface: Styleable

Removes StyleListener.

Specified by:

removeStyleListener in interface Styleable

Parameters:

listener - StyleListener to remove

getCustomPainter

@Nullable
public Painter getCustomPainter()

Description copied from interface: Styleable

Returns custom Painter used for implementing JComponent.

Specified by:

getCustomPainter in interface Styleable

Returns:

custom Painter used for implementing JComponent

setCustomPainter

@Nullable
public Painter setCustomPainter(@NotNull
                                          Painter painter)

Description copied from interface: Styleable

Sets custom Painter for implementing JComponent.

Specified by:

setCustomPainter in interface Styleable

Parameters:

painter - custom Painter

Returns:

custom Painter previously used for implementing JComponent

resetCustomPainter

public boolean resetCustomPainter()

Description copied from interface: Styleable

Resets custom Painter for implementing JComponent to default one.

Specified by:

resetCustomPainter in interface Styleable

Returns:

true if custom Painter was successfully resetted, false otherwise

getPainterShape

@NotNull
public Shape getPainterShape()

Description copied from interface: Styleable

Returns component's Painter Shape. This method is not named getShape () to avoid clashing with JDK7+ method in Window ancestors.

Specified by:

getPainterShape in interface Styleable

Returns:

component's Painter Shape

isShapeDetectionEnabled

public boolean isShapeDetectionEnabled()

Description copied from interface: Styleable

Returns whether or not component's custom Shape is used for better mouse events detection. If it wasn't explicitly specified - WebLookAndFeel.isShapeDetectionEnabled() is used as result.

Specified by:

isShapeDetectionEnabled in interface Styleable

Returns:

true if component's custom Shape is used for better mouse events detection, false otherwise

setShapeDetectionEnabled

public void setShapeDetectionEnabled(boolean enabled)

Description copied from interface: Styleable

Sets whether or not component's custom Shape should be used for better mouse events detection. It can be enabled globally through WebLookAndFeel.setShapeDetectionEnabled(boolean).

Specified by:

setShapeDetectionEnabled in interface Styleable

Parameters:

enabled - whether or not component's custom Shape should be used for better mouse events detection

getMargin

@Nullable
public Insets getMargin()

Description copied from interface: Styleable

Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.

Specified by:

getMargin in interface Styleable

Returns:

current margin

setMargin

public void setMargin(int margin)

Description copied from interface: Styleable

Sets new margin.

Specified by:

setMargin in interface Styleable

Parameters:

margin - new margin

setMargin

public void setMargin(int top,
                      int left,
                      int bottom,
                      int right)

Description copied from interface: Styleable

Sets new margin.

Specified by:

setMargin in interface Styleable

Parameters:

top - new top margin

left - new left margin

bottom - new bottom margin

right - new right margin

setMargin

public void setMargin(@Nullable
                      Insets margin)

Description copied from interface: Styleable

Sets new margin. null can be provided to set an empty [0,0,0,0] margin.

Specified by:

setMargin in interface Styleable

Parameters:

margin - new margin

getPadding

@Nullable
public Insets getPadding()

Description copied from interface: Styleable

Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.

Specified by:

getPadding in interface Styleable

Returns:

current padding

setPadding

public void setPadding(int padding)

Description copied from interface: Styleable

Sets new padding.

Specified by:

setPadding in interface Styleable

Parameters:

padding - new padding

setPadding

public void setPadding(int top,
                       int left,
                       int bottom,
                       int right)

Description copied from interface: Styleable

Sets new padding.

Specified by:

setPadding in interface Styleable

Parameters:

top - new top padding

left - new left padding

bottom - new bottom padding

right - new right padding

setPadding

public void setPadding(@Nullable
                       Insets padding)

Description copied from interface: Styleable

Sets new padding. null can be provided to set an empty [0,0,0,0] padding.

Specified by:

setPadding in interface Styleable

Parameters:

padding - new padding

getUI

public WRootPaneUI getUI()

Returns the look and feel (LaF) object that renders this component.

Returns:

the WRootPaneUI object that renders this component

setUI

public void setUI(WRootPaneUI ui)

Sets the LaF object that renders this component.

Parameters:

ui - WRootPaneUI

onClosing

public WindowAdapter onClosing(WindowEventRunnable runnable)

Description copied from interface: WindowEventMethods

Shortcut method for window closing event.

Specified by:

onClosing in interface WindowEventMethods

Parameters:

runnable - window event runnable

Returns:

used window adapter

onClose

public WindowCloseAdapter onClose(ComponentEventRunnable runnable)

Description copied from interface: WindowEventMethods

Shortcut method for window close event.

Specified by:

onClose in interface WindowEventMethods

Parameters:

runnable - component event runnable

Returns:

used window close adapter

getLanguage

@Nullable
public String getLanguage()

Description copied from interface: LanguageMethods

Returns language key which was used to register specified component in LanguageManager.

Specified by:

getLanguage in interface LanguageMethods

Returns:

language key which was used to register specified component in LanguageManager

setLanguage

public void setLanguage(@NotNull
                        String key,
                        @Nullable
                        Object... data)

Description copied from interface: LanguageMethods

Registers component in LanguageManager under specified key and with specified formatting data.

Specified by:

setLanguage in interface LanguageMethods

Parameters:

key - language record key

data - formatting data

updateLanguage

public void updateLanguage(@Nullable
                           Object... data)

Description copied from interface: LanguageMethods

Updates component language and formatting data.

Specified by:

updateLanguage in interface LanguageMethods

Parameters:

data - new formatting data

updateLanguage

public void updateLanguage(@NotNull
                           String key,
                           @Nullable
                           Object... data)

Description copied from interface: LanguageMethods

Changes component language key and updates its language and formatting data.

Specified by:

updateLanguage in interface LanguageMethods

Parameters:

key - new language key

data - new formatting data

removeLanguage

public void removeLanguage()

Description copied from interface: LanguageMethods

Unregisters component from LanguageManager. This method will not change current component settings that came from latest applied translation.

Specified by:

removeLanguage in interface LanguageMethods

isLanguageSet

public boolean isLanguageSet()

Description copied from interface: LanguageMethods

Returns whether this component registered in LanguageManager or not.

Specified by:

isLanguageSet in interface LanguageMethods

Returns:

true if component is registered in LanguageManager, false otherwise

setLanguageUpdater

public void setLanguageUpdater(@NotNull
                               LanguageUpdater updater)

Description copied from interface: LanguageMethods

Registers custom language updater for this component.

Specified by:

setLanguageUpdater in interface LanguageMethods

Parameters:

updater - LanguageUpdater for the component

removeLanguageUpdater

public void removeLanguageUpdater()

Description copied from interface: LanguageMethods

Unregisters custom component LanguageUpdater.

Specified by:

removeLanguageUpdater in interface LanguageMethods

addLanguageListener

public void addLanguageListener(@NotNull
                                LanguageListener listener)

Description copied from interface: LanguageEventMethods

Adds new LanguageListener tied to the JComponent implementing this interface. Unlike LanguageManager.addLanguageListener(LanguageListener) using this method will not store hard references to the LanguageListener outside of the JComponent to avoid any mermory leaks. So if specified JComponent will for instance be destroyed provided LanguageListener will also be destroyed.

Specified by:

addLanguageListener in interface LanguageEventMethods

Parameters:

listener - LanguageListener to add

removeLanguageListener

public void removeLanguageListener(@NotNull
                                   LanguageListener listener)

Description copied from interface: LanguageEventMethods

Removes LanguageListener tied to the JComponent implementing this interface.

Specified by:

removeLanguageListener in interface LanguageEventMethods

Parameters:

listener - LanguageListener to remove

removeLanguageListeners

public void removeLanguageListeners()

Description copied from interface: LanguageEventMethods

Removes all LanguageListeners tied to the JComponent implementing this interface.

Specified by:

removeLanguageListeners in interface LanguageEventMethods

addDictionaryListener

public void addDictionaryListener(@NotNull
                                  DictionaryListener listener)

Description copied from interface: LanguageEventMethods

Adds new DictionaryListener tied to the JComponent implementing this interface. Unlike LanguageManager.addDictionaryListener(DictionaryListener) using this method will not store hard references to the DictionaryListener outside of the JComponent to avoid any mermory leaks. So if specified JComponent will for instance be destroyed provided DictionaryListener will also be destroyed.

Specified by:

addDictionaryListener in interface LanguageEventMethods

Parameters:

listener - DictionaryListener to add

removeDictionaryListener

public void removeDictionaryListener(@NotNull
                                     DictionaryListener listener)

Description copied from interface: LanguageEventMethods

Removes DictionaryListener tied to the JComponent implementing this interface.

Specified by:

removeDictionaryListener in interface LanguageEventMethods

Parameters:

listener - DictionaryListener to remove

removeDictionaryListeners

public void removeDictionaryListeners()

Description copied from interface: LanguageEventMethods

Removes all DictionaryListeners tied to the JComponent implementing this interface.

Specified by:

removeDictionaryListeners in interface LanguageEventMethods

registerSettings

public void registerSettings(Configuration configuration)

Description copied from interface: SettingsMethods

Registers JComponent for settings auto-save. Registered JComponent will be: - tracked for settings changes (depends on SettingsProcessor) to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

configuration - Configuration

registerSettings

public void registerSettings(SettingsProcessor processor)

Description copied from interface: SettingsMethods

Registers JComponent for settings auto-save. Registered JComponent will be: - tracked for settings changes (depends on SettingsProcessor) to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

processor - SettingsProcessor

unregisterSettings

public void unregisterSettings()

Description copied from interface: SettingsMethods

Unregisters JComponent from settings auto-save.

Specified by:

unregisterSettings in interface SettingsMethods

loadSettings

public void loadSettings()

Description copied from interface: SettingsMethods

Loads previously saved settings for the specified JComponent if it is registered.

Specified by:

loadSettings in interface SettingsMethods

saveSettings

public void saveSettings()

Description copied from interface: SettingsMethods

Saves settings for the specified JComponent if it is registered.

Specified by:

saveSettings in interface SettingsMethods

isWindowOpaque

public boolean isWindowOpaque()

Description copied from interface: WindowMethods

Returns whether window is opaque or not.

Specified by:

isWindowOpaque in interface WindowMethods<T extends WebDialog<T>>

Returns:

true if window is opaque, false otherwise

setWindowOpaque

public T setWindowOpaque(boolean opaque)

Description copied from interface: WindowMethods

Sets window opaque if that option is supported by the underlying system.

Specified by:

setWindowOpaque in interface WindowMethods<T extends WebDialog<T>>

Parameters:

opaque - whether should make window opaque or not

Returns:

processed window

getWindowOpacity

public float getWindowOpacity()

Description copied from interface: WindowMethods

Returns window opacity.

Specified by:

getWindowOpacity in interface WindowMethods<T extends WebDialog<T>>

Returns:

window opacity

setWindowOpacity

public T setWindowOpacity(float opacity)

Description copied from interface: WindowMethods

Sets window opacity if that option is supported by the underlying system.

Specified by:

setWindowOpacity in interface WindowMethods<T extends WebDialog<T>>

Parameters:

opacity - new window opacity

Returns:

processed window

center

public T center()

Description copied from interface: WindowMethods

Centers window relative to screen center.

Specified by:

center in interface WindowMethods<T extends WebDialog<T>>

Returns:

processed window

center

public T center(Component relativeTo)

Description copied from interface: WindowMethods

Centers window relative to the specified component center.

Specified by:

center in interface WindowMethods<T extends WebDialog<T>>

Parameters:

relativeTo - component used to center window

Returns:

processed window

center

public T center(int width,
                int height)

Description copied from interface: WindowMethods

Changes window size and centers it relative to screen center.

Specified by:

center in interface WindowMethods<T extends WebDialog<T>>

Parameters:

width - new window width

height - new window height

Returns:

processed window

center

public T center(Component relativeTo,
                int width,
                int height)

Description copied from interface: WindowMethods

Changes window size and centers it relative to the specified component center.

Specified by:

center in interface WindowMethods<T extends WebDialog<T>>

Parameters:

relativeTo - component used to center window

width - new window width

height - new window height

Returns:

processed window

packToWidth

public T packToWidth(int width)

Description copied from interface: WindowMethods

Packs window to its preffered height and specified width.

Specified by:

packToWidth in interface WindowMethods<T extends WebDialog<T>>

Parameters:

width - new window width

Returns:

processed window

packToHeight

public T packToHeight(int height)

Description copied from interface: WindowMethods

Packs window to its preffered width and specified height.

Specified by:

packToHeight in interface WindowMethods<T extends WebDialog<T>>

Parameters:

height - new window height

Returns:

processed window