com.alee.laf.rootpane

Class WebFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

com.alee.laf.rootpane.WebFrame

All Implemented Interfaces:

com.alee.managers.language.LanguageContainerMethods, com.alee.managers.language.LanguageMethods, com.alee.managers.settings.SettingsMethods, PaddingSupport, Skinnable, Styleable, Paintable, com.alee.utils.swing.SwingMethods, WindowEventMethods, WindowMethods<WebFrame>, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

LibraryInfoDialog, NinePatchEditorDialog, StyleEditor, TestFrame

public class WebFrame
extends javax.swing.JFrame
implements Styleable, Skinnable, Paintable, PaddingSupport, WindowEventMethods, com.alee.managers.language.LanguageMethods, com.alee.managers.language.LanguageContainerMethods, com.alee.managers.settings.SettingsMethods, WindowMethods<WebFrame>

This JFrame extension class provides some additional methods and options to manipulate frame behavior.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

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

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 com.alee.managers.style.PaddingSupport

EMPTY

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

Constructors

Constructor and Description
WebFrame() Constructs a new frame that is initially invisible.
WebFrame(java.awt.GraphicsConfiguration gc) Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title.
WebFrame(java.lang.String title) Creates a new, initially invisible Frame with the specified title.
WebFrame(java.lang.String title, java.awt.GraphicsConfiguration gc) Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device.
WebFrame(StyleId id) Constructs a new frame that is initially invisible.
WebFrame(StyleId id, java.awt.GraphicsConfiguration gc) Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title.
WebFrame(StyleId id, java.lang.String title) Creates a new, initially invisible Frame with the specified title.
WebFrame(StyleId id, java.lang.String title, java.awt.GraphicsConfiguration gc) Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device.

Method Summary

