org.pajes.html
Class IFrame

java.lang.Object
  org.pajes.html.Tag
      org.pajes.html.TraversableElement
          org.pajes.html.Container
              org.pajes.html.IFrame

All Implemented Interfaces:

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

public class IFrame

extends Container

Generates <iframe> inline frame tags.

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

IFrame()
Creates an inline frame.

IFrame(java.lang.String frameName)
Creates an inline frame.

IFrame(java.lang.String frameName, java.lang.String sourceURL)
Creates an inline 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.
IFrame	setBorder(boolean on) Determines whether the border will be shown.
IFrame	setBorder(java.lang.Boolean on) Determines whether the border will be shown.
IFrame	setHeight(int height) Sets the frame height.
IFrame	setHeight(java.lang.Integer height) Sets the frame height.
IFrame	setHeight(java.lang.String height) Sets the frame height.
IFrame	setMarginHeight(int height) Sets the frame top margin.
IFrame	setMarginHeight(java.lang.Integer height) Sets the frame top margin.
IFrame	setMarginWidth(int width) Sets the frame side margins.
IFrame	setMarginWidth(java.lang.Integer width) Sets the frame side margins.
IFrame	setName(java.lang.String name) Sets the name of this frame.
IFrame	setScrollBars(boolean on) Determines whether the scroll bars will be shown.
IFrame	setScrollBars(java.lang.Boolean on) Determines whether the scroll bars will be shown.
IFrame	setURL(java.lang.String url) Sets the URL to initially populate the frame.
IFrame	setWidth(int width) Sets the frame width.
IFrame	setWidth(java.lang.Integer width) Sets the frame width.
IFrame	setWidth(java.lang.String width) Sets the frame width.
void	write(Browser browser) Writes the <iframe%gt;tag to the browser.

Methods inherited from class org.pajes.html.Container

add, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

IFrame

public IFrame()

Creates an inline frame.

IFrame

public IFrame(java.lang.String frameName)

Creates an inline frame.

Parameters:

frameName - the name of the frame.

IFrame

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

Creates an inline frame.

Parameters:

frameName - the name of the frame.

sourceURL - specifies the URL to initially populate the frame.

Method Detail

setBorder

public IFrame setBorder(boolean on)

Determines whether the border will be shown.

Parameters:

on - when true, the border will be shown.

Returns:

the modified IFrame object.

setBorder

public IFrame 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 IFrame object.

setHeight

public IFrame setHeight(int height)

Sets the frame height.

Parameters:

height - the height of the inline frame.

Returns:

the modified IFrame object.

setHeight

public IFrame setHeight(java.lang.Integer height)

Sets the frame height.

Parameters:

height - the height of the inline frame.

Returns:

the modified IFrame object.

setHeight

public IFrame setHeight(java.lang.String height)

Sets the frame height.

Parameters:

height - the height of the inline frame.

Returns:

the modified IFrame object.

setMarginHeight

public IFrame 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 IFrame object.

setMarginHeight

public IFrame 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 IFrame object.

setMarginWidth

public IFrame 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 IFrame object.

setMarginWidth

public IFrame 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 IFrame object.

setName

public IFrame setName(java.lang.String name)

Sets the name of this frame.

Parameters:

name - the name of the frame.

Returns:

the modified IFrame object.

getName

public java.lang.String getName()

Returns the name of this frame.

Returns:

the name of this frame.

setScrollBars

public IFrame 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 IFrame object.

setScrollBars

public IFrame 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 IFrame object.

setURL

public IFrame 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 IFrame object.

getURL

public java.lang.String getURL()

Returns the URL to initially populate the frame.

Returns:

the source URL.

setWidth

public IFrame setWidth(int width)

Sets the frame width.

Parameters:

width - the width of the inline frame.

Returns:

the modified IFrame object.

setWidth

public IFrame setWidth(java.lang.Integer width)

Sets the frame width.

Parameters:

width - the width of the inline frame.

Returns:

the modified IFrame object.

setWidth

public IFrame setWidth(java.lang.String width)

Sets the frame width.

Parameters:

width - the width of the inline frame.

Returns:

the modified IFrame object.

write

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

Writes the <iframe%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)