| com.sun.rave.web.ui.component.HelpInlineBase
All known Subclasses: com.sun.rave.web.ui.component.HelpInline,
| HelpInlineBase | | abstract public class HelpInlineBase extends javax.faces.component.UIOutput (Code) | | Use the <ui:helpInline> tag to display inline help.
HTML Elements and Layout
The rendered HTML page displays the body content of the
<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.
Client Side Javascript Functions
None.
Examples
Example 1: Render page help
<ui:helpInline id="pageHelp" text="This is page inline help." />
Example 2: Render field help
<ui:helpInline id="fieldHelp" type="field" text="This is field inline help." />
Example 3: Render inline help with an embedded link
<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!
|
| HelpInlineBase | | public HelpInlineBase()(Code) | | Construct a new HelpInlineBase.
|
| getFamily | | public String getFamily()(Code) | | 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.
|
| getStyle | | public String getStyle()(Code) | | CSS style(s) to be applied when this component is rendered.
|
| getStyleClass | | public String getStyleClass()(Code) | | CSS style class(es) to be applied when this component is rendered.
|
| getText | | public Object getText()(Code) | | The inline help text to display.
|
| getType | | public String getType()(Code) | | The type of inline help - valid values are "page" or "field". Note that
"page" is the default.
|
| getValueBinding | | public ValueBinding getValueBinding(String name)(Code) | | Return the ValueBinding stored for the
specified name (if any), respecting any property aliases.
Parameters:
name - Name of value binding to retrieve |
| isVisible | | public boolean isVisible()(Code) | | 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.
|
| restoreState | | public void restoreState(FacesContext _context, Object _state)(Code) | | Restore the state of this component.
|
| saveState | | public Object saveState(FacesContext _context)(Code) | | Save the state of this component.
|
| setValueBinding | | public void setValueBinding(String name, ValueBinding binding)(Code) | | Set the ValueBinding stored for the
specified name (if any), respecting any property
aliases.
Parameters:
name - Name of value binding to set
Parameters:
binding - ValueBinding to set, or null to remove |
| setVisible | | public void setVisible(boolean visible)(Code) | | 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: HelpInlineBase.isVisible() |
|
|