com.itmill.toolkit.ui
Class FrameWindow.Frameset

java.lang.Object
  com.itmill.toolkit.ui.FrameWindow.Frame
      com.itmill.toolkit.ui.FrameWindow.Frameset

Enclosing class:

FrameWindow

public class FrameWindow.Frameset
extends FrameWindow.Frame

Vertical or horizontal set of frames.

Field Summary

Fields inherited from class com.itmill.toolkit.ui.FrameWindow.Frame

parentFrameset

Constructor Summary

FrameWindow.Frameset()

Method Summary

FrameWindow.Frame	getFrame(int index) Gets the frame by index.
FrameWindow.Frame	getFrame(String name) Gets the frame by name.
List	getFrames() Gets the list of frames.
boolean	isVertical() Checks if the frameset is vertical.
FrameWindow.Frame	newFrame(Resource resource, String name) Creates the new frame containing a resource.
FrameWindow.Frame	newFrame(Resource resource, String name, int index) Creates the new frame containing a resource.
FrameWindow.Frame	newFrame(URL url, String name) Creates the new frame containing a url.
FrameWindow.Frame	newFrame(URL url, String name, int index) Creates the new frame containing a url.
FrameWindow.Frame	newFrame(Window window) Creates the new frame containing a window.
FrameWindow.Frame	newFrame(Window window, int index) Creates the new frame containing a window.
FrameWindow.Frameset	newFrameset(boolean isVertical, int index) Creates the new frameset.
void	removeAllFrames() Removes all frames from this frameset.
void	removeFrame(FrameWindow.Frame frame) Removes the frame from this frameset.
void	setVertical(boolean isVertical) Sets the framaset to be vertical.
int	size() Number of frames in this frameset.

Methods inherited from class com.itmill.toolkit.ui.FrameWindow.Frame

getName, getParentFrameset, getResource, getURL, getWindow, setAbsoluteSize, setFreeSize, setRelativeSize

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameWindow.Frameset

public FrameWindow.Frameset()

Method Detail

getFrames

public List getFrames()

Gets the list of frames.

Returns:

the unmodifiable list of frames.

newFrame

public FrameWindow.Frame newFrame(Window window)

Creates the new frame containing a window.

The new frame will be in the end of the frames list.

Parameters:

window - the window connected to the frame.

Returns:

the new Frame.

newFrame

public FrameWindow.Frame newFrame(Window window,
                                  int index)

Creates the new frame containing a window.

The new frame will be put before the frame identified by the given index. The indexes of the frame previously in the given position and all the positions after it are incremented by one.

Parameters:

window - the window connected to the frame.

index - the given index.

newFrame

public FrameWindow.Frame newFrame(URL url,
                                  String name)

Creates the new frame containing a url.

The new frame will be put in the end of the frames list.

Parameters:

url - the URL of the frame contents.

name - the Name of the frame.

Returns:

the new frame.

newFrame

public FrameWindow.Frame newFrame(Resource resource,
                                  String name)

Creates the new frame containing a resource.

The new frame will be put in the end of the frames list.

Parameters:

resource - the resource.

name - the Name of the frame.

Returns:

the new frame.

newFrame

public FrameWindow.Frame newFrame(URL url,
                                  String name,
                                  int index)

Creates the new frame containing a url.

The new frame will be put before the frame identified by the given index. The indexes of the frame previously in the given position and all the positions after it are incremented by one.

Parameters:

url - the URL of the frame contents.

name - the Name of the frame.

index - the given index.

Returns:

the new frame.

newFrame

public FrameWindow.Frame newFrame(Resource resource,
                                  String name,
                                  int index)

Creates the new frame containing a resource.

The new frame will be put before the frame identified by the given index. The indexes of the frame previously in the given position and all the positions after it are incremented by one.

Parameters:

resource - the resource.

name - the Name of the frame.

index - the given index.

Returns:

the new frame.

newFrameset

public FrameWindow.Frameset newFrameset(boolean isVertical,
                                        int index)

Creates the new frameset.

The new frame will be put before the frame identified by the given index. The indexes of the frame previously in the given position and all the positions after it are incremented by one.

Parameters:

isVertical - is the frames are on top of each other.

index - the given index.

Returns:

the new frameset.

removeFrame

public void removeFrame(FrameWindow.Frame frame)

Removes the frame from this frameset.

Parameters:

frame - the frame to remove.

removeAllFrames

public void removeAllFrames()

Removes all frames from this frameset.

size

public int size()

Number of frames in this frameset.

Returns:

the size.

setVertical

public void setVertical(boolean isVertical)

Sets the framaset to be vertical.

By setting this true, the frames will be ordered on top of each other from top to bottom. Setting this false, the frames will be ordered side by side from left to right.

Parameters:

isVertical - is the frames are on top of each other.

isVertical

public boolean isVertical()

Checks if the frameset is vertical.

If this is true, the frames will be ordered on top of each other from top to bottom, otherwise the frames will be ordered side by side from left to right.

Returns:

true if the frameset is Vertical, otherwise false.

getFrame

public FrameWindow.Frame getFrame(String name)

Gets the frame by name.

Parameters:

name - the Name of the frame.

Returns:

the Frame having the given name or null if the frame is not found.

getFrame

public FrameWindow.Frame getFrame(int index)

Gets the frame by index.

Parameters:

index - the given index.

Returns:

the Frame having the given index or null if the frame is not found