com.sun.rave.web.ui.component
Class Alert

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by com.sun.rave.web.ui.component.AlertBase
                  extended by com.sun.rave.web.ui.component.Alert
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class Alert
extends AlertBase

The inline Alert component.


Field Summary
static java.lang.String ALERT_IMAGE_FACET
          String for the appended id of the facet name for image
static java.lang.String ALERT_LINK_FACET
          String for the appended id of the facet name for the link
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY, COMPONENT_TYPE
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
Alert()
           
 
Method Summary
 javax.faces.component.UIComponent getAlertIcon()
          Gets the alert icon facet for this component.
 javax.faces.component.UIComponent getAlertLink()
          Gets the alert hyperlink facet for this component.
 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.
 
Methods inherited from class com.sun.rave.web.ui.component.AlertBase
getAlt, getDetail, getFamily, getLinkAction, getLinkTarget, getLinkText, getLinkToolTip, getLinkURL, getStyle, getStyleClass, getSummary, getTabIndex, getType, isVisible, restoreState, saveState, setAlt, setDetail, setStyle, setStyleClass, setSummary, setTabIndex, setType, setVisible
 
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
 

Field Detail

ALERT_IMAGE_FACET

public static final java.lang.String ALERT_IMAGE_FACET
String for the appended id of the facet name for image

See Also:
Constant Field Values

ALERT_LINK_FACET

public static final java.lang.String ALERT_LINK_FACET
String for the appended id of the facet name for the link

See Also:
Constant Field Values
Constructor Detail

Alert

public Alert()
Method Detail

getAlertIcon

public javax.faces.component.UIComponent getAlertIcon()
Gets the alert icon facet for this component. If none exists it will create one with the appropriate type. The default is a warning icon.

Returns:
always returns an icon component, will return a facet if it exists or a newly created one if it doesn't

getAlertLink

public javax.faces.component.UIComponent getAlertLink()
Gets the alert hyperlink facet for this component. If none exists it will create one with the appropriate type. The default is a warning icon. If the facet id is the internal facet id, it will update the links and text If the facet id is any other id then this component will just return the facet

Returns:
always returns a Hyperlink component, will return a facet if it exists or a newly created one if it doesn't

setLinkURL

public void setLinkURL(java.lang.String linkURL)
Description copied from class: AlertBase

Absolute, relative, or context relative (starting with "/") URL to the resource to navigate to when the link that is specified with linkText is selected.

Overrides:
setLinkURL in class AlertBase
See Also:
AlertBase.getLinkURL()

setLinkToolTip

public void setLinkToolTip(java.lang.String linkToolTip)
Description copied from class: AlertBase

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.

Overrides:
setLinkToolTip in class AlertBase
See Also:
AlertBase.getLinkToolTip()

setLinkText

public void setLinkText(java.lang.String linkText)
Description copied from class: AlertBase

The text for an optional link that is appended to the detail message.

Overrides:
setLinkText in class AlertBase
See Also:
AlertBase.getLinkText()

setLinkTarget

public void setLinkTarget(java.lang.String linkTarget)
Description copied from class: AlertBase

The window (target) in which to load the link that is specified with linkText.

Overrides:
setLinkTarget in class AlertBase
See Also:
AlertBase.getLinkTarget()

setLinkAction

public void setLinkAction(javax.faces.el.MethodBinding linkAction)
Description copied from class: AlertBase

Method binding representing a method that receives action from the embedded hyperlink component.

Overrides:
setLinkAction in class AlertBase
See Also:
AlertBase.getLinkAction()