|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
com.sun.rave.web.ui.component.HelpInlineBase
public abstract class HelpInlineBase
Use the <ui:helpInline>
tag to display inline help.
<ui:helpInline>
tag inside of an XHTML compliant
<div>
element. An appropriate style class will be set for
the <div>
element based upon the helpInline type.
<ui:helpInline id="pageHelp" text="This is page inline help." />
<ui:helpInline id="fieldHelp" type="field" text="This is field inline help." />
<ui:helpInline id="pageHelp" type="field">
<f:verbatim>Enter a password. For more information about passwords </f:verbatim>
<ui:imageHyperlink icon="HREF_LINK" id="helpLink" text="click here" />
</ui:helpInline>
Auto-generated component class.
Do NOT modify; all changes
will be lost!
Field Summary
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY, COMPONENT_TYPE
Fields inherited from class javax.faces.component.UIComponent
bindings
Constructor Summary
HelpInlineBase()
Construct a new HelpInlineBase
.
Method Summary
java.lang.String
getFamily()
Return the identifier of the component family to which this
component belongs.
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.Object
getText()
The inline help text to display.
java.lang.String
getType()
The type of inline help - valid values are "page" or "field".
javax.faces.el.ValueBinding
getValueBinding(java.lang.String name)
Return the ValueBinding
stored for the
specified name (if any), respecting any property aliases.
boolean
isVisible()
Use the visible attribute 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
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
setText(java.lang.Object text)
The inline help text to display.
void
setType(java.lang.String type)
The type of inline help - valid values are "page" or "field".
void
setValueBinding(java.lang.String name,
javax.faces.el.ValueBinding binding)
Set the ValueBinding
stored for the
specified name (if any), respecting any property
aliases.
void
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page.
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter, setValue
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
HelpInlineBase
public HelpInlineBase()
Construct a new HelpInlineBase
.
Method Detail
getFamily
public java.lang.String getFamily()
Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType
property, may be used to select
the appropriate Renderer
for this component instance.
- Overrides:
getFamily
in class javax.faces.component.UIOutput
getValueBinding
public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)
Return the ValueBinding
stored for the
specified name (if any), respecting any property aliases.
- Overrides:
getValueBinding
in class javax.faces.component.UIComponentBase
- Parameters:
name
- Name of value binding to retrieve
setValueBinding
public void setValueBinding(java.lang.String name,
javax.faces.el.ValueBinding binding)
Set the ValueBinding
stored for the
specified name (if any), respecting any property
aliases.
- Overrides:
setValueBinding
in class javax.faces.component.UIComponentBase
- Parameters:
name
- Name of value binding to setbinding
- ValueBinding to set, or null to remove
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()
getText
public java.lang.Object getText()
The inline help text to display.
setText
public void setText(java.lang.Object text)
The inline help text to display.
- See Also:
getText()
getType
public java.lang.String getType()
The type of inline help - valid values are "page" or "field". Note that
"page" is the default.
setType
public void setType(java.lang.String type)
The type of inline help - valid values are "page" or "field". Note that
"page" is the default.
- See Also:
getType()
isVisible
public boolean isVisible()
Use the visible attribute 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 true, so
HTML for the component HTML is included and 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 the visible attribute 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 true, so
HTML for the component HTML is included and 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()
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
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD