com.sun.webui.jsf.component
Class Frame

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.Frame
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
IFrame

public class Frame
extends javax.faces.component.UIComponentBase

The Frame component is used inside a FrameSet component to denote a frame.


Constructor Summary
Frame()
          Construct a new Frame.
 
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 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.
 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 setId(java.lang.String id)
          The component identifier for this component.
 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 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 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 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.
 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
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

Frame

public Frame()

Construct a new Frame.

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

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

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.

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.