|
||||||||||
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
com.sun.webui.jsf.component.PageAlert
public class PageAlert
The PageAlert component displays a full page alert.
Field Summary | |
---|---|
static java.lang.String |
PAGEALERT_BUTTONS_FACET
|
static java.lang.String |
PAGEALERT_IMAGE_FACET
|
static java.lang.String |
PAGEALERT_INPUT_FACET
The facets... |
static java.lang.String |
PAGEALERT_SEPARATOR_FACET
|
static java.lang.String |
PAGEALERT_TITLE_FACET
|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
PageAlert()
Default constructor. |
Method Summary | |
---|---|
java.lang.String |
getAlt()
Alternative textual description of the image rendered by this component. |
java.lang.String |
getDetail()
Detailed message text for the alert. |
java.lang.String |
getFamily()
Return the family for this component. |
javax.faces.component.UIComponent |
getPageAlertButtons()
Get buttons for the Page Alert. |
javax.faces.component.UIComponent |
getPageAlertImage()
Return a component that implements a page alert image. |
javax.faces.component.UIComponent |
getPageAlertInput()
Get the page alert input facet. |
javax.faces.component.UIComponent |
getPageAlertSeparator()
Return a component that implements a page separator. |
javax.faces.component.UIComponent |
getPageAlertTitle()
Return a component that implements the page alert's title text. |
java.lang.String |
getSafeTitle()
|
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 |
getSummary()
Deprecated. Use the title attribute to display the message summary in the page title. |
int |
getTabIndex()
Position of this element in the tabbing order of the current document. |
java.lang.String |
getTitle()
The text to display as the page title |
java.lang.String |
getType()
The type or category of alert. |
boolean |
isEscape()
Flag indicating that the message text should be escaped so that it is not interpreted by the browser. |
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 textual description of the image rendered by this component. |
void |
setDetail(java.lang.String detail)
Detailed message text for the alert. |
void |
setEscape(boolean escape)
Flag indicating that the message text should be escaped so that it is not interpreted by the browser. |
void |
setId(java.lang.String id)
The component identifier for this component. |
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 |
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 |
setSummary(java.lang.String summary)
Deprecated. Use the title attribute to display the message summary in the page title. |
void |
setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. |
void |
setTitle(java.lang.String title)
The text to display as the page title |
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.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 |
Field Detail |
---|
public static final java.lang.String PAGEALERT_INPUT_FACET
public static final java.lang.String PAGEALERT_TITLE_FACET
public static final java.lang.String PAGEALERT_BUTTONS_FACET
public static final java.lang.String PAGEALERT_SEPARATOR_FACET
public static final java.lang.String PAGEALERT_IMAGE_FACET
Constructor Detail |
---|
public PageAlert()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public javax.faces.component.UIComponent getPageAlertInput()
public javax.faces.component.UIComponent getPageAlertTitle()
pageAlertTitle
is found
that component is returned.
If a facet is not found an StaticText
component instance is returned with the id
getId() + "_pageAlertTitle"
. The StaticText
instance is * intialized with the values from
getSafeTitle()
If a facet is not defined then the returned StaticText
component is created every time this method is called.
public javax.faces.component.UIComponent getPageAlertButtons()
public javax.faces.component.UIComponent getPageAlertSeparator()
pageAlertSeparator
is found
that component is returned.
If a facet is not found a PageSeparator
component instance is returned with the id
getId() + "_pageAlertSeparator"
.
If a facet is not defined then the returned PageSeparator
component is created every time this method is called.
public javax.faces.component.UIComponent getPageAlertImage()
pageAlertImage
is found
that component is returned.
If a facet is not found an Icon
component instance is returned with the id
getId() + "_pageAlertImage"
.
The Icon
instance returned is determined from the value
of getType()
. If the returned value is not a
recognized value, ThemeImages.ALERT_ERROR_LARGE
is
used. The Icon
instance is initialized with the value of
getAlt()
If a facet is not defined then the returned Icon
component is created every time this method is called.
public java.lang.String getSafeTitle()
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
public java.lang.String getAlt()
Alternative textual description of the image rendered by this component. The alt text can be used by screen readers and in tool tips, and when image display is turned off in the web browser.
public void setAlt(java.lang.String alt)
Alternative textual description of the image rendered by this component. The alt text can be used by screen readers and in tool tips, and when image display is turned off in the web browser.
getAlt()
public java.lang.String getDetail()
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)
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 boolean isEscape()
Flag indicating that the message text should be escaped so that it is not interpreted by the browser.
public void setEscape(boolean escape)
Flag indicating that the message text should be escaped so that it is not interpreted by the browser.
isEscape()
public java.lang.String getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public java.lang.String getSummary()
public void setSummary(java.lang.String summary)
getSummary()
public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex()
public java.lang.String getTitle()
The text to display as the page title
public void setTitle(java.lang.String title)
The text to display as the page title
getTitle()
public java.lang.String getType()
The type or category of alert. The type attribute can be set to one of the following: "question", "information", "warning" or "error". The default type is error.
public void setType(java.lang.String type)
The type or category of alert. The type attribute can be set to one of the following: "question", "information", "warning" or "error". The default type is 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.UIComponentBase
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.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |