org.pajes.html
Class Frame

java.lang.Object
  org.pajes.html.Tag
      org.pajes.html.Frame

All Implemented Interfaces:

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

public class Frame
extends Tag

Generates <frame> tags. Frame instances should be added to FrameSets.

See Also:

FrameSet, Serialized Form

Field Summary

Fields inherited from class org.pajes.html.Tag

ON_CLICK_ATTRIBUTE, TAG_CLOSE, TAG_LEFT, TAG_RIGHT

Constructor Summary

Frame()
Creates a frame.

Frame(java.lang.String frameName)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL, boolean showScrollBars)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL, boolean showScrollBars, boolean showFrameBorder, boolean nonReSizeableFrame)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL, boolean showScrollBars, boolean showFrameBorder, boolean nonReSizeableFrame, int marginHeight, int marginWidth)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL, Color borderColor)
Creates a frame.

Frame(java.lang.String frameName, java.lang.String sourceURL, Color borderColor, boolean nonReSizeableFrame)
Creates a frame.

Method Summary

java.lang.String	getName() Returns the name of this frame.
java.lang.String	getURL() Returns the URL to initially populate the frame.
protected void	setAttribute(TagAttribute attribute) Adds the specified attribute.
Frame	setBorder(boolean on) Determines whether the border will be shown.
Frame	setBorder(java.lang.Boolean on) Determines whether the border will be shown.
Frame	setBorderColor(Color color) Determines the border colour.
Frame	setMarginHeight(int height) Sets the frame top margin.
Frame	setMarginHeight(java.lang.Integer height) Sets the frame top margin.
Frame	setMarginWidth(int width) Sets the frame side margins.
Frame	setMarginWidth(java.lang.Integer width) Sets the frame side margins.
Frame	setName(java.lang.String name) Sets the name of this frame.
Frame	setNonResizableFrame(boolean on) Determines whether the user may resize the frame.
Frame	setNonResizableFrame(java.lang.Boolean on) Determines whether the user may resize the frame.
Frame	setScrollBars(boolean on) Determines whether the scroll bars will be shown.
Frame	setScrollBars(java.lang.Boolean on) Determines whether the scroll bars will be shown.
Frame	setURL(java.lang.String url) Sets the URL to initially populate the frame.
void	write(Browser browser) Writes the <frame%gt;tag to the browser.

Methods inherited from class org.pajes.html.Tag

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame()

Creates a frame.

Frame

public Frame(java.lang.String frameName)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL,
             boolean showScrollBars)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

showScrollBars - when true, scrollbars added to the frame eve if there is nothing to scroll.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL,
             boolean showScrollBars,
             boolean showFrameBorder,
             boolean nonReSizeableFrame)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

showScrollBars - when true, scrollbars added to the frame eve if there is nothing to scroll.

showFrameBorder - when true, the border will be shown. This over-rides the setting of the entire frame set for this frame.

nonReSizeableFrame - when true, the user may not resize the frame.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL,
             boolean showScrollBars,
             boolean showFrameBorder,
             boolean nonReSizeableFrame,
             int marginHeight,
             int marginWidth)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

showScrollBars - when true, scrollbars added to the frame even if there is nothing to scroll.

showFrameBorder - when true, the border will be shown. This over-rides the setting of the entire frame set for this frame.

nonReSizeableFrame - when true, the user may not resize the frame.

marginHeight - the number of pixels between the top and (when scrolled) bottom of the content and the inner edge of the frame.

marginWidth - the number of pixels between the left and right of the content and the inner edge of the frame.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL,
             Color borderColor)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

borderColor - specifies the colour of the border for this frame.

Frame

public Frame(java.lang.String frameName,
             java.lang.String sourceURL,
             Color borderColor,
             boolean nonReSizeableFrame)

Creates a frame.

Parameters:

frameName - adds the named frame to the frameset.

sourceURL - specifies the URL to initially populate the frame.

borderColor - specifies the colour of the border for this frame.

nonReSizeableFrame - when true, the user may not resize the frame.

Method Detail

getName

public java.lang.String getName()

Returns the name of this frame.

Returns:

the name of this frame.

getURL

public java.lang.String getURL()

Returns the URL to initially populate the frame.

Returns:

the source URL.

setBorder

public Frame setBorder(boolean on)

Determines whether the border will be shown.

Parameters:

on - when true, the border will be shown.

Returns:

the modified Frame object.

setBorder

public Frame setBorder(java.lang.Boolean on)

Determines whether the border will be shown.

Parameters:

on - when true, the border will be shown. If null, resets to the default browser setting.

Returns:

the modified Frame object.

setBorderColor

public Frame setBorderColor(Color color)

Determines the border colour.

Parameters:

color - specifies the colour of the border for this frame.

Returns:

the modified Frame object.

setMarginHeight

public Frame setMarginHeight(int height)

Sets the frame top margin.

Parameters:

height - the number of pixels between the top and (when scrolled) bottom of the content and the inner edge of the frame.

Returns:

the modified Frame object.

setMarginHeight

public Frame setMarginHeight(java.lang.Integer height)

Sets the frame top margin.

Parameters:

height - the number of pixels between the top and (when scrolled) bottom of the content and the inner edge of the frame. If null, resets to the default browser setting.

Returns:

the modified Frame object.

setMarginWidth

public Frame setMarginWidth(int width)

Sets the frame side margins.

Parameters:

width - the number of pixels between the left and right of the content and the inner edge of the frame.

Returns:

the modified Frame object.

setMarginWidth

public Frame setMarginWidth(java.lang.Integer width)

Sets the frame side margins.

Parameters:

width - the number of pixels between the left and right of the content and the inner edge of the frame. If null, resets to the default browser setting.

Returns:

the modified Frame object.

setName

public Frame setName(java.lang.String name)

Sets the name of this frame.

Parameters:

name - the name of the frame.

Returns:

the modified Frame object.

setNonResizableFrame

public Frame setNonResizableFrame(boolean on)

Determines whether the user may resize the frame.

Parameters:

on - when true, the user may not resize the frame.

Returns:

the modified Frame object.

setNonResizableFrame

public Frame setNonResizableFrame(java.lang.Boolean on)

Determines whether the user may resize the frame.

Parameters:

on - when true, the user may not resize the frame. If null, resets to the default browser setting.

Returns:

the modified Frame object.

setScrollBars

public Frame setScrollBars(boolean on)

Determines whether the scroll bars will be shown.

Parameters:

on - when true, scroll bars are added to the frame even if there is nothing to scroll.

Returns:

the modified Frame object.

setScrollBars

public Frame setScrollBars(java.lang.Boolean on)

Determines whether the scroll bars will be shown.

Parameters:

on - when true, scroll bars are added to the frame even if there is nothing to scroll. If null, resets to the default browser setting.

Returns:

the modified Frame object.

setURL

public Frame setURL(java.lang.String url)

Sets the URL to initially populate the frame.

Parameters:

url - specifies the URL to initially populate the frame.

Returns:

the modified Frame object.

write

public void write(Browser browser)
           throws java.io.IOException

Writes the <frame%gt;tag to the browser.

Specified by:

write in interface HTML

Overrides:

write in class Tag

Parameters:

browser - the browser to which the results are to be output.

Throws:

java.io.IOException - if an I/O error occurs writing to the browser.

See Also:

Tag.setWriteEndTag(boolean), Tag.writeContent(org.pajes.servlet.Browser)

setAttribute

protected void setAttribute(TagAttribute attribute)

Description copied from class: Tag

Adds the specified attribute.

Overrides:

setAttribute in class Tag

Parameters:

attribute - The attribute.

See Also:

Tag.setAttribute(org.pajes.html.TagAttribute)