com.sun.webui.jsf.component
Class FrameSet

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.FrameSet
All Implemented Interfaces:
javax.faces.component.StateHolder

public class FrameSet
extends javax.faces.component.UIComponentBase

The FrameSet component defines a set of frames.


Constructor Summary
FrameSet()
          Construct a new FrameSet.
 
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 to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getToolTip()
          Sets the value of the title attribute for the HTML element.
 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 setId(java.lang.String id)
          The component identifier for this component.
 void setRendered(boolean rendered)
          Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page.
 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 to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 void setToolTip(java.lang.String toolTip)
          Sets the value of the title attribute for the HTML element.
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FrameSet

public FrameSet()

Construct a new FrameSet.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public void setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

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 to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getToolTip

public java.lang.String getToolTip()

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.


setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.

See Also:
getToolTip()

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 javax.faces.component.UIComponentBase

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 javax.faces.component.UIComponentBase


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.