Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended bycom.sun.rave.web.ui.component.FrameSetBase
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
FrameSet
public abstract class FrameSetBase
extends javax.faces.component.UIComponentBase

Use the ui:frameSet tag to define a new set of frames in the rendered HTML page.
When using ui:frameSet and ui:frame tags in your application, you must also set the ui:page tag's frame attribute to "true".

HTML Elements and Layout

The rendered HTML page contains an XHTML-compliant <frameset> element.

Theme Identifiers

What theme elements apply?

Client Side Javascript Functions

None. 

Examples

Example 1: Creating a frameset of two rows and two columns

<?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
FrameSetBase()
          Construct a new FrameSetBase.
 
Method Summary
 int getBorder()
          The width, in pixels, of the space around frames.
 java.lang.String getBorderColor()
          The bordercolor attribute allows you to set the color of the frame borders using a hex value or a color name.
 java.lang.String getCols()
          Defines the number and size of columns in a frameset.
 java.lang.String getFamily()
          Return the family for this component.
 int getFrameSpacing()
          The width, in pixels, of the space around frames.
 java.lang.String getRows()
          Defines the number and size of rows in a frameset.
 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
 boolean isFrameBorder()
          Flag indicating whether frames should have borders or not.
 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 setBorder(int border)
          The width, in pixels, of the space around frames.
 void setBorderColor(java.lang.String borderColor)
          The bordercolor attribute allows you to set the color of the frame borders using a hex value or a color name.
 void setCols(java.lang.String cols)
          Defines the number and size of columns in a frameset.
 void setFrameBorder(boolean frameBorder)
          Flag indicating whether frames should have borders or not.
 void setFrameSpacing(int frameSpacing)
          The width, in pixels, of the space around frames.
 void setRows(java.lang.String rows)
          Defines the number and size of rows in a frameset.
 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
 
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

FrameSetBase

public FrameSetBase()

Construct a new FrameSetBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getBorder

public int getBorder()

The width, in pixels, of the space around frames. The frameSpacing attribute and the border attribute set the same property in different browsers. Set frameSpacing and border to the same value.

setBorder

public void setBorder(int border)

The width, in pixels, of the space around frames. The frameSpacing attribute and the border attribute set the same property in different browsers. Set frameSpacing and border to the same value.

See Also:
getBorder()

getBorderColor

public java.lang.String getBorderColor()

The bordercolor attribute allows you to set the color of the frame borders using a hex value or a color name.

setBorderColor

public void setBorderColor(java.lang.String borderColor)

The bordercolor attribute allows you to set the color of the frame borders using a hex value or a color name.

See Also:
getBorderColor()

getCols

public java.lang.String getCols()

Defines the number and size of columns in a frameset. The size can be specified in pixels, percentage of the page width, or with an asterisk (*). Specifying * causes the columns to use available space. See the HTML specification for the frameset element for more details.

setCols

public void setCols(java.lang.String cols)

Defines the number and size of columns in a frameset. The size can be specified in pixels, percentage of the page width, or with an asterisk (*). Specifying * causes the columns to use available space. See the HTML specification for the frameset element for more details.

See Also:
getCols()

isFrameBorder

public boolean isFrameBorder()

Flag indicating whether frames should have borders or not. If frameBorder is true, decorative borders are drawn. If frameBorder is false, a space between frames shows up as the background color of the page. To show no border or space between frames, you should set frameBorder to false, and set frameSpacing and border to 0.

setFrameBorder

public void setFrameBorder(boolean frameBorder)

Flag indicating whether frames should have borders or not. If frameBorder is true, decorative borders are drawn. If frameBorder is false, a space between frames shows up as the background color of the page. To show no border or space between frames, you should set frameBorder to false, and set frameSpacing and border to 0.

See Also:
isFrameBorder()

getFrameSpacing

public int getFrameSpacing()

The width, in pixels, of the space around frames. The frameSpacing attribute and the border attribute set the same property in different browsers. Set frameSpacing and border to the same value.

setFrameSpacing

public void setFrameSpacing(int frameSpacing)

The width, in pixels, of the space around frames. The frameSpacing attribute and the border attribute set the same property in different browsers. Set frameSpacing and border to the same value.

See Also:
getFrameSpacing()

getRows

public java.lang.String getRows()

Defines the number and size of rows in a frameset. The size can be specified in pixels, percentage of the page length, or with an asterisk (*). Specifying * causes the rows to use available space. See the HTML specification for the frameset element for more details.

setRows

public void setRows(java.lang.String rows)

Defines the number and size of rows in a frameset. The size can be specified in pixels, percentage of the page length, or with an asterisk (*). Specifying * causes the rows to use available space. See the HTML specification for the frameset element for more details.

See Also:
getRows()

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()

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.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD