|
||||||||||
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.webui.jsf.component.Masthead
public class Masthead
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 |
---|
public Masthead()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIOutput
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 javax.faces.convert.Converter getConverter()
getConverter
in interface javax.faces.component.ValueHolder
getConverter
in class javax.faces.component.UIOutput
public java.lang.Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class javax.faces.component.UIOutput
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.
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.
getAlarmCounts()
public java.lang.String getBrandImageDescription()
The description to use for the Brand Image, used as alt text for the image.
public void setBrandImageDescription(java.lang.String brandImageDescription)
The description to use for the Brand Image, used as alt text for the image.
getBrandImageDescription()
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.
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.
getBrandImageHeight()
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.
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.
getBrandImageURL()
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.
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.
getBrandImageWidth()
public boolean isDateTime()
Set to true to display a date and time stamp in the status area.
public void setDateTime(boolean dateTime)
Set to true to display a date and time stamp in the status area.
isDateTime()
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.
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.
getJobCount()
public java.lang.String getNotificationMsg()
Text to display for the notification info in the status area
public void setNotificationMsg(java.lang.String notificationMsg)
Text to display for the notification info in the status area
getNotificationMsg()
public java.lang.String getProductImageDescription()
The description for the product name image, used as alt text for the image.
public void setProductImageDescription(java.lang.String productImageDescription)
The description for the product name Image, used as alt text for the image.
getProductImageDescription()
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.
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.
getProductImageHeight()
public java.lang.String getProductImageURL()
The url to the image file to use for the Product Name Image.
public void setProductImageURL(java.lang.String productImageURL)
The url to the image file to use for the Product Name Image.
getProductImageURL()
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.
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.
getProductImageWidth()
public boolean isSecondary()
Set to true to indicate that the masthead is to be used in a secondary/popup window.
public void setSecondary(boolean secondary)
Set to true to indicate that the masthead is to be used in a secondary/popup window.
isSecondary()
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.
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.
getServerInfo()
public java.lang.String getServerInfoLabel()
The label text to display for the current Server information.
public void setServerInfoLabel(java.lang.String serverInfoLabel)
The label text to display for the current Server information.
getServerInfoLabel()
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 getUserInfo()
Text to display for the current User information, such as the name of the user who is running the application.
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.
getUserInfo()
public java.lang.String getUserInfoLabel()
The label text to display for the current User information.
public void setUserInfoLabel(java.lang.String userInfoLabel)
The label text to display for the current User information.
getUserInfoLabel()
public java.lang.String getRoleInfo()
Getter method to get Role information, such as the name of the role who is running the application.
public void setRoleInfo(java.lang.String roleInfo)
Set the current Role information, such as the name of the role who is running the application.
getRoleInfo()
public java.lang.String getRoleInfoLabel()
The label text to display for the current Role information.
public void setRoleInfoLabel(java.lang.String roleInfoLabel)
The label text to display for the current Role information.
getRoleInfoLabel()
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.
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.
getUtilities()
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 javax.faces.component.UIComponent getJobCountLink()
Get the masthead jobcount hyperlink
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIComponentBase
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 |