com.itmill.toolkit.ui
Class FrameWindow

java.lang.Object
  com.itmill.toolkit.terminal.Identifiable
      com.itmill.toolkit.ui.AbstractComponent
          com.itmill.toolkit.ui.AbstractComponentContainer
              com.itmill.toolkit.ui.Panel
                  com.itmill.toolkit.ui.Window
                      com.itmill.toolkit.ui.FrameWindow

All Implemented Interfaces:

MethodEventSource, Paintable, ParameterHandler, Scrollable, Sizeable, URIHandler, VariableOwner, Component, ComponentContainer, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachListener, EventListener

public class FrameWindow
extends Window

An application frame window component. This component implements a window that contains a hierarchical set of frames. Each frame can contain a web-page, window or a set of frames that divides the space horizontally or vertically.

A FrameWindow can't contain any components directly (as it contains only a set of frames) and thus the container interface methods do nothing.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Nested Class Summary

class	FrameWindow.Frame An individual frame that contains either a window or the contents of the url set to frame.
class	FrameWindow.Frameset Vertical or horizontal set of frames.

Nested classes/interfaces inherited from class com.itmill.toolkit.ui.Window

Window.CloseEvent, Window.CloseListener

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.URIHandler

URIHandler.ErrorEvent

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.ParameterHandler

ParameterHandler.ErrorEvent

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

Fields inherited from class com.itmill.toolkit.ui.Window

BORDER_DEFAULT, BORDER_MINIMAL, BORDER_NONE

Fields inherited from interface com.itmill.toolkit.terminal.Sizeable

UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNITS_ROWS

Constructor Summary

FrameWindow()
Constructs a new frame window.

FrameWindow(String caption)
Constructs a new frame window.

Method Summary

void	addComponent(Component c) Frame window does not support adding components directly.
FrameWindow.Frameset	getFrameset() Gets the main frameset of the window.
String	getTag() Gets the window's UIDL tag.
boolean	isScrollable() Frame windows does not support scrolling.
void	paintContent(PaintTarget target) Paints the window contents.
void	setApplication(Application application) Setting the application for frame window also sets the application for all the frames.
void	setScrollable(boolean isScrollingEnabled) Enables or disables scrolling.
void	setScrollOffsetX(int pixelsScrolledLeft) Sets the scroll X offset.
void	setScrollOffsetY(int pixelsScrolledDown) Gets the scroll Y offset.

Methods inherited from class com.itmill.toolkit.ui.Window

addListener, addParameterHandler, addURIHandler, changeVariables, fireClose, getApplication, getBorder, getFocusableById, getFocusedComponent, getName, getNewFocusableId, getParent, getPositionX, getPositionY, getTerminal, getTheme, getURL, getWindow, handleParameters, handleURI, open, open, open, removeFocusableId, removeListener, removeParameterHandler, removeURIHandler, setBorder, setFocusedComponent, setHeightUnits, setName, setParent, setPositionX, setPositionY, setTerminal, setTheme, setWidthUnits

Methods inherited from class com.itmill.toolkit.ui.Panel

attach, componentAttachedToContainer, componentDetachedFromContainer, detach, getComponentIterator, getHeight, getHeightUnits, getLayout, getScrollOffsetX, getScrollOffsetY, getWidth, getWidthUnits, removeAllComponents, removeComponent, replaceComponent, setHeight, setLayout, setWidth

Methods inherited from class com.itmill.toolkit.ui.AbstractComponentContainer

addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeListener, removeListener

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent

addListener, addListener, addListener, addListener, childRequestedRepaint, dependsOn, fireComponentErrorEvent, fireComponentEvent, fireEvent, getCaption, getComponentError, getData, getDescription, getDirectDependencies, getErrorMessage, getIcon, getLocale, getStyle, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDescription, setEnabled, setIcon, setImmediate, setLocale, setReadOnly, setStyle, setVisible

Methods inherited from class com.itmill.toolkit.terminal.Identifiable

getDebugId, getUIID, setDebugId, setUIID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itmill.toolkit.ui.Component

addListener, childRequestedRepaint, getCaption, getIcon, getLocale, getStyle, isEnabled, isReadOnly, isVisible, removeListener, setEnabled, setReadOnly, setStyle, setVisible

Methods inherited from interface com.itmill.toolkit.terminal.Paintable

addListener, paint, removeListener, requestRepaint, requestRepaintRequests

Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner

dependsOn, getDirectDependencies, isImmediate, removeDirectDependency

Constructor Detail

FrameWindow

public FrameWindow()

Constructs a new frame window.

FrameWindow

public FrameWindow(String caption)

Constructs a new frame window.

Parameters:

caption - th etitle of the window.

Method Detail

getTag

public String getTag()

Gets the window's UIDL tag.

Overrides:

getTag in class Window

Returns:

the window's UIDL tag as String.

getFrameset

public FrameWindow.Frameset getFrameset()

Gets the main frameset of the window. This set contains all the top-level frames of the window. New contents are added by adding frames to this frameset.

Returns:

the top-level frame set of this frame window.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the window contents.

Overrides:

paintContent in class Window

Parameters:

target - the paint target event.

Throws:

PaintException - if the paint operation fails.

See Also:

AbstractComponent.paintContent(PaintTarget)

setApplication

public void setApplication(Application application)

Setting the application for frame window also sets the application for all the frames.

Overrides:

setApplication in class Window

Parameters:

application - the application to set.

See Also:

Window.setApplication(Application)

isScrollable

public boolean isScrollable()

Frame windows does not support scrolling.

Specified by:

isScrollable in interface Scrollable

Overrides:

isScrollable in class Panel

Returns:

true if it is scrollable,otherwise false.

setScrollable

public void setScrollable(boolean isScrollingEnabled)

Enables or disables scrolling.

Specified by:

setScrollable in interface Scrollable

Overrides:

setScrollable in class Panel

Parameters:

isScrollingEnabled - true if the scrolling is allowed.

See Also:

Scrollable.setScrollable(boolean)

setScrollOffsetX

public void setScrollOffsetX(int pixelsScrolledLeft)

Sets the scroll X offset.

Specified by:

setScrollOffsetX in interface Scrollable

Overrides:

setScrollOffsetX in class Panel

Parameters:

pixelsScrolledLeft - the xOffset.

See Also:

Scrollable.setScrollOffsetX(int)

setScrollOffsetY

public void setScrollOffsetY(int pixelsScrolledDown)

Gets the scroll Y offset.

Specified by:

setScrollOffsetY in interface Scrollable

Overrides:

setScrollOffsetY in class Panel

Parameters:

pixelsScrolledDown - the yOffset.

See Also:

Scrollable.setScrollOffsetY(int)

addComponent

public void addComponent(Component c)
                  throws UnsupportedOperationException

Frame window does not support adding components directly.

To add component to frame window, normal window must be first created and then attached to frame window as a frame.

Specified by:

addComponent in interface ComponentContainer

Overrides:

addComponent in class Panel

Parameters:

c - the component to be added.

Throws:

UnsupportedOperationException

See Also:

ComponentContainer.addComponent(Component)