com.sun.webui.jsf.component
Class Masthead

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.webui.jsf.component.Masthead
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class Masthead
extends javax.faces.component.UIOutput
implements javax.faces.component.NamingContainer

The Masthead component displays a masthead or page banner at the top of the page.


Field Summary
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY, COMPONENT_TYPE
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
Masthead()
          Default constructor.
 
Method Summary
 int[] getAlarmCounts()
          A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of integers that specify the down, critical, major, and minor alarm counts.
 java.lang.String getBrandImageDescription()
          The description to use for the Brand Image, used as alt text for the image.
 int getBrandImageHeight()
          The height to use for the Brand Image, in pixels.
 java.lang.String getBrandImageURL()
          The url to the image file to use as the Brand Image.
 int getBrandImageWidth()
          The width to use for the Brand Image, in pixels.
 javax.faces.convert.Converter getConverter()
           
 java.lang.String getFamily()
          Return the family for this component.
 int getJobCount()
          The number of currently executing jobs or tasks.
 javax.faces.component.UIComponent getJobCountLink()
           Get the masthead jobcount hyperlink
 java.lang.String getNotificationMsg()
          Text to display for the notification info in the status area
 java.lang.String getProductImageDescription()
          The description for the product name image, used as alt text for the image.
 int getProductImageHeight()
          The height to use for the Product Name Image, in pixels.
 java.lang.String getProductImageURL()
          The url to the image file to use for the Product Name Image.
 int getProductImageWidth()
          The width to use for the Product Name Image, in pixels.
 java.lang.String getRoleInfo()
          Getter method to get Role information, such as the name of the role who is running the application.
 java.lang.String getRoleInfoLabel()
          The label text to display for the current Role information.
 java.lang.String getServerInfo()
          Text to display for the current Server information, such as the name of the server whose data is being displayed.
 java.lang.String getServerInfoLabel()
          The label text to display for the current Server information.
 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 getUserInfo()
          Text to display for the current User information, such as the name of the user who is running the application.
 java.lang.String getUserInfoLabel()
          The label text to display for the current User information.
 Hyperlink[] getUtilities()
          A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of one or more custom Hyperlink components to display in the utility bar.
 java.lang.Object getValue()
           
 boolean isDateTime()
          Set to true to display a date and time stamp in the status area.
 boolean isSecondary()
          Set to true to indicate that the masthead is to be used in a secondary/popup window.
 boolean isVisible()
          Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void processValidators(javax.faces.context.FacesContext context)
           
 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 setAlarmCounts(int[] alarmCounts)
          A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of integers that specify the down, critical, major, and minor alarm counts.
 void setBrandImageDescription(java.lang.String brandImageDescription)
          The description to use for the Brand Image, used as alt text for the image.
 void setBrandImageHeight(int brandImageHeight)
          The height to use for the Brand Image, in pixels.
 void setBrandImageURL(java.lang.String brandImageURL)
          The url to the image file to use as the Brand Image.
 void setBrandImageWidth(int brandImageWidth)
          The width to use for the Brand Image, in pixels.
 void setDateTime(boolean dateTime)
          Set to true to display a date and time stamp in the status area.
 void setId(java.lang.String id)
          The component identifier for this component.
 void setJobCount(int jobCount)
          The number of currently executing jobs or tasks.
 void setNotificationMsg(java.lang.String notificationMsg)
          Text to display for the notification info in the status area
 void setProductImageDescription(java.lang.String productImageDescription)
          The description for the product name Image, used as alt text for the image.
 void setProductImageHeight(int productImageHeight)
          The height to use for the Product Name Image, in pixels.
 void setProductImageURL(java.lang.String productImageURL)
          The url to the image file to use for the Product Name Image.
 void setProductImageWidth(int productImageWidth)
          The width to use for the Product Name Image, in pixels.
 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 setRoleInfo(java.lang.String roleInfo)
          Set the current Role information, such as the name of the role who is running the application.
 void setRoleInfoLabel(java.lang.String roleInfoLabel)
          The label text to display for the current Role information.
 void setSecondary(boolean secondary)
          Set to true to indicate that the masthead is to be used in a secondary/popup window.
 void setServerInfo(java.lang.String serverInfo)
          Text to display for the current Server information, such as the name of the server whose data is being displayed.
 void setServerInfoLabel(java.lang.String serverInfoLabel)
          The label text to display for the current Server information.
 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 setUserInfo(java.lang.String userInfo)
          Text to display for the current User information, such as the name of the user who is running the application.
 void setUserInfoLabel(java.lang.String userInfoLabel)
          The label text to display for the current User information.
 void setUtilities(Hyperlink[] utilities)
          A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of one or more custom Hyperlink components to display in the utility bar.
 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
getLocalValue, setConverter, setValue
 
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, processRestoreState, processSaveState, 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
 

Constructor Detail

Masthead

public Masthead()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class javax.faces.component.UIOutput

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

getConverter

public javax.faces.convert.Converter getConverter()
Specified by:
getConverter in interface javax.faces.component.ValueHolder
Overrides:
getConverter in class javax.faces.component.UIOutput

getValue

public java.lang.Object getValue()
Specified by:
getValue in interface javax.faces.component.ValueHolder
Overrides:
getValue in class javax.faces.component.UIOutput

getAlarmCounts

public int[] getAlarmCounts()

A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of integers that specify the down, critical, major, and minor alarm counts.


setAlarmCounts

public void setAlarmCounts(int[] alarmCounts)

A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of integers that specify the down, critical, major, and minor alarm counts.

See Also:
getAlarmCounts()

getBrandImageDescription

public java.lang.String getBrandImageDescription()

The description to use for the Brand Image, used as alt text for the image.


setBrandImageDescription

public void setBrandImageDescription(java.lang.String brandImageDescription)

The description to use for the Brand Image, used as alt text for the image.

See Also:
getBrandImageDescription()

getBrandImageHeight

public int getBrandImageHeight()

The height to use for the Brand Image, in pixels. Use this attribute along with the brandImageWidth attribute to specify dimensions of PNG images for use in Internet Explorer.


setBrandImageHeight

public void setBrandImageHeight(int brandImageHeight)

The height to use for the Brand Image, in pixels. Use this attribute along with the brandImageWidth attribute to specify dimensions of PNG images for use in Internet Explorer.

See Also:
getBrandImageHeight()

getBrandImageURL

public java.lang.String getBrandImageURL()

The url to the image file to use as the Brand Image. Use this attribute to override the brand image that is set in the theme.


setBrandImageURL

public void setBrandImageURL(java.lang.String brandImageURL)

The url to the image file to use as the Brand Image. Use this attribute to override the brand image that is set in the theme.

See Also:
getBrandImageURL()

getBrandImageWidth

public int getBrandImageWidth()

The width to use for the Brand Image, in pixels. Use this attribute when specifying the brandImageURL, along with the brandImageHeight attribute, to specify dimensions of PNG images for use in Internet Explorer.


setBrandImageWidth

public void setBrandImageWidth(int brandImageWidth)

The width to use for the Brand Image, in pixels. Use this attribute when specifying the brandImageURL, along with the brandImageHeight attribute, to specify dimensions of PNG images for use in Internet Explorer.

See Also:
getBrandImageWidth()

isDateTime

public boolean isDateTime()

Set to true to display a date and time stamp in the status area.


setDateTime

public void setDateTime(boolean dateTime)

Set to true to display a date and time stamp in the status area.

See Also:
isDateTime()

getJobCount

public int getJobCount()

The number of currently executing jobs or tasks. A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an integer.


setJobCount

public void setJobCount(int jobCount)

The number of currently executing jobs or tasks. A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an integer.

See Also:
getJobCount()

getNotificationMsg

public java.lang.String getNotificationMsg()

Text to display for the notification info in the status area


setNotificationMsg

public void setNotificationMsg(java.lang.String notificationMsg)

Text to display for the notification info in the status area

See Also:
getNotificationMsg()

getProductImageDescription

public java.lang.String getProductImageDescription()

The description for the product name image, used as alt text for the image.


setProductImageDescription

public void setProductImageDescription(java.lang.String productImageDescription)

The description for the product name Image, used as alt text for the image.

See Also:
getProductImageDescription()

getProductImageHeight

public int getProductImageHeight()

The height to use for the Product Name Image, in pixels. For mastheads that are used in secondary windows, you might need to specify the productImageHeight and productImageWidth for correct display on Internet Explorer.


setProductImageHeight

public void setProductImageHeight(int productImageHeight)

The height to use for the Product Name Image, in pixels. For mastheads that are used in secondary windows, you might need to specify the productImageHeight and productImageWidth for correct display on Internet Explorer.

See Also:
getProductImageHeight()

getProductImageURL

public java.lang.String getProductImageURL()

The url to the image file to use for the Product Name Image.


setProductImageURL

public void setProductImageURL(java.lang.String productImageURL)

The url to the image file to use for the Product Name Image.

See Also:
getProductImageURL()

getProductImageWidth

public int getProductImageWidth()

The width to use for the Product Name Image, in pixels. For mastheads that are used in secondary windows, you might need to specify the productImageHeight and productImageWidth for correct display on Internet Explorer.


setProductImageWidth

public void setProductImageWidth(int productImageWidth)

The width to use for the Product Name Image, in pixels. For mastheads that are used in secondary windows, you might need to specify the productImageHeight and productImageWidth for correct display on Internet Explorer.

See Also:
getProductImageWidth()

isSecondary

public boolean isSecondary()

Set to true to indicate that the masthead is to be used in a secondary/popup window.


setSecondary

public void setSecondary(boolean secondary)

Set to true to indicate that the masthead is to be used in a secondary/popup window.

See Also:
isSecondary()

getServerInfo

public java.lang.String getServerInfo()

Text to display for the current Server information, such as the name of the server whose data is being displayed.


setServerInfo

public void setServerInfo(java.lang.String serverInfo)

Text to display for the current Server information, such as the name of the server whose data is being displayed.

See Also:
getServerInfo()

getServerInfoLabel

public java.lang.String getServerInfoLabel()

The label text to display for the current Server information.


setServerInfoLabel

public void setServerInfoLabel(java.lang.String serverInfoLabel)

The label text to display for the current Server information.

See Also:
getServerInfoLabel()

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()

getUserInfo

public java.lang.String getUserInfo()

Text to display for the current User information, such as the name of the user who is running the application.


setUserInfo

public void setUserInfo(java.lang.String userInfo)

Text to display for the current User information, such as the name of the user who is running the application.

See Also:
getUserInfo()

getUserInfoLabel

public java.lang.String getUserInfoLabel()

The label text to display for the current User information.


setUserInfoLabel

public void setUserInfoLabel(java.lang.String userInfoLabel)

The label text to display for the current User information.

See Also:
getUserInfoLabel()

getRoleInfo

public java.lang.String getRoleInfo()

Getter method to get Role information, such as the name of the role who is running the application.


setRoleInfo

public void setRoleInfo(java.lang.String roleInfo)

Set the current Role information, such as the name of the role who is running the application.

See Also:
getRoleInfo()

getRoleInfoLabel

public java.lang.String getRoleInfoLabel()

The label text to display for the current Role information.


setRoleInfoLabel

public void setRoleInfoLabel(java.lang.String roleInfoLabel)

The label text to display for the current Role information.

See Also:
getRoleInfoLabel()

getUtilities

public Hyperlink[] getUtilities()

A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of one or more custom Hyperlink components to display in the utility bar. The Hyperlink components must be given ids.


setUtilities

public void setUtilities(Hyperlink[] utilities)

A JavaServer Faces EL expression that resolves to a backing bean or a backing bean property that is an array of one or more custom Hyperlink components to display in the utility bar. The Hyperlink components must be given ids.

See Also:
getUtilities()

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()

getJobCountLink

public javax.faces.component.UIComponent getJobCountLink()

Get the masthead jobcount hyperlink


processDecodes

public void processDecodes(javax.faces.context.FacesContext context)
Overrides:
processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)
Overrides:
processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class javax.faces.component.UIComponentBase

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

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


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