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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

Frame

public abstract class FrameBase

extends javax.faces.component.UIComponentBase

Use the ui:frame tag inside a ui:frameSet tag to denote a new XHTML frame.

HTML Elements and Layout

If you use a ui:frame and ui:frameSet tags you should set the ui:page tag's frame attribute to "true".

This tag renders an xhtml compliant <frame> tag.

Client Side Javascript Functions

None.

Example

Example 1: Using the ui:frame 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:frameSet rows="10%,*" cols="10%,*" style="color:blue" styleClass="blue" toolTip="blah">
<ui:frame toolTip="blah" url="../faces/hyperlink/hyperlink.jsp" frameBorder="true" noResize="false"/>
<ui:frame toolTip="blah1" url="../faces/hyperlink/nextpage.jsp" frameBorder="true" noResize="false"/>

<ui:frame toolTip="blah2" url="http://www.google.com" frameBorder="true" noResize="false"/>
<ui:frame toolTip="blah3" url="http://www.yahoo.com" frameBorder="true" noResize="false"/>
</ui:frameSet>
</ui:html>
</ui:page>
</f:view>
</jsp:root>


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

Constructor Summary

FrameBase()
Construct a new FrameBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
java.lang.String	getLongDesc() A URL to a long description of the frame contents.
int	getMarginHeight() Defines the top and bottom margins in the frame
int	getMarginWidth() Defines the left and right margins in the frame
java.lang.String	getName() Defines a unique name for the frame (to use in scripts)
java.lang.String	getScrolling() Determines scrollbar action (valid values are: yes, no, auto)
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
java.lang.String	getToolTip() Display the text as a tooltip for this component
java.lang.String	getUrl() Defines the URL of the file to show in the frame.
boolean	isFrameBorder() Set the value of the frameBorder attribute to "true" when a border is needed around the frame.
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	setFrameBorder(boolean frameBorder) Set the value of the frameBorder attribute to "true" when a border is needed around the frame.
void	setLongDesc(java.lang.String longDesc) A URL to a long description of the frame contents.
void	setMarginHeight(int marginHeight) Defines the top and bottom margins in the frame
void	setMarginWidth(int marginWidth) Defines the left and right margins in the frame
void	setName(java.lang.String name) Defines a unique name for the frame (to use in scripts)
void	setNoResize(boolean noResize) Set the value of the noResize attribute to "true" when user is not allowed to resize the frame.
void	setScrolling(java.lang.String scrolling) Determines scrollbar action (valid values are: yes, no, auto)
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setToolTip(java.lang.String toolTip) Display the text as a tooltip for this component
void	setUrl(java.lang.String url) Defines the URL of the file to show in the frame.

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

FrameBase

public FrameBase()

Construct a new FrameBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

isFrameBorder

public boolean isFrameBorder()

Set the value of the frameBorder attribute to "true" when a border is needed around the frame.

setFrameBorder

public void setFrameBorder(boolean frameBorder)

Set the value of the frameBorder attribute to "true" when a border is needed around the frame.

See Also:

isFrameBorder()

getLongDesc

public java.lang.String getLongDesc()

A URL to a long description of the frame contents. Use it for browsers that do not support frames

setLongDesc

public void setLongDesc(java.lang.String longDesc)

A URL to a long description of the frame contents. Use it for browsers that do not support frames

See Also:

getLongDesc()

getMarginHeight

public int getMarginHeight()

Defines the top and bottom margins in the frame

setMarginHeight

public void setMarginHeight(int marginHeight)

Defines the top and bottom margins in the frame

See Also:

getMarginHeight()

getMarginWidth

public int getMarginWidth()

Defines the left and right margins in the frame

setMarginWidth

public void setMarginWidth(int marginWidth)

Defines the left and right margins in the frame

See Also:

getMarginWidth()

getName

public java.lang.String getName()

Defines a unique name for the frame (to use in scripts)

setName

public void setName(java.lang.String name)

Defines a unique name for the frame (to use in scripts)

See Also:

getName()

isNoResize

public boolean isNoResize()

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

setNoResize

public void setNoResize(boolean noResize)

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

See Also:

isNoResize()

getScrolling

public java.lang.String getScrolling()

Determines scrollbar action (valid values are: yes, no, auto)

setScrolling

public void setScrolling(java.lang.String scrolling)

Determines scrollbar action (valid values are: yes, no, auto)

See Also:

getScrolling()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getToolTip

public java.lang.String getToolTip()

Display the text as a tooltip for this component

setToolTip

public void setToolTip(java.lang.String toolTip)

Display the text as a tooltip for this component

See Also:

getToolTip()

getUrl

public java.lang.String getUrl()

Defines the URL of the file to show in the frame.

setUrl

public void setUrl(java.lang.String url)

Defines the URL of the file to show in the frame.

See Also:

getUrl()

restoreState

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

Restore the state of this component.

saveState

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

Save the state of this component.