org.millstone.base.ui
Class FrameWindow.Frameset

java.lang.Object
  |
  +--org.millstone.base.ui.FrameWindow.Frame
        |
        +--org.millstone.base.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 org.millstone.base.ui.FrameWindow.Frame

parentFrameset

Constructor Summary

FrameWindow.Frameset()

Method Summary

FrameWindow.Frame	getFrame(int index) Get frame by index.
FrameWindow.Frame	getFrame(java.lang.String name) Get frame by name.
java.util.List	getFrames() Get a list of frames.
boolean	isVertical() Check if the frameset is vertical.
FrameWindow.Frame	newFrame(Resource resource, java.lang.String name) Create new frame containing a resource.
FrameWindow.Frame	newFrame(Resource resource, java.lang.String name, int index) Create new frame containing a resource.
FrameWindow.Frame	newFrame(java.net.URL url, java.lang.String name) Create new frame containing a url.
FrameWindow.Frame	newFrame(java.net.URL url, java.lang.String name, int index) Create new frame containing a url.
FrameWindow.Frame	newFrame(Window window) Create new frame containing a window.
FrameWindow.Frame	newFrame(Window window, int index) Create new frame containing a window.
FrameWindow.Frameset	newFrameset(boolean isVertical, int index) Create new frameset.
void	removeAllFrames() Remove all frames from this frameset
void	removeFrame(FrameWindow.Frame frame) Remove a frame from this frameset
void	setVertical(boolean isVertical) Set the framaset to be vertical.
int	size() Number of frames in this frameset

Methods inherited from class org.millstone.base.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 java.util.List getFrames()

Get a list of frames.

Returns:

unmodifiable list of frames.

newFrame

public FrameWindow.Frame newFrame(Window window)

Create new frame containing a window.

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

newFrame

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

Create 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.

newFrame

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

Create new frame containing a url.

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

newFrame

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

Create new frame containing a resource.

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

newFrame

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

Create 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.

newFrame

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

Create 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.

newFrameset

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

Create 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.

removeFrame

public void removeFrame(FrameWindow.Frame frame)

Remove a frame from this frameset

removeAllFrames

public void removeAllFrames()

Remove all frames from this frameset

size

public int size()

Number of frames in this frameset

setVertical

public void setVertical(boolean isVertical)

Set 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.

isVertical

public boolean isVertical()

Check 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.

getFrame

public FrameWindow.Frame getFrame(java.lang.String name)

Get frame by name.

Returns:

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

getFrame

public FrameWindow.Frame getFrame(int index)

Get frame by index.

Returns:

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