|
||||||||||
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.UICommand
com.sun.webui.jsf.component.WebuiCommand
com.sun.webui.jsf.component.Hyperlink
com.sun.webui.jsf.component.ImageHyperlink
com.sun.webui.jsf.component.IconHyperlink
com.sun.webui.jsf.component.HelpWindow
public class HelpWindow
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 |
---|
public static final java.lang.String DEFAULT_JSP_PATH
public static final java.lang.String DEFAULT_NAVIGATION_JSP
public static final java.lang.String DEFAULT_STATUS_JSP
public static final java.lang.String DEFAULT_BUTTONNAV_JSP
public static final java.lang.String DEFAULT_BUTTONFRAME_JSP
public static final java.lang.String DEFAULT_TIPS_FILE
Constructor Detail |
---|
public HelpWindow()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class IconHyperlink
public javax.el.ValueExpression getValueExpression(java.lang.String name)
Return the ValueExpression
stored for the
specified name (if any), respecting any property aliases.
getValueExpression
in class Hyperlink
name
- Name of value binding expression to retrievepublic void setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
Set the ValueExpression
stored for the
specified name (if any), respecting any property
aliases.
setValueExpression
in class Hyperlink
name
- Name of value binding to setbinding
- ValueExpression to set, or null to removepublic javax.el.MethodExpression getActionExpression()
WebuiCommand
getActionExpression
in interface javax.faces.component.ActionSource2
getActionExpression
in class WebuiCommand
public java.lang.String getOnDblClick()
getOnDblClick
in class ImageHyperlink
public javax.el.MethodExpression getActionListenerExpression()
WebuiCommand
Simply return the stored actionListenerExpression
.
The broadcast
method is overridden in
WebuiCommand
to invoke the
actionListenerExpression
.
getActionListenerExpression
in class WebuiCommand
public java.lang.String getAlign()
ImageHyperlink
Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right.
getAlign
in class ImageHyperlink
public java.lang.String getAlt()
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.
getAlt
in class ImageHyperlink
public int getBorder()
ImageHyperlink
Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser
getBorder
in class ImageHyperlink
public int getHeight()
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.
getHeight
in class ImageHyperlink
public int getHspace()
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.
getHspace
in class ImageHyperlink
public java.lang.String getIcon()
ImageHyperlink
The identifier of the desired theme image.
getIcon
in class ImageHyperlink
public java.lang.String getImageURL()
ImageHyperlink
Absolute or relative URL to the image to be rendered.
getImageURL
in class ImageHyperlink
public boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
isImmediate
in class javax.faces.component.UICommand
public java.lang.String getTarget()
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
getTarget
in class Hyperlink
public void setTarget(java.lang.String value)
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
setTarget
in class Hyperlink
Hyperlink.getTarget()
public java.lang.Object getText()
Hyperlink
The text to be displayed for the hyperlink.
getText
in class Hyperlink
public java.lang.String getTextPosition()
ImageHyperlink
Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left".
getTextPosition
in class ImageHyperlink
public java.lang.String getType()
Hyperlink
The MIME content type of the resource specified by this component.
getType
in class Hyperlink
public java.lang.String getUrl()
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.
getUrl
in class Hyperlink
public java.lang.String getUrlLang()
Hyperlink
The language code of the resource designated by this hyperlink.
getUrlLang
in class Hyperlink
public java.lang.Object getValue()
getValue
in class Hyperlink
public int getVspace()
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.
getVspace
in class ImageHyperlink
public java.lang.String getHelpFile()
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.
getHelpFile()
public java.lang.String getHelpSetPath()
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.
getHelpSetPath()
public boolean isLinkIcon()
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.
isLinkIcon()
public java.lang.String getLinkText()
The text to display for the hyperlink that opens the help window.
public void setLinkText(java.lang.String linkText)
The text to display for the hyperlink that opens the help window.
getLinkText()
public java.lang.String getStyle()
Hyperlink
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
getStyle
in class Hyperlink
public void setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
setStyle
in class Hyperlink
getStyle()
public java.lang.String getStyleClass()
Hyperlink
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
getStyleClass
in class Hyperlink
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
setStyleClass
in class Hyperlink
getStyleClass()
public boolean isVisible()
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.
isVisible
in class ImageHyperlink
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.
setVisible
in class ImageHyperlink
isVisible()
public java.lang.String getWindowTitle()
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.
getWindowTitle()
public java.lang.String getOnClick()
If developer defined onClick handler is not specified return the javascript code segment that defines the default helpWindow behaviour.
getOnClick
in class Hyperlink
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 IconHyperlink
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 IconHyperlink
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |