com.sun.rave.web.ui.component
Class IFrameBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.sun.rave.web.ui.component.FrameBase
              com.sun.rave.web.ui.component.Frame
                  com.sun.rave.web.ui.component.IFrameBase

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

IFrame

public abstract class IFrameBase

extends Frame

Use the ui:iframe tag to create an inline frame in the rendered HTML page. The ui:iframe tag inserts a frame in which another web page can be displayed inside the web application page.

HTML Elements and Layout

The iframe component is rendered as an <iframe> XHTML element. The ui:iframe tag can be configured by using the tag's attributes, which map to the <iframe> properties and are similarly named.

Theme Identifiers

None.

Client Side Javascript Functions

None.

Example

Example 1: Using the ui:iframe tag appropriately in a JSP page:

<?xml version="1.0" encoding="UTF-8"?>
<jsp:root version="1.2" xmlns:f="http://java.sun.com/jsf/core" xmlns:h="http://java.sun.com/jsf/html" xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:ui="http://www.sun.com/web/ui">
<jsp:directive.page contentType="text/html;charset=ISO-8859-1" pageEncoding="UTF-8"/><f:view>
<ui:page frame="true">
<ui:html>
<ui:head title="blah" />
<ui:body>
<ui:staticText id="text1" text="Below is a frame within this page without a frameset" />
<ui:markup tag="br" singleton="true" />
<ui:iframe url="http://google.com" />
</ui:body>
</ui:html>
</ui:page>
</f:view>
</jsp:root>

Auto-generated component class. Do NOT modify; all changes will be lost!

Constructor Summary

IFrameBase()
Construct a new IFrameBase.

Method Summary

java.lang.String	getAlign() Specifies how to align the iframe according to the surrounding text.
java.lang.String	getFamily() Return the family for this component.
java.lang.String	getHeight() Defines the height of the iframe in pixels or as a percentage of it's container
java.lang.String	getWidth() Defines the width of the iframe in pixels or as a percentage of it's container
boolean	isNoResize() Set the value of the noResize attribute to "true" when user is not allowed to resize the frame.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.
void	setAlign(java.lang.String align) Specifies how to align the iframe according to the surrounding text.
void	setHeight(java.lang.String height) Defines the height of the iframe in pixels or as a percentage of it's container
void	setNoResize(boolean noResize) Set the value of the noResize attribute to "true" when user is not allowed to resize the frame.
void	setWidth(java.lang.String width) Defines the width of the iframe in pixels or as a percentage of it's container

Methods inherited from class com.sun.rave.web.ui.component.FrameBase

getLongDesc, getMarginHeight, getMarginWidth, getName, getScrolling, getStyle, getStyleClass, getToolTip, getUrl, isFrameBorder, setFrameBorder, setLongDesc, setMarginHeight, setMarginWidth, setName, setScrolling, setStyle, setStyleClass, setToolTip, setUrl

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

IFrameBase

public IFrameBase()

Construct a new IFrameBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:

getFamily in class FrameBase

getAlign

public java.lang.String getAlign()

Specifies how to align the iframe according to the surrounding text. One of the following: left, right, top, middle, bottom

setAlign

public void setAlign(java.lang.String align)

Specifies how to align the iframe according to the surrounding text. One of the following: left, right, top, middle, bottom

See Also:

getAlign()

getHeight

public java.lang.String getHeight()

Defines the height of the iframe in pixels or as a percentage of it's container

setHeight

public void setHeight(java.lang.String height)

Defines the height of the iframe in pixels or as a percentage of it's container

See Also:

getHeight()

isNoResize

public boolean isNoResize()

Set the value of the noResize attribute to "true" when user is not allowed to resize the frame.

Overrides:

isNoResize in class FrameBase

setNoResize

public void setNoResize(boolean noResize)

Set the value of the noResize attribute to "true" when user is not allowed to resize the frame.

Overrides:

setNoResize in class FrameBase

See Also:

isNoResize()

getWidth

public java.lang.String getWidth()

Defines the width of the iframe in pixels or as a percentage of it's container

setWidth

public void setWidth(java.lang.String width)

Defines the width of the iframe in pixels or as a percentage of it's container

See Also:

getWidth()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class FrameBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class FrameBase