Modifier and Type	Method and Description
void	addFocusableChild(java.awt.Component child) Adds focusable child that won't force frame to close even if it set to close on focus loss.
void	addStyleListener(StyleListener listener) Adds style change listener.
WebFrame	center() Centers window relative to screen center.
WebFrame	center(java.awt.Component relativeTo) Centers window relative to the specified component center.
WebFrame	center(java.awt.Component relativeTo, int width, int height) Changes window size and centers it relative to the specified component center.
WebFrame	center(int width, int height) Changes window size and centers it relative to screen center.
protected javax.swing.JRootPane	createRootPane() Called by the constructor methods to create the default rootPane.
GroupPane	getButtonsPanel() Returns window buttons panel.
Painter	getCustomPainter() Returns custom base painter for this component.
Painter	getCustomPainter(java.lang.String id) Returns custom painter for this component.
java.util.Map<java.lang.String,Painter>	getCustomPainters() Returns all custom painters for this component.
java.util.List<java.awt.Component>	getFocusableChildren() Returns focusable children that don't force frame to close even if it set to close on focus loss.
java.lang.String	getLanguageContainerKey()
java.awt.Insets	getPadding() Returns current padding.
protected WebRootPaneUI	getRootPaneWebUI() Returns Web-UI applied to root pane used by this frame.
Skin	getSkin() Returns skin currently applied to this component.
StyleId	getStyleId() Returns component style ID.
javax.swing.JComponent	getTitleComponent() Returns window title component.
protected WebRootPaneUI	getWebUI() Returns Web-UI applied to this class.
float	getWindowOpacity() Returns window opacity.
protected void	initialize(StyleId id) Additional initialization of WebFrame settings.
boolean	isCloseOnFocusLoss() Returns whether should close frame 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()
boolean	isWindowOpaque() Returns whether window is opaque or not.
void	loadSettings()
WindowCloseAdapter	onClose(ComponentEventRunnable runnable) Shortcut method for window close event.
java.awt.event.WindowAdapter	onClosing(WindowEventRunnable runnable) Shortcut method for window closing event.
WebFrame	packAndCenter() Packs and centers window relative to old position.
WebFrame	packAndCenter(boolean animate) Packs and centers window relative to old position.
WebFrame	packToHeight(int height) Packs window to its preffered width and specified height.
WebFrame	packToWidth(int width) Packs window to its preffered height and specified width.
void	registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)
void	registerSettings(java.lang.String key)
void	registerSettings(java.lang.String key, boolean loadInitialSettings, boolean applySettingsChanges)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	removeFocusableChild(java.awt.Component child) Removes focusable child that doesn't force frame to close even if it set to close on focus loss.
void	removeLanguage()
void	removeLanguageContainerKey()
void	removeLanguageUpdater()
void	removeStyleListener(StyleListener listener) Removes style change listener.
boolean	restoreDefaultPainters() Restores default painters for this component.
Skin	restoreSkin() Restores global skin for this component and all of its children linked via StyleId.
void	saveSettings()
void	setCloseOnFocusLoss(boolean closeOnFocusLoss) Sets whether should close frame on focus loss or not.
Painter	setCustomPainter(Painter painter) Sets custom base painter for this component.
Painter	setCustomPainter(java.lang.String id, Painter painter) Sets custom painter for this component under the specified painter ID.
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(java.lang.String key, java.lang.Object... data)
void	setLanguageContainerKey(java.lang.String key)
void	setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)
void	setPadding(java.awt.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.
Skin	setSkin(Skin skin) Applies specified skin to the specified component and all of its children linked via StyleId.
Skin	setSkin(Skin skin, boolean recursively) Applies specified skin to the specified component and all of its children linked via StyleId.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	setTitleComponent(javax.swing.JComponent title) Sets window title component.
WebFrame	setWindowOpacity(float opacity) Sets window opacity if that option is supported by the underlying system.
WebFrame	setWindowOpaque(boolean opaque) Sets window opaque if that option is supported by the underlying system.
void	unregisterSettings()
void	updateLanguage(java.lang.Object... data)
void	updateLanguage(java.lang.String key, java.lang.Object... data)

Methods inherited from class javax.swing.JFrame

addImpl, 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, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, 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, 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, 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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

closeOnFocusLoss

protected boolean closeOnFocusLoss

Whether should close frame on focus loss or not.

focusTracker

protected DefaultFocusTracker focusTracker

Window focus tracker.

Constructor Detail

WebFrame

public WebFrame()

Constructs a new frame that is initially invisible. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

WebFrame

public WebFrame(java.awt.GraphicsConfiguration gc)

Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

gc - the GraphicsConfiguration that is used to construct the new Frame; if gc is null, the system default GraphicsConfiguration is assumed

WebFrame

public WebFrame(java.lang.String title)

Creates a new, initially invisible Frame with the specified title. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

title - the title for the frame

WebFrame

public WebFrame(java.lang.String title,
                java.awt.GraphicsConfiguration gc)

Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

title - the title to be displayed in the frame's border. A null value is treated as an empty string, ""

gc - the GraphicsConfiguration that is used to construct the new JFrame with; if gc is null, the system default GraphicsConfiguration is assumed

WebFrame

public WebFrame(StyleId id)

Constructs a new frame that is initially invisible. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - style ID

WebFrame

public WebFrame(StyleId id,
                java.awt.GraphicsConfiguration gc)

Creates a Frame in the specified GraphicsConfiguration of a screen device and a blank title. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - style ID

gc - the GraphicsConfiguration that is used to construct the new Frame; if gc is null, the system default GraphicsConfiguration is assumed

WebFrame

public WebFrame(StyleId id,
                java.lang.String title)

Creates a new, initially invisible Frame with the specified title. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - style ID

title - the title for the frame

WebFrame

public WebFrame(StyleId id,
                java.lang.String title,
                java.awt.GraphicsConfiguration gc)

Creates a JFrame with the specified title and the specified GraphicsConfiguration of a screen device. This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Parameters:

id - style ID

title - the title to be displayed in the frame's border. A null value is treated as an empty string, ""

gc - the GraphicsConfiguration that is used to construct the new JFrame with; if gc is null, the system default GraphicsConfiguration is assumed

Method Detail

initialize

protected void initialize(StyleId id)

Additional initialization of WebFrame settings.

Parameters:

id - initial style ID

createRootPane

protected javax.swing.JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

Overrides:

createRootPane in class javax.swing.JFrame

isCloseOnFocusLoss

public boolean isCloseOnFocusLoss()

Returns whether should close frame on focus loss or not.

Returns:

true if should close frame on focus loss, false otherwise

setCloseOnFocusLoss

public void setCloseOnFocusLoss(boolean closeOnFocusLoss)

Sets whether should close frame on focus loss or not.

Parameters:

closeOnFocusLoss - whether should close frame on focus loss or not

getFocusableChildren

public java.util.List<java.awt.Component> getFocusableChildren()

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

Returns:

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

addFocusableChild

public void addFocusableChild(java.awt.Component child)

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

Parameters:

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

removeFocusableChild

public void removeFocusableChild(java.awt.Component child)

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

Parameters:

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

getTitleComponent

public javax.swing.JComponent getTitleComponent()

Returns window title component.

Returns:

window title component

setTitleComponent

public void setTitleComponent(javax.swing.JComponent title)

Sets window title component.

Parameters:

title - new window title component

getButtonsPanel

public GroupPane getButtonsPanel()

Returns window buttons panel.

Returns:

window buttons panel

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

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

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

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

getSkin

public Skin getSkin()

Description copied from interface: Skinnable

Returns skin currently applied to this component.

Specified by:

getSkin in interface Skinnable

Returns:

skin currently applied to this component

setSkin

public Skin setSkin(Skin skin)

Description copied from interface: Skinnable

Applies specified skin to the specified 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 Skinnable

Parameters:

skin - skin to be applied

Returns:

previously applied skin

setSkin

public Skin setSkin(Skin skin,
                    boolean recursively)

Description copied from interface: Skinnable

Applies specified skin to the specified 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 Skinnable

Parameters:

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

restoreSkin

public Skin restoreSkin()

Description copied from interface: Skinnable

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

Specified by:

restoreSkin in interface Skinnable

Returns:

skin applied to this component after restoration

addStyleListener

public void addStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Adds style change listener.

Specified by:

addStyleListener in interface Skinnable

Parameters:

listener - style change listener to add

removeStyleListener

public void removeStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Removes style change listener.

Specified by:

removeStyleListener in interface Skinnable

Parameters:

listener - style change listener to remove

getCustomPainters

public java.util.Map<java.lang.String,Painter> getCustomPainters()

Description copied from interface: Paintable

Returns all custom painters for this component.

Specified by:

getCustomPainters in interface Paintable

Returns:

all custom painters for this component

getCustomPainter

public Painter getCustomPainter()

Description copied from interface: Paintable

Returns custom base painter for this component.

Specified by:

getCustomPainter in interface Paintable

Returns:

custom base painter for this component

getCustomPainter

public Painter getCustomPainter(java.lang.String id)

Description copied from interface: Paintable

Returns custom painter for this component.

Specified by:

getCustomPainter in interface Paintable

Parameters:

id - painter ID

Returns:

custom painter for this component

setCustomPainter

public Painter setCustomPainter(Painter painter)

Description copied from interface: Paintable

Sets custom base painter for this component.

Specified by:

setCustomPainter in interface Paintable

Parameters:

painter - custom base painter

Returns:

previously set custom base painter

setCustomPainter

public Painter setCustomPainter(java.lang.String id,
                                Painter painter)

Description copied from interface: Paintable

Sets custom painter for this component under the specified painter ID.

Specified by:

setCustomPainter in interface Paintable

Parameters:

id - painter ID

painter - painter

Returns:

old custom painter

restoreDefaultPainters

public boolean restoreDefaultPainters()

Description copied from interface: Paintable

Restores default painters for this component.

Specified by:

restoreDefaultPainters in interface Paintable

Returns:

true if default painters were restored, false otherwise

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

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

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(int padding)

Sets new padding.

Parameters:

padding - new padding

setPadding

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

Sets new padding.

Parameters:

top - new top padding

left - new left padding

bottom - new bottom padding

right - new right padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

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

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

getWebUI

protected WebRootPaneUI getWebUI()

Returns Web-UI applied to this class.

Returns:

Web-UI applied to this class

getRootPaneWebUI

protected WebRootPaneUI getRootPaneWebUI()

Returns Web-UI applied to root pane used by this frame.

Returns:

Web-UI applied to root pane used by this frame

onClosing

public java.awt.event.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

setLanguage

public void setLanguage(java.lang.String key,
                        java.lang.Object... data)

Specified by:

setLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

public void updateLanguage(java.lang.Object... data)

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

public void updateLanguage(java.lang.String key,
                           java.lang.Object... data)

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

removeLanguage

public void removeLanguage()

Specified by:

removeLanguage in interface com.alee.managers.language.LanguageMethods

isLanguageSet

public boolean isLanguageSet()

Specified by:

isLanguageSet in interface com.alee.managers.language.LanguageMethods

setLanguageUpdater

public void setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)

