|
||||||||||
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.AlertBase
public abstract class AlertBase
Use the ui:alert
tag to display an inline alert
message at the top of the rendered HTML page. Inline alert messages
permit users to correct problems or proceed with their work without
having to dismiss a window and navigate to a new location.
There 2 facets associated with an alert tag:
alertImage - allows the developer to put
in their own image and/or text
alertLink - allows the developer to put
in their own formatted link or extra text.
summary
message and an optional detail
message.
<ui:alert id="msg1"
type="information" summary="Patch Installed Successfully" detail="Patch
9997-01 was successfully installed on host alpha, beta and zed."
/>
<ui:alert id="msg2"
type="error" summary="Patch Installation Failed!"
detail="Patch 9997-01 was not installed on host alpha, beta and zed."
linkText="View Log" linkURL="/log/patch-log.txt" linkTarget="_blank"
linkToolTip="Open Window Containing Error Log"/>
Example
3: An example showing the use of an alertImage facet:<ui:alert id="msg2"
type="error" summary="Patch Installation Failed!"
detail="Patch 9997-01 was not installed on host alpha, beta and
zed.">
<f:facet name="alertImage">
<ui:image
id="foo"
url="../images/foo.gif"
/>
</f:facet>
</ui:alert>
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 | |
---|---|
AlertBase()
Construct a new AlertBase . |
Method Summary | |
---|---|
java.lang.String |
getAlt()
Alternative text description used by screen reader tools |
java.lang.String |
getDetail()
Optional detailed message text for the alert. |
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
javax.faces.el.MethodBinding |
getLinkAction()
Method binding representing a method that receives action from the embedded hyperlink component. |
java.lang.String |
getLinkTarget()
The window (target) in which to load the link that is specified with linkText. |
java.lang.String |
getLinkText()
The text for an optional link that is appended to the detail message. |
java.lang.String |
getLinkToolTip()
Sets the value of the title attribute for the HTML element. |
java.lang.String |
getLinkURL()
Absolute, relative, or context relative (starting with "/") URL to the resource to navigate to when the link that is specified with linkText is selected. |
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.String |
getSummary()
Summary message text for the alert. |
int |
getTabIndex()
The position of this component in the tabbing order sequence |
java.lang.String |
getType()
The type or category of alert. |
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 |
setAlt(java.lang.String alt)
Alternative text description used by screen reader tools |
void |
setDetail(java.lang.String detail)
Optional detailed message text for the alert. |
void |
setLinkAction(javax.faces.el.MethodBinding linkAction)
Method binding representing a method that receives action from the embedded hyperlink component. |
void |
setLinkTarget(java.lang.String linkTarget)
The window (target) in which to load the link that is specified with linkText. |
void |
setLinkText(java.lang.String linkText)
The text for an optional link that is appended to the detail message. |
void |
setLinkToolTip(java.lang.String linkToolTip)
Sets the value of the title attribute for the HTML element. |
void |
setLinkURL(java.lang.String linkURL)
Absolute, relative, or context relative (starting with "/") URL to the resource to navigate to when the link that is specified with linkText is selected. |
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 |
setSummary(java.lang.String summary)
Summary message text for the alert. |
void |
setTabIndex(int tabIndex)
The position of this component in the tabbing order sequence |
void |
setType(java.lang.String type)
The type or category of alert. |
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, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
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 |
---|
public AlertBase()
Construct a new AlertBase
.
Method Detail |
---|
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.
getFamily
in class javax.faces.component.UIOutput
public java.lang.String getAlt()
Alternative text description used by screen reader tools
public void setAlt(java.lang.String alt)
Alternative text description used by screen reader tools
getAlt()
public java.lang.String getDetail()
Optional detailed message text for the alert. This message might include more information about the alert and instructions for what to do about the alert.
public void setDetail(java.lang.String detail)
Optional detailed message text for the alert. This message might include more information about the alert and instructions for what to do about the alert.
getDetail()
public javax.faces.el.MethodBinding getLinkAction()
Method binding representing a method that receives action from the embedded hyperlink component.
public void setLinkAction(javax.faces.el.MethodBinding linkAction)
Method binding representing a method that receives action from the embedded hyperlink component.
getLinkAction()
public java.lang.String getLinkTarget()
The window (target) in which to load the link that is specified with linkText.
public void setLinkTarget(java.lang.String linkTarget)
The window (target) in which to load the link that is specified with linkText.
getLinkTarget()
public java.lang.String getLinkText()
The text for an optional link that is appended to the detail message.
public void setLinkText(java.lang.String linkText)
The text for an optional link that is appended to the detail message.
getLinkText()
public java.lang.String getLinkToolTip()
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 link that is specified with linkText.
public void setLinkToolTip(java.lang.String linkToolTip)
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 link that is specified with linkText.
getLinkToolTip()
public java.lang.String getLinkURL()
Absolute, relative, or context relative (starting with "/") URL to the resource to navigate to when the link that is specified with linkText is selected.
public void setLinkURL(java.lang.String linkURL)
Absolute, relative, or context relative (starting with "/") URL to the resource to navigate to when the link that is specified with linkText is selected.
getLinkURL()
public java.lang.String getStyle()
CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied when this component is rendered.
getStyleClass()
public java.lang.String getSummary()
Summary message text for the alert. This brief message is prominently displayed next to the icon.
public void setSummary(java.lang.String summary)
Summary message text for the alert. This brief message is prominently displayed next to the icon.
getSummary()
public int getTabIndex()
The position of this component in the tabbing order sequence
public void setTabIndex(int tabIndex)
The position of this component in the tabbing order sequence
getTabIndex()
public java.lang.String getType()
The type or category of alert. This type can be set to either "information", "success", "warning" or "error".
public void setType(java.lang.String type)
The type or category of alert. This type can be set to either "information", "success", "warning" or "error".
getType()
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.
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.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIOutput
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIOutput
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |