com.aspc.remote.html

Class HTMLIFrame

java.lang.Object

com.aspc.remote.html.HTMLComponent

com.aspc.remote.html.HTMLContainer

com.aspc.remote.html.HTMLIFrame

All Implemented Interfaces:

HandlesMouseEvents

public class HTMLIFrame
extends HTMLContainer
implements HandlesMouseEvents

HTMLDiv THREAD MODE: SINGLE-THREADED html generator component

Since:

14 December 2005

Author:

Jason McGrath

Field Summary

Fields inherited from class com.aspc.remote.html.HTMLComponent

alignment, alt, bgColor, cancelBubble, events, gMutableTheme, hasInitFocus, id, intStyleSheet, items, name, parent, styleId, styleProperty, tabIndex, toolTip, VALID_NAME_REGEX, VALID_STYLE_REGEX

Constructor Summary

Constructors

Constructor and Description
HTMLIFrame(java.lang.String href) create a division

Method Summary

Modifier and Type	Method and Description
void	addMouseEvent(HTMLMouseEvent me) Add a mouse event to this component.
protected void	compile(ClientBrowser browser) compile the IFRAME
boolean	getAutoFit() Specifies whether adjust the IFrame's size.
java.lang.String	getId() get the ID of this component
void	hideCounter()
protected void	iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer) generate the raw HTML for this component.
protected void	postCompile(ClientBrowser browser) This is the post compile if needed
void	setAutoFit(boolean _bAutoFit) Specifies whether adjust the IFrame's size.
void	setAutoRefresh(int seconds)
void	setBorderWidth(int width) Sets the FRAMEBORDER attribute which specifies whether or not a border should be drawn.
void	setHeight(java.lang.String h) The height of the in-line frame in pixels or as a percentage of available space
void	setId(java.lang.String id) set the ID of this component.
void	setMarginHeight(java.lang.String height) The height of the top and bottom margins within the in-line frame.
void	setMarginWidth(java.lang.String width) The width of the left and right margins within the in-line frame.
void	setScrolling(java.lang.String v) Specifies whether scrollbars are provided for the in-line frame.
void	setURL(java.lang.String href) Set the URL
void	setWidth(java.lang.String width) The width of the in line frame in pixels or as a percentage of available space

Methods inherited from class com.aspc.remote.html.HTMLContainer

addComponent, addComponent, addText, clear, findId, getComponent, getComponentCount, hasComponent, removeComponent, removeComponent

Methods inherited from class com.aspc.remote.html.HTMLComponent

addJavaScript, addJavaScript, addOnLoadScript, appendClassName, checkIsContainer, copyAttributes, doBuildToolTip, fetchStyleProperty, getClassName, getMutableTheme, getParent, getParentPage, getStyleSheet, getTheme, hasTheme, iAddComponent, iAddComponent, iAddedToPage, iAddEvent, iClear, iFindId, iGenerateAttributes, iGenerateAttributesID, iGenerateComponent, iGenerateComponent, iGenerateEvents, iGetComponent, iGetComponentCount, iHasEvent, iRemoveComponent, isCompiled, iSetId, iSetName, iSetStyleId, makeColorID, makeListOfEvents, monitorPage, resetParent, setAlignment, setAttribute, setClassName, setHasInitFocus, setParent, setStyleProperty, setTabIndex, touch

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLIFrame

public HTMLIFrame(java.lang.String href)

create a division

Parameters:

href - the URL

Method Detail

getId

@CheckReturnValue
 @Nullable
public java.lang.String getId()

get the ID of this component

Overrides:

getId in class HTMLComponent

Returns:

the ID

setId

public final void setId(java.lang.String id)

set the ID of this component.

Parameters:

id - The id of the component

setURL

public final void setURL(java.lang.String href)

Set the URL

Parameters:

href - the URL

addMouseEvent

public void addMouseEvent(HTMLMouseEvent me)

Add a mouse event to this component.

Specified by:

addMouseEvent in interface HandlesMouseEvents

Parameters:

me - The mouse event

setWidth

public void setWidth(java.lang.String width)

The width of the in line frame in pixels or as a percentage of available space

Parameters:

width - - width of in line frame

setHeight

public void setHeight(java.lang.String h)

The height of the in-line frame in pixels or as a percentage of available space

Parameters:

h - - height of in-line frame

setMarginWidth

public void setMarginWidth(java.lang.String width)

The width of the left and right margins within the in-line frame. The value must be greater than one pixel

Parameters:

width - - width of margin

setMarginHeight

public void setMarginHeight(java.lang.String height)

The height of the top and bottom margins within the in-line frame. The value must be greater than one pixel

Parameters:

height - - height of margin

setBorderWidth

public void setBorderWidth(int width)

Sets the FRAMEBORDER attribute which specifies whether or not a border should be drawn. The default value of 1 results in a border while a value of 0 suppresses the border

Parameters:

width - - width of border

setAutoRefresh

public void setAutoRefresh(int seconds)

Parameters:

seconds -

setAutoFit

public void setAutoFit(boolean _bAutoFit)

Specifies whether adjust the IFrame's size.

Parameters:

_bAutoFit - - true : adjustIframeSize() will be called .

getAutoFit

public boolean getAutoFit()

Specifies whether adjust the IFrame's size.

Returns:

boolean - true : adjustIframeSize() will be called .

setScrolling

public void setScrolling(java.lang.String v)

Specifies whether scrollbars are provided for the in-line frame. The default value, auto, generates scrollbars only when necessary. The value yes gives scrollbars at all times, and the value no suppresses scrollbars--even when they are needed to see all the content. The value no should never be used.

Parameters:

v - - auto/yes/no

hideCounter

public void hideCounter()

compile

protected void compile(ClientBrowser browser)

compile the IFRAME

Overrides:

compile in class HTMLComponent

Parameters:

browser - The browser to compile for

postCompile

protected void postCompile(ClientBrowser browser)

This is the post compile if needed

Overrides:

postCompile in class HTMLComponent

Parameters:

browser -

iGenerate

protected void iGenerate(ClientBrowser browser,
                         java.lang.StringBuilder buffer)

generate the raw HTML for this component.

Overrides:

iGenerate in class HTMLComponent

Parameters:

browser - The target browser

buffer - The generate HTML