org.millstone.base.ui
Class FrameWindow

java.lang.Object
  |
  +--org.millstone.base.ui.AbstractComponent
        |
        +--org.millstone.base.ui.AbstractComponentContainer
              |
              +--org.millstone.base.ui.Panel
                    |
                    +--org.millstone.base.ui.Window
                          |
                          +--org.millstone.base.ui.FrameWindow

All Implemented Interfaces:

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

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:

3.0.3

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 inherited from class org.millstone.base.ui.ComponentContainer

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

Nested classes inherited from class org.millstone.base.ui.Component

Component.Event, Component.Listener

Nested classes inherited from class org.millstone.base.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

Fields inherited from class org.millstone.base.ui.Window

BORDER_DEFAULT, BORDER_MINIMAL, BORDER_NONE

Fields inherited from interface org.millstone.base.terminal.Sizeable

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

Constructor Summary

FrameWindow(java.lang.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.
java.lang.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) Frame windows does not support scrolling.
void	setScrollOffsetX(int pixelsScrolledLeft) Frame windows does not support scrolling.
void	setScrollOffsetY(int pixelsScrolledDown) Frame windows does not support scrolling.

Methods inherited from class org.millstone.base.ui.Window

addParameterHandler, addURIHandler, getApplication, getBorder, getName, getParent, getTerminal, getTheme, getURL, getWindow, handleParameters, handleURI, open, open, open, removeParameterHandler, removeURIHandler, setBorder, setHeightUnits, setName, setParent, setTerminal, setTheme, setWidthUnits

Methods inherited from class org.millstone.base.ui.Panel

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

Methods inherited from class org.millstone.base.ui.AbstractComponentContainer

addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from class org.millstone.base.ui.AbstractComponent

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.millstone.base.ui.Component

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

Methods inherited from interface org.millstone.base.terminal.Paintable

addListener, paint, removeListener, requestRepaint, requestRepaintRequests

Methods inherited from interface org.millstone.base.terminal.VariableOwner

dependsOn, getDirectDependencies, removeDirectDependency

Constructor Detail

FrameWindow

public FrameWindow(java.lang.String caption)

Constructs a new frame window.

Parameters:

caption - title of the window

Method Detail

getTag

public java.lang.String getTag()

Gets the window's UIDL tag.

Overrides:

getTag in class Window

Returns:

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:

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 - A 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 iff the scrolling is allowed.

setScrollable

public void setScrollable(boolean isScrollingEnabled)

Frame windows does not support scrolling.

Specified by:

setScrollable in interface Scrollable

Overrides:

setScrollable in class Panel

Parameters:

isScrollingEnabled - True iff the scrolling is allowed.

See Also:

Scrollable.setScrollable(boolean)

setScrollOffsetX

public void setScrollOffsetX(int pixelsScrolledLeft)

Frame windows does not support scrolling.

Specified by:

setScrollOffsetX in interface Scrollable

Overrides:

setScrollOffsetX in class Panel

See Also:

Scrollable.setScrollOffsetX(int)

setScrollOffsetY

public void setScrollOffsetY(int pixelsScrolledDown)

Frame windows does not support scrolling.

Specified by:

setScrollOffsetY in interface Scrollable

Overrides:

setScrollOffsetY in class Panel

See Also:

Scrollable.setScrollOffsetY(int)

addComponent

public void addComponent(Component c)
                  throws java.lang.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:

java.lang.UnsupportedOperationException - if invoked.

See Also:

ComponentContainer.addComponent(Component)