com.sun.webui.jsf.component
Class VersionPage

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

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

The VersionPage component is used to display a version 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
VersionPage()
          Construct a new VersionPage.
 
Method Summary
 javax.faces.convert.Converter getConverter()
           
 java.lang.String getCopyrightString()
          The application copyright information.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getProductImageDescription()
          The description to use for the Product Name Image displayed in the version page.
 int getProductImageHeight()
          The height to use for the Product Name Image
 java.lang.String getProductImageURL()
          The url to use for the Product Name Image
 int getProductImageWidth()
          The width to use for the Product Name Image
 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.Object getValue()
           
 java.lang.String getVersionInformationFile()
          The name of version information file containing the formatted application version and copyright message.
 java.lang.String getVersionString()
          The application version.
 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 setCopyrightString(java.lang.String copyrightString)
          The application copyright information.
 void setId(java.lang.String id)
          The component identifier for this component.
 void setProductImageDescription(java.lang.String productImageDescription)
          The description to use for the Product Name Image displayed in the version page.
 void setProductImageHeight(int productImageHeight)
          The height to use for the Product Name Image
 void setProductImageURL(java.lang.String productImageURL)
          The url to use for the Product Name Image
 void setProductImageWidth(int productImageWidth)
          The width to use for the Product Name Image
 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 setVersionInformationFile(java.lang.String versionInformationFile)
          The name of version information file containing the formatted application version and copyright message.
 void setVersionString(java.lang.String versionString)
          The application version.
 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, 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
 

Constructor Detail

VersionPage

public VersionPage()

Construct a new VersionPage.

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

getCopyrightString

public java.lang.String getCopyrightString()

The application copyright information.


setCopyrightString

public void setCopyrightString(java.lang.String copyrightString)

The application copyright information.

See Also:
getCopyrightString()

getProductImageDescription

public java.lang.String getProductImageDescription()

The description to use for the Product Name Image displayed in the version page.


setProductImageDescription

public void setProductImageDescription(java.lang.String productImageDescription)

The description to use for the Product Name Image displayed in the version page.

See Also:
getProductImageDescription()

getProductImageHeight

public int getProductImageHeight()

The height to use for the Product Name Image


setProductImageHeight

public void setProductImageHeight(int productImageHeight)

The height to use for the Product Name Image

See Also:
getProductImageHeight()

getProductImageURL

public java.lang.String getProductImageURL()

The url to use for the Product Name Image


setProductImageURL

public void setProductImageURL(java.lang.String productImageURL)

The url to use for the Product Name Image

See Also:
getProductImageURL()

getProductImageWidth

public int getProductImageWidth()

The width to use for the Product Name Image


setProductImageWidth

public void setProductImageWidth(int productImageWidth)

The width to use for the Product Name Image

See Also:
getProductImageWidth()

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

getVersionInformationFile

public java.lang.String getVersionInformationFile()

The name of version information file containing the formatted application version and copyright message.


setVersionInformationFile

public void setVersionInformationFile(java.lang.String versionInformationFile)

The name of version information file containing the formatted application version and copyright message.

See Also:
getVersionInformationFile()

getVersionString

public java.lang.String getVersionString()

The application version.


setVersionString

public void setVersionString(java.lang.String versionString)

The application version.

See Also:
getVersionString()

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