Specified by:

setLanguageUpdater in interface com.alee.managers.language.LanguageMethods

removeLanguageUpdater

public void removeLanguageUpdater()

Specified by:

removeLanguageUpdater in interface com.alee.managers.language.LanguageMethods

setLanguageContainerKey

public void setLanguageContainerKey(java.lang.String key)

Specified by:

setLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods

removeLanguageContainerKey

public void removeLanguageContainerKey()

Specified by:

removeLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods

getLanguageContainerKey

public java.lang.String getLanguageContainerKey()

Specified by:

getLanguageContainerKey in interface com.alee.managers.language.LanguageContainerMethods

registerSettings

public void registerSettings(java.lang.String key)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String group,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass,
                                                                                 boolean loadInitialSettings,
                                                                                 boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String group,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass,
                                                                                 boolean loadInitialSettings,
                                                                                 boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

unregisterSettings

public void unregisterSettings()

Specified by:

unregisterSettings in interface com.alee.managers.settings.SettingsMethods

loadSettings

public void loadSettings()

Specified by:

loadSettings in interface com.alee.managers.settings.SettingsMethods

saveSettings

public void saveSettings()

Specified by:

saveSettings in interface com.alee.managers.settings.SettingsMethods

setWindowOpaque

public WebFrame 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<WebFrame>

Parameters:

opaque - whether should make window opaque or not

Returns:

processed window

isWindowOpaque

public boolean isWindowOpaque()

Description copied from interface: WindowMethods

Returns whether window is opaque or not.

Specified by:

isWindowOpaque in interface WindowMethods<WebFrame>

Returns:

true if window is opaque, false otherwise

setWindowOpacity

public WebFrame 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<WebFrame>

Parameters:

opacity - new window opacity

Returns:

processed window

getWindowOpacity

public float getWindowOpacity()

Description copied from interface: WindowMethods

Returns window opacity.

Specified by:

getWindowOpacity in interface WindowMethods<WebFrame>

Returns:

window opacity

center

public WebFrame center()

Description copied from interface: WindowMethods

Centers window relative to screen center.

Specified by:

center in interface WindowMethods<WebFrame>

Returns:

processed window

center

public WebFrame center(java.awt.Component relativeTo)

Description copied from interface: WindowMethods

Centers window relative to the specified component center.

Specified by:

center in interface WindowMethods<WebFrame>

Parameters:

relativeTo - component used to center window

Returns:

processed window

center

public WebFrame 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<WebFrame>

Parameters:

width - new window width

height - new window height

Returns:

processed window

center

public WebFrame center(java.awt.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<WebFrame>

Parameters:

relativeTo - component used to center window

width - new window width

height - new window height

Returns:

processed window

packToWidth

public WebFrame packToWidth(int width)

Description copied from interface: WindowMethods

Packs window to its preffered height and specified width.

Specified by:

packToWidth in interface WindowMethods<WebFrame>

Parameters:

width - new window width

Returns:

processed window

packToHeight

public WebFrame packToHeight(int height)

Description copied from interface: WindowMethods

Packs window to its preffered width and specified height.

Specified by:

packToHeight in interface WindowMethods<WebFrame>

Parameters:

height - new window height

Returns:

processed window

packAndCenter

public WebFrame packAndCenter()

Description copied from interface: WindowMethods

Packs and centers window relative to old position.

Specified by:

packAndCenter in interface WindowMethods<WebFrame>

Returns:

processed window

packAndCenter

public WebFrame packAndCenter(boolean animate)

Description copied from interface: WindowMethods

Packs and centers window relative to old position.

Specified by:

packAndCenter in interface WindowMethods<WebFrame>

Parameters:

animate - whether should animate window size changes or not

Returns:

processed window