org.pajes.html
Class FrameSet

java.lang.Object
  org.pajes.html.Tag
      org.pajes.html.TraversableElement
          org.pajes.html.Container
              org.pajes.html.Body
                  org.pajes.html.FrameSet

All Implemented Interfaces:

java.lang.Cloneable, HTML, java.io.Serializable, Traversable

public class FrameSet

extends Body

This class generates the frameset tags. A Frameset defines the layout of multiple frame presentation in a browsers application window. The primary duty of the Frameset element is to specify the geographical layout, in a row and column array, of rectangular frames.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pajes.html.Tag

ON_CLICK_ATTRIBUTE, TAG_CLOSE, TAG_LEFT, TAG_RIGHT

Constructor Summary

FrameSet(java.lang.String rows, java.lang.String cols)
Create a frameset with the specified row and column layout.

Method Summary

Container	add(HTML frame) Adds a frame element to the frameset.
FrameSet	deleteFrame(java.lang.String frameName) Deletes the named frame from the frame set.
FrameSet	setBorderColor(Color borderColor) Sets the colour of the frame borders.
FrameSet	setBorderVisibility(boolean showFrameBorder) Sets the visibility of the frame borders.
FrameSet	setBorderWidth(int borderWidth) Sets the width of the frame borders.
FrameSet	setColumnLayout(java.lang.String cols) Sets the comma-delimited string defining the size and number of columns in this frame set.
FrameSet	setNoFramesText(java.lang.String text) Deprecated. Add a NoFrames object instead.
FrameSet	setRowLayout(java.lang.String rows) Sets the comma-delimited string defining the size and number of rows in this frame set.

Methods inherited from class org.pajes.html.Body

addOnLoadHandler, addOnUnLoadHandler, getDocType, getDocTypeHeader, getOnLoadHandler, getOnUnLoadHandler, setActiveHyperlinkColor, setBackgroundImage, setBGColor, setHyperLinkColor, setMarginBottom, setMarginHeight, setMarginLeft, setMarginRight, setMarginTop, setMarginWidth, setOnLoadHandler, setOnUnLoadHandler, setTextColor, setVisitedHyperLinkColor

Methods inherited from class org.pajes.html.Container

add, add, add, addContent, clear, clone, delete, delete, destroy, get, getContent, getContents, getPosition, insert, replace, set, setContent, setContent, size, writeContent

Methods inherited from class org.pajes.html.TraversableElement

dump, dump, getAll, getFieldByName, getFirstFieldByName, getFirstTagByAttribute, getFirstTagByClass, getFirstTagByID, getFirstTagByName, getTagByAttribute, getTagByClass, getTagByID, getTagByName, setWritable

Methods inherited from class org.pajes.html.Tag

addAttribute, addAttributes, addAttributes, clearAttribute, clearAttributes, getAttribute, getAttributes, getAttributeSet, getContainer, getDocument, getId, getOnClickHandler, getOnDBLClickHandler, getOnKeyDownHandler, getOnKeyPressHandler, getOnKeyUpHandler, getOnMouseDownHandler, getOnMouseOutHandler, getOnMouseOverHandler, getOnMouseUpHandler, getStyle, getStyleSheetClass, getTagName, getTitle, getWritePermission, init, initAttributes, isWritable, isWritable, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes, setContainer, setId, setOnClickHandler, setOnDBLClickHandler, setOnKeyDownHandler, setOnKeyPressHandler, setOnKeyUpHandler, setOnMouseDownHandler, setOnMouseOutHandler, setOnMouseOverHandler, setOnMouseUpHandler, setStyle, setStyleSheetClass, setTagName, setTitle, setWritable, setWriteAttributes, setWriteEndTag, setWritelnAfter, setWritelnAfterContent, setWritelnBefore, setWritelnBeforeContent, setWritePermission, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameSet

public FrameSet(java.lang.String rows,
                java.lang.String cols)

Create a frameset with the specified row and column layout.

Parameters:

rows - the comma-delimited string defining the size and number of rows in this frame set.

cols - the comma-delimited string defining the size and number of columns in this frame set.

Method Detail

setBorderColor

public FrameSet setBorderColor(Color borderColor)

Sets the colour of the frame borders.

Parameters:

borderColor - the colour of the frame borders.

Returns:

the modified FrameSet object.

setBorderVisibility

public FrameSet setBorderVisibility(boolean showFrameBorder)

Sets the visibility of the frame borders.

Parameters:

showFrameBorder - true displays the frame borders, and false hides them.

Returns:

the modified FrameSet object.

setBorderWidth

public FrameSet setBorderWidth(int borderWidth)

Sets the width of the frame borders.

Parameters:

borderWidth - the width of the border (in pixels) around each frame.

Returns:

the modified FrameSet object.

setColumnLayout

public FrameSet setColumnLayout(java.lang.String cols)

Sets the comma-delimited string defining the size and number of columns in this frame set.

Parameters:

cols - the comma-delimited string defining the size and number of columns in this frame set. Set to null if this frameset contains only rows.

Returns:

the modified FrameSet object.

setNoFramesText

public FrameSet setNoFramesText(java.lang.String text)

Deprecated. Add a NoFrames object instead.

Sets the text to be returned to browsers that cannot display frames.

Parameters:

text - the text to be returned to browsers that cannot display frames.

Returns:

the modified FrameSet object.

setRowLayout

public FrameSet setRowLayout(java.lang.String rows)

Sets the comma-delimited string defining the size and number of rows in this frame set.

Parameters:

rows - the comma-delimited string defining the size and number of rows in this frame set. Set to null if this frameset contains only columns.

Returns:

the modified FrameSet object.

add

public Container add(HTML frame)

Adds a frame element to the frameset.

Overrides:

add in class Container

Parameters:

frame - the frame to add.

Returns:

the modified Container object.

Throws:

TagException - if an attempt is made to add anything except a Frame, NoFrames or another frame set;

deleteFrame

public FrameSet deleteFrame(java.lang.String frameName)

Deletes the named frame from the frame set.

Parameters:

frameName - the named frame to remove from the frameset.

Returns:

the modified FrameSet object.