com.sun.webui.jsf.component
Class PageAlert

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.PageAlert
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class PageAlert
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer

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

PAGEALERT_INPUT_FACET

public static final java.lang.String PAGEALERT_INPUT_FACET
The facets...

See Also:
Constant Field Values

PAGEALERT_TITLE_FACET

public static final java.lang.String PAGEALERT_TITLE_FACET
See Also:
Constant Field Values

PAGEALERT_BUTTONS_FACET

public static final java.lang.String PAGEALERT_BUTTONS_FACET
See Also:
Constant Field Values

PAGEALERT_SEPARATOR_FACET

public static final java.lang.String PAGEALERT_SEPARATOR_FACET
See Also:
Constant Field Values

PAGEALERT_IMAGE_FACET

public static final java.lang.String PAGEALERT_IMAGE_FACET
See Also:
Constant Field Values
Constructor Detail

PageAlert

public PageAlert()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

getPageAlertInput

public javax.faces.component.UIComponent getPageAlertInput()
Get the page alert input facet.

Returns:
A Back button (or a facet with buttons).

getPageAlertTitle

public javax.faces.component.UIComponent getPageAlertTitle()
Return a component that implements the page alert's title text. If a facet named 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

If a facet is not defined then the returned StaticText component is created every time this method is called.

Returns:
- pageAlertTitle facet or a StaticText instance

getPageAlertButtons

public javax.faces.component.UIComponent getPageAlertButtons()
Get buttons for the Page Alert. Return a set of buttons if they were sepecifed in tha facet

Returns:
A Back button (or a facet with buttons).

getPageAlertSeparator

public javax.faces.component.UIComponent getPageAlertSeparator()
Return a component that implements a page separator. If a facet named 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.

Returns:
- pageAlertSeparator facet or a PageSeparator instance

getPageAlertImage

public javax.faces.component.UIComponent getPageAlertImage()
Return a component that implements a page alert image. If a facet named 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.

Returns:
- pageAlertImage facet or an Icon instance

getSafeTitle

public java.lang.String getSafeTitle()

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public 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. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

getAlt

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.


setAlt

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.

See Also:
getAlt()

getDetail

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.


setDetail

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.

See Also:
getDetail()

isEscape

public boolean isEscape()

Flag indicating that the message text should be escaped so that it is not interpreted by the browser.


setEscape

public void setEscape(boolean escape)

Flag indicating that the message text should be escaped so that it is not interpreted by the browser.

See Also:
isEscape()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) 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(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getSummary

public java.lang.String getSummary()
Deprecated.
Use the title attribute to display the message summary in the page title.


setSummary

public void setSummary(java.lang.String summary)
Deprecated.
Use the title attribute to display the message summary in the page title.

See Also:
getSummary()

getTabIndex

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.


setTabIndex

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.

See Also:
getTabIndex()

getTitle

public java.lang.String getTitle()

The text to display as the page title


setTitle

public void setTitle(java.lang.String title)

The text to display as the page title

See Also:
getTitle()

getType

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.


setType

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.

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

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


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