com.sun.webui.jsf.component
Class Bubble

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by com.sun.webui.jsf.component.WebuiOutput
                  extended by com.sun.webui.jsf.component.Bubble
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class Bubble
extends WebuiOutput

The Bubble component is used to create a popup help window.


Field Summary
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
Bubble()
          Creates a new instance of Bubble
 
Method Summary
 javax.faces.convert.Converter getConverter()
           
 int getDuration()
          Number of milli-seconds after which pop-up help window should close.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getFocusId()
          focusId is use to set the focus to the one of the elements inside bubble.
 java.lang.String getHtmlTemplate()
          Get alternative HTML template to be used by this component.
 int getOpenDelay()
          Use to put a delay in ms before opening the bubble.
 java.lang.String getRendererType()
           
 java.lang.String getStyle()
          CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 int getTabIndex()
          This tabIndex value is used for making bubble component accessible.
 java.lang.String getTitle()
          Title for the pop-up help window.
 java.lang.Object getValue()
           
 int getWidth()
          Number of pixels for the width of the bubble help window.
 boolean isAutoClose()
          Use to close the bubble help automatically
 boolean isCloseButton()
          Use to display close button for bubble.
 boolean isVisible()
          Use to indicate whether the component should be viewable by the user in the rendered HTML page.
 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 setAutoClose(boolean autoClose)
          Use to close the bubble help automatically
 void setCloseButton(boolean closeButton)
          Use to display close button for bubble.
 void setDuration(int duration)
          Number of milli-seconds after which pop-up help window should close.
 void setFocusId(java.lang.String focusId)
          focusId is use to set the focus to the one of the elements inside bubble.
 void setHtmlTemplate(java.lang.String htmlTemplate)
          Set alternative HTML template to be used by this component.
 void setOpenDelay(int openDelay)
          Use to put a delay in ms before opening the bubble.
 void setStyle(java.lang.String style)
          CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 void setTabIndex(int tabIndex)
          This tabIndex value is used for making bubble component accessible.
 void setTitle(java.lang.String title)
          Title for the bubble help window.
 void setVisible(boolean visible)
          Use to indicate whether the component should be viewable by the user in the rendered HTML page.
 void setWidth(int width)
          Number of pixels for the width of the popup help window.
 
Methods inherited from class com.sun.webui.jsf.component.WebuiOutput
processDecodes, processUpdates, processValidators, setConverter, setId, setRendered
 
Methods inherited from class javax.faces.component.UIOutput
getLocalValue, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, 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

Bubble

public Bubble()
Creates a new instance of Bubble

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class javax.faces.component.UIOutput

getRendererType

public java.lang.String getRendererType()
Overrides:
getRendererType in class javax.faces.component.UIComponentBase

getHtmlTemplate

public java.lang.String getHtmlTemplate()
Get alternative HTML template to be used by this component.


setHtmlTemplate

public void setHtmlTemplate(java.lang.String htmlTemplate)
Set alternative HTML template to be used by this component.


getValue

public java.lang.Object getValue()
Specified by:
getValue in interface javax.faces.component.ValueHolder
Overrides:
getValue in class javax.faces.component.UIOutput

getConverter

public javax.faces.convert.Converter getConverter()
Specified by:
getConverter in interface javax.faces.component.ValueHolder
Overrides:
getConverter in class javax.faces.component.UIOutput

getStyle

public java.lang.String getStyle()

CSS style or styles to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style or styles 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 or classes to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class or classes to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

isVisible

public boolean isVisible()

Use to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to false, so HTML for the component HTML is included and not visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.


setVisible

public void setVisible(boolean visible)

Use to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to false, so HTML for the component HTML is included and not visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

See Also:
isVisible()

isAutoClose

public boolean isAutoClose()

Use to close the bubble help automatically


setAutoClose

public void setAutoClose(boolean autoClose)

Use to close the bubble help automatically

See Also:
isVisible()

isCloseButton

public boolean isCloseButton()

Use to display close button for bubble.


setCloseButton

public void setCloseButton(boolean closeButton)

Use to display close button for bubble.

See Also:
isVisible()

getOpenDelay

public int getOpenDelay()

Use to put a delay in ms before opening the bubble.


setOpenDelay

public void setOpenDelay(int openDelay)

Use to put a delay in ms before opening the bubble.


getWidth

public int getWidth()

Number of pixels for the width of the bubble help window.


setWidth

public void setWidth(int width)

Number of pixels for the width of the popup help window.

See Also:
getWidth()

getDuration

public int getDuration()

Number of milli-seconds after which pop-up help window should close. The default is 2000 milliseconds.


setDuration

public void setDuration(int duration)

Number of milli-seconds after which pop-up help window should close. The default is 2000 milliseconds.

See Also:
getDuration()

getTitle

public java.lang.String getTitle()

Title for the pop-up help window.


setTitle

public void setTitle(java.lang.String title)

Title for the bubble help window.

See Also:
getTitle()

getFocusId

public java.lang.String getFocusId()

focusId is use to set the focus to the one of the elements inside bubble. By default focus is set to bubble header.


setFocusId

public void setFocusId(java.lang.String focusId)

focusId is use to set the focus to the one of the elements inside bubble. By default focus is set to bubble header.

See Also:
getFocusId()

getTabIndex

public int getTabIndex()

This tabIndex value is used for making bubble component accessible. The value must be one higher than the last tabIndex value provided to the bubble body element.


setTabIndex

public void setTabIndex(int tabIndex)

This tabIndex value is used for making bubble component accessible. The value must be one higher than the last tabIndex value provided to the bubble body element.


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.UIOutput

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.UIOutput


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