com.sun.webui.jsf.component
Class HelpWindow

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by com.sun.webui.jsf.component.WebuiCommand
                  extended by com.sun.webui.jsf.component.Hyperlink
                      extended by com.sun.webui.jsf.component.ImageHyperlink
                          extended by com.sun.webui.jsf.component.IconHyperlink
                              extended by com.sun.webui.jsf.component.HelpWindow
All Implemented Interfaces:
com.sun.webui.jsf.component.ComplexComponent, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class HelpWindow
extends IconHyperlink

The HelpWindow component displays a link that opens a popup window for a help system.


Field Summary
static java.lang.String DEFAULT_BUTTONFRAME_JSP
           
static java.lang.String DEFAULT_BUTTONNAV_JSP
           
static java.lang.String DEFAULT_JSP_PATH
           
static java.lang.String DEFAULT_NAVIGATION_JSP
           
static java.lang.String DEFAULT_STATUS_JSP
           
static java.lang.String DEFAULT_TIPS_FILE
           
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HelpWindow()
          Creates a new instance of HelpWindow
 
Method Summary
 javax.el.MethodExpression getActionExpression()
          MethodExpression representing the application action to invoke when this component is activated by the user.
 javax.el.MethodExpression getActionListenerExpression()
          Simply return the stored actionListenerExpression.
 java.lang.String getAlign()
          Specifies the position of the image with respect to its context.
 java.lang.String getAlt()
          Alternative textual description of the image rendered by this component.
 int getBorder()
          Specifies the width of the img border in pixels.
 java.lang.String getFamily()
          Return the family for this component.
 int getHeight()
          When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels.
 java.lang.String getHelpFile()
           
 java.lang.String getHelpSetPath()
           
 int getHspace()
          Specifies the amount of white space in pixels to be inserted to the left and right of the image.
 java.lang.String getIcon()
          The identifier of the desired theme image.
 java.lang.String getImageURL()
          Absolute or relative URL to the image to be rendered.
 java.lang.String getLinkText()
          The text to display for the hyperlink that opens the help window.
 java.lang.String getOnClick()
           If developer defined onClick handler is not specified return the javascript code segment that defines the default helpWindow behaviour.
 java.lang.String getOnDblClick()
          Scripting code executed when a mouse double click occurs over this component.
 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 getTarget()
          The resource at the specified URL is displayed in the frame that is specified with the target attribute.
 java.lang.Object getText()
          The text to be displayed for the hyperlink.
 java.lang.String getTextPosition()
          Specifies where the text will be placed relative to the image.
 java.lang.String getType()
          The MIME content type of the resource specified by this component.
 java.lang.String getUrl()
          Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink.
 java.lang.String getUrlLang()
          The language code of the resource designated by this hyperlink.
 java.lang.Object getValue()
           
 javax.el.ValueExpression getValueExpression(java.lang.String name)
          Return the ValueExpression stored for the specified name (if any), respecting any property aliases.
 int getVspace()
          Specifies the amount of white space in pixels to be inserted above and below the image.
 java.lang.String getWindowTitle()
           
 boolean isImmediate()
           
 boolean isLinkIcon()
           
 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 setHelpFile(java.lang.String helpFile)
          The help file to be displayed in the help window content frame when the help link is clicked.
 void setHelpSetPath(java.lang.String helpSetPath)
          The context relative path to the help set to be displayed.
 void setLinkIcon(boolean linkIcon)
          Set linkIcon to true to display the default icon in front of the text for the help window link.
 void setLinkText(java.lang.String linkText)
          The text to display for the hyperlink that opens the help window.
 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 setTarget(java.lang.String value)
          The resource at the specified URL is displayed in the frame that is specified with the target attribute.
 void setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
          Set the ValueExpression stored for the specified name (if any), respecting any property aliases.
 void setVisible(boolean visible)
          Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
 void setWindowTitle(java.lang.String windowTitle)
          The text to display in the browser window frame for the help window.
 
Methods inherited from class com.sun.webui.jsf.component.ImageHyperlink
getImageFacet, getRendererType, getWidth, setAlign, setAlt, setBorder, setHeight, setHspace, setIcon, setImageURL, setTextPosition, setVspace, setWidth
 
Methods inherited from class com.sun.webui.jsf.component.Hyperlink
getFocusElementId, getHtmlTemplate, getIndicatorComponent, getLabeledElementId, getOnBlur, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getPrimaryElementID, getShape, getTabIndex, getToolTip, isDisabled, setDisabled, setHtmlTemplate, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setShape, setTabIndex, setText, setToolTip, setType, setUrl, setUrlLang, toString
 
Methods inherited from class com.sun.webui.jsf.component.WebuiCommand
broadcast, getAction, getActionListener, processDecodes, processUpdates, processValidators, setActionListenerExpression, setId, setImmediate, setRendered
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getActionListeners, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_JSP_PATH

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

DEFAULT_NAVIGATION_JSP

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

DEFAULT_STATUS_JSP

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

DEFAULT_BUTTONNAV_JSP

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

DEFAULT_BUTTONFRAME_JSP

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

DEFAULT_TIPS_FILE

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

HelpWindow

public HelpWindow()
Creates a new instance of HelpWindow

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class IconHyperlink

getValueExpression

public javax.el.ValueExpression getValueExpression(java.lang.String name)

Return the ValueExpression stored for the specified name (if any), respecting any property aliases.

Overrides:
getValueExpression in class Hyperlink
Parameters:
name - Name of value binding expression to retrieve

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Set the ValueExpression stored for the specified name (if any), respecting any property aliases.

Overrides:
setValueExpression in class Hyperlink
Parameters:
name - Name of value binding to set
binding - ValueExpression to set, or null to remove

getActionExpression

public javax.el.MethodExpression getActionExpression()
Description copied from class: WebuiCommand
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a either a String or a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application.

Specified by:
getActionExpression in interface javax.faces.component.ActionSource2
Overrides:
getActionExpression in class WebuiCommand

getOnDblClick

public java.lang.String getOnDblClick()
Scripting code executed when a mouse double click occurs over this component.

Overrides:
getOnDblClick in class ImageHyperlink

getActionListenerExpression

public javax.el.MethodExpression getActionListenerExpression()
Description copied from class: WebuiCommand

Simply return the stored actionListenerExpression. The broadcast method is overridden in WebuiCommand to invoke the actionListenerExpression.

Overrides:
getActionListenerExpression in class WebuiCommand

getAlign

public java.lang.String getAlign()
Description copied from class: ImageHyperlink

Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right.

Overrides:
getAlign in class ImageHyperlink

getAlt

public java.lang.String getAlt()
Description copied from class: ImageHyperlink

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.

Overrides:
getAlt in class ImageHyperlink

getBorder

public int getBorder()
Description copied from class: ImageHyperlink

Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser

Overrides:
getBorder in class ImageHyperlink

getHeight

public int getHeight()
Description copied from class: ImageHyperlink

When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior.

Overrides:
getHeight in class ImageHyperlink

getHspace

public int getHspace()
Description copied from class: ImageHyperlink

Specifies the amount of white space in pixels to be inserted to the left and right of the image. The default value is not specified but is generally a small, non-zero size.

Overrides:
getHspace in class ImageHyperlink

getIcon

public java.lang.String getIcon()
Description copied from class: ImageHyperlink

The identifier of the desired theme image.

Overrides:
getIcon in class ImageHyperlink

getImageURL

public java.lang.String getImageURL()
Description copied from class: ImageHyperlink

Absolute or relative URL to the image to be rendered.

Overrides:
getImageURL in class ImageHyperlink

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.ActionSource
Overrides:
isImmediate in class javax.faces.component.UICommand

getTarget

public java.lang.String getTarget()
Description copied from class: Hyperlink

The resource at the specified URL is displayed in the frame that is specified with the target attribute. Values such as "_blank" that are valid for the target attribute of a HTML anchor element are also valid for this attribute in this component

Overrides:
getTarget in class Hyperlink

setTarget

public void setTarget(java.lang.String value)
Description copied from class: Hyperlink

The resource at the specified URL is displayed in the frame that is specified with the target attribute. Values such as "_blank" that are valid for the target attribute of a HTML anchor element are also valid for this attribute in this component

Overrides:
setTarget in class Hyperlink
See Also:
Hyperlink.getTarget()

getText

public java.lang.Object getText()
Description copied from class: Hyperlink

The text to be displayed for the hyperlink.

Overrides:
getText in class Hyperlink

getTextPosition

public java.lang.String getTextPosition()
Description copied from class: ImageHyperlink

Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left".

Overrides:
getTextPosition in class ImageHyperlink

getType

public java.lang.String getType()
Description copied from class: Hyperlink

The MIME content type of the resource specified by this component.

Overrides:
getType in class Hyperlink

getUrl

public java.lang.String getUrl()
Description copied from class: Hyperlink

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink. If the url attribute is specified, clicking this hyperlink sends the browser to the new location. If the action attribute is specified, the form is submitted. If both are specified, the url attribute takes precedence.

Overrides:
getUrl in class Hyperlink

getUrlLang

public java.lang.String getUrlLang()
Description copied from class: Hyperlink

The language code of the resource designated by this hyperlink.

Overrides:
getUrlLang in class Hyperlink

getValue

public java.lang.Object getValue()
Overrides:
getValue in class Hyperlink

getVspace

public int getVspace()
Description copied from class: ImageHyperlink

Specifies the amount of white space in pixels to be inserted above and below the image. The default value is not specified but is generally a small, non-zero size.

Overrides:
getVspace in class ImageHyperlink

getHelpFile

public java.lang.String getHelpFile()

setHelpFile

public void setHelpFile(java.lang.String helpFile)

The help file to be displayed in the help window content frame when the help link is clicked. The value can be a relative path or a file name.

See Also:
getHelpFile()

getHelpSetPath

public java.lang.String getHelpSetPath()

setHelpSetPath

public void setHelpSetPath(java.lang.String helpSetPath)

The context relative path to the help set to be displayed. This attribute overrides any value set for the helpSetPath property in the application's HelpBackingBean instance.

See Also:
getHelpSetPath()

isLinkIcon

public boolean isLinkIcon()

setLinkIcon

public void setLinkIcon(boolean linkIcon)

Set linkIcon to true to display the default icon in front of the text for the help window link. The icon is useful in inline help links to the help window. By default the value is false.

See Also:
isLinkIcon()

getLinkText

public java.lang.String getLinkText()

The text to display for the hyperlink that opens the help window.


setLinkText

public void setLinkText(java.lang.String linkText)

The text to display for the hyperlink that opens the help window.

See Also:
getLinkText()

getStyle

public java.lang.String getStyle()
Description copied from class: Hyperlink

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

Overrides:
getStyle in class Hyperlink

setStyle

public void setStyle(java.lang.String style)

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

Overrides:
setStyle in class Hyperlink
See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()
Description copied from class: Hyperlink

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

Overrides:
getStyleClass in class Hyperlink

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.

Overrides:
setStyleClass in class Hyperlink
See Also:
getStyleClass()

isVisible

public boolean isVisible()
Description copied from class: ImageHyperlink

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.

Overrides:
isVisible in class ImageHyperlink

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.

Overrides:
setVisible in class ImageHyperlink
See Also:
isVisible()

getWindowTitle

public java.lang.String getWindowTitle()

setWindowTitle

public void setWindowTitle(java.lang.String windowTitle)

The text to display in the browser window frame for the help window. This text is rendered in the HTML title element.

See Also:
getWindowTitle()

getOnClick

public java.lang.String getOnClick()

If developer defined onClick handler is not specified return the javascript code segment that defines the default helpWindow behaviour.

Overrides:
getOnClick in class Hyperlink

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 IconHyperlink

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 IconHyperlink


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