org.jowidgets.tools.widgets.wrapper

Class FrameWrapper

java.lang.Object

org.jowidgets.tools.widgets.wrapper.WidgetWrapper

org.jowidgets.tools.widgets.wrapper.ComponentWrapper

org.jowidgets.tools.widgets.wrapper.ContainerWrapper

org.jowidgets.tools.widgets.wrapper.FrameWrapper

All Implemented Interfaces:

IContainerObservable, IDisposeObservable, IRecursiveContainerObservable, IShowingStateObservable, IComponent, IContainer, IDisplay, IFrame, IWidget, IWindow, IComponentObservable, IFocusObservable, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IWindowObservable, IComponentCommon, IContainerCommon, IDisplayCommon, IFrameCommon, IWidgetCommon, IWindowCommon

Direct Known Subclasses:

Dialog, Frame

public class FrameWrapper
extends ContainerWrapper
implements IFrame

Constructor Summary

Constructors

Constructor and Description
FrameWrapper(IFrame original)

Method Summary

Methods

Modifier and Type	Method and Description
void	addWindowListener(IWindowListener listener) Adds a window listener
void	centerLocation() Centers the location relative to the parent bounds
<WIDGET_TYPE extends IDisplay,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE	createChildWindow(DESCRIPTOR_TYPE descriptor) Creates a child window with this window as parent
IMenuBar	createMenuBar() Creates a new menu bar or returns a earlier created menu bar.
java.util.List<IDisplay>	getChildWindows() Gets the child windows of this window as a unmodifiable copy
IMenuBarModel	getMenuBarModel() Gets the menu bar model of this frame.
IWindow	getParent() Gets the parent of the widget
Rectangle	getParentBounds() Gets the parent bounds of this window.
boolean	isIconfied()
boolean	isMaximized()
void	pack() Resizes the window to its preferred size and layouts its underlying container
void	removeWindowListener(IWindowListener listener) Removes a window listener
void	setDefaultButton(IButton button)
void	setIconfied(boolean iconfied)
void	setMaximized(boolean maximized)
void	setMaxPackSize(Dimension size) Sets the max pack size of the window.
void	setMenuBar(IMenuBarModel model) Sets the menu bar for this frame.
void	setMinPackSize(Dimension size) Sets the min pack size of the window.
void	setMinSize(Dimension minSize)
void	setMinSize(int width, int height)
void	setParent(IWindow parent) Sets the parent window.
void	setTitle(java.lang.String title)

Methods inherited from class org.jowidgets.tools.widgets.wrapper.ContainerWrapper

add, add, add, add, add, add, add, add, addComponentListenerRecursive, addContainerListener, addContainerRegistry, addFocusListenerRecursive, addKeyListenerRecursive, addMouseListenerRecursive, addPopupDetectionListenerRecursive, computeDecoratedSize, getChildren, getClientArea, getWidget, layout, layoutBegin, layoutEnd, layoutLater, remove, removeAll, removeComponentListenerRecursive, removeContainerListener, removeContainerRegistry, removeFocusListenerRecursive, removeKeyListenerRecursive, removeMouseListenerRecursive, removePopupDetectionListenerRecursive, setLayout, setLayout, setTabOrder, setTabOrder

Methods inherited from class org.jowidgets.tools.widgets.wrapper.ComponentWrapper

addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addPopupDetectionListener, addShowingStateListener, createPopupMenu, fromComponent, getBackgroundColor, getBounds, getForegroundColor, getPosition, getSize, hasFocus, isReparentable, isShowing, isVisible, redraw, removeComponentListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePopupDetectionListener, removeShowingStateListener, requestFocus, setBackgroundColor, setBounds, setCursor, setForegroundColor, setPopupMenu, setPosition, setPosition, setRedrawEnabled, setSize, setSize, setVisible, toComponent, toLocal, toScreen

Methods inherited from class org.jowidgets.tools.widgets.wrapper.WidgetWrapper

addDisposeListener, dispose, getRoot, getUiReference, isDisposed, isEnabled, removeDisposeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jowidgets.api.widgets.IContainer

add, add, add, add, add, add, add, add, addContainerRegistry, getChildren, layout, layoutLater, remove, removeContainerRegistry, setLayout, setTabOrder, setTabOrder

Methods inherited from interface org.jowidgets.api.widgets.IComponent

createPopupMenu, fromComponent, getBounds, hasFocus, isReparentable, isShowing, setBounds, setPopupMenu, setPosition, setSize, toComponent, toLocal, toScreen

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.api.controller.IShowingStateObservable

addShowingStateListener, removeShowingStateListener

Methods inherited from interface org.jowidgets.api.controller.IContainerObservable

addContainerListener, removeContainerListener

Methods inherited from interface org.jowidgets.api.controller.IRecursiveContainerObservable

addComponentListenerRecursive, addFocusListenerRecursive, addKeyListenerRecursive, addMouseListenerRecursive, addPopupDetectionListenerRecursive, removeComponentListenerRecursive, removeFocusListenerRecursive, removeKeyListenerRecursive, removeMouseListenerRecursive, removePopupDetectionListenerRecursive

Methods inherited from interface org.jowidgets.common.widgets.IWindowCommon

dispose

Methods inherited from interface org.jowidgets.common.widgets.IContainerCommon

computeDecoratedSize, getClientArea, layoutBegin, layoutEnd, removeAll, setLayout

Methods inherited from interface org.jowidgets.common.widgets.IComponentCommon

getBackgroundColor, getForegroundColor, getPosition, getSize, isVisible, redraw, requestFocus, setBackgroundColor, setCursor, setForegroundColor, setPosition, setRedrawEnabled, setSize, setVisible

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

getUiReference, isEnabled, setEnabled

Methods inherited from interface org.jowidgets.common.widgets.controller.IComponentObservable

addComponentListener, removeComponentListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IFocusObservable

addFocusListener, removeFocusListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IKeyObservable

addKeyListener, removeKeyListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseObservable

addMouseListener, removeMouseListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseMotionObservable

addMouseMotionListener, removeMouseMotionListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IPopupDetectionObservable

addPopupDetectionListener, removePopupDetectionListener

Constructor Detail

FrameWrapper

public FrameWrapper(IFrame original)

Method Detail

addWindowListener

public void addWindowListener(IWindowListener listener)

Description copied from interface: IWindowObservable

Adds a window listener

Specified by:

addWindowListener in interface IWindowObservable

Parameters:

listener - The listener to add

setParent

public void setParent(IWindow parent)

Description copied from interface: IDisplay

Sets the parent window. If the parent is already set, a IllegalStateException will be throw This method is only for internal use, because at the moment windows are not reparentable

Specified by:

setParent in interface IDisplay

Parameters:

parent - The parent to set

setMinSize

public void setMinSize(Dimension minSize)

Specified by:

setMinSize in interface IFrameCommon

createMenuBar

public IMenuBar createMenuBar()

Description copied from interface: IFrame

Creates a new menu bar or returns a earlier created menu bar.

Specified by:

createMenuBar in interface IFrame

Returns:

The menu bar of the frame.

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface IFrameCommon

removeWindowListener

public void removeWindowListener(IWindowListener listener)

Description copied from interface: IWindowObservable

Removes a window listener

Specified by:

removeWindowListener in interface IWindowObservable

Parameters:

listener - The listener to remove

setMaximized

public void setMaximized(boolean maximized)

Specified by:

setMaximized in interface IFrameCommon

getParentBounds

public Rectangle getParentBounds()

Description copied from interface: IWindowCommon

Gets the parent bounds of this window. If the window is a root window, the bounds of the screen will be returned, otherwise the bounds of the parent window will be returned.

Specified by:

getParentBounds in interface IWindowCommon

Returns:

The parent bounds, never null

isMaximized

public boolean isMaximized()

Specified by:

isMaximized in interface IFrameCommon

centerLocation

public void centerLocation()

Description copied from interface: IWindow

Centers the location relative to the parent bounds

Specified by:

centerLocation in interface IWindow

See Also:

IWindowCommon.getParentBounds()

setIconfied

public void setIconfied(boolean iconfied)

Specified by:

setIconfied in interface IFrameCommon

isIconfied

public boolean isIconfied()

Specified by:

isIconfied in interface IFrameCommon

getMenuBarModel

public IMenuBarModel getMenuBarModel()

Description copied from interface: IFrame

Gets the menu bar model of this frame. Invocation of this method will create a menu bar, if not already a menu bar exist.

Specified by:

getMenuBarModel in interface IFrame

Returns:

The menu bar model of this frame

createChildWindow

public <WIDGET_TYPE extends IDisplay,DESCRIPTOR_TYPE extends IWidgetDescriptor<WIDGET_TYPE>> WIDGET_TYPE createChildWindow(DESCRIPTOR_TYPE descriptor)

Description copied from interface: IWindow

Creates a child window with this window as parent

Specified by:

createChildWindow in interface IWindow

Type Parameters:

WIDGET_TYPE - The type of the created child window

DESCRIPTOR_TYPE - The type of the child windows descriptor

Parameters:

descriptor - The child windows descriptor

Returns:

The created window

getParent

public IWindow getParent()

Description copied from interface: IWidget

Gets the parent of the widget

Specified by:

getParent in interface IDisplay

Specified by:

getParent in interface IWidget

Overrides:

getParent in class WidgetWrapper

Returns:

The widgets parent or null, if the widget has no parent

pack

public void pack()

Description copied from interface: IWindowCommon

Resizes the window to its preferred size and layouts its underlying container

Specified by:

pack in interface IWindowCommon

setMenuBar

public void setMenuBar(IMenuBarModel model)

Description copied from interface: IFrame

Sets the menu bar for this frame. If this frame already has a menu bar, the old menu bar will be removed, and the new menu bar will be set.

Specified by:

setMenuBar in interface IFrame

Parameters:

model - The model of the menu bar to add, must not be null;

getChildWindows

public java.util.List<IDisplay> getChildWindows()

Description copied from interface: IWindow

Gets the child windows of this window as a unmodifiable copy

Specified by:

getChildWindows in interface IWindow

Returns:

all children of this window, may be empty but never null

setDefaultButton

public void setDefaultButton(IButton button)

Specified by:

setDefaultButton in interface IFrame

setMinSize

public void setMinSize(int width,
              int height)

Specified by:

setMinSize in interface IFrame

setMinPackSize

public void setMinPackSize(Dimension size)

Description copied from interface: IWindow

Sets the min pack size of the window. If the window will be packed and a min pack size was defined before, the window will not become smaller than the min pack size. The min pack size can be used to avoid that window becomes to small by packing.

Specified by:

setMinPackSize in interface IWindow

Parameters:

size - The min pack size to set

See Also:

IWindowCommon.pack()

setMaxPackSize

public void setMaxPackSize(Dimension size)

Description copied from interface: IWindow

Sets the max pack size of the window. If the window will be packed and a max pack size was defined before, the window will not become larger than the max pack size. The max pack size can be used to avoid that window becomes to big by packing.

Specified by:

setMaxPackSize in interface IWindow

Parameters:

size - The max pack size to set

See Also:

IWindowCommon.pack()