Java Doc for HyperlinkBase.java in » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » component » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Netbeans » visualweb.api.designer » com.sun.rave.web.ui.component

Source Cross Reference Class Diagram Java Document (Java Doc)

com.sun.rave.web.ui.component .HyperlinkBase

All known Subclasses:   com.sun.rave.web.ui.component .Hyperlink,
HyperlinkBase
abstract public class HyperlinkBase extends javax.faces.component.UICommand (Code)
Use the ui:hyperlink tag to display a HTML hyperlink to a URL, or a link that submits a form. If the action attribute is used, the form is submitted. If the url attribute is used, the link is a normal hyperlink that sends the browser to a new location.

The ui:imageHyperlink component can be also be used to submit forms. If the action attribute is used, the form is submitted. If the url attribute is used, the link is a normal hyperlink that sends the browser to a new location.

HTML Elements and Layout
The rendered HTML page displays an XHTML element. If the link submits the form the onclick will have some additional behavior that the user should be aware of. See the onclick attribute below.

Client Side Javascript Functions
None.

Examples

Example 1: Create a hyperlink that submits the form:
<ui:hyperlink id="hyperlinktest1" text="#{HyperlinkBean.text}" action="#{HyperlinkBean.success}" />Note: id can be used as a unique identifier if the hyperlink is programatically addressed

Example 2: Create a hyperlink that goes to another page:
<ui:hyperlink id="hyperlinktest2" text="#{HyperlinkBean.text}" url="http://www.google.com" />Note: url property being set signifies that this *will not* submit to the server and will be a straight hyperlink

Example 3: Using the body of a hyperlink to render text:
<ui:hyperlink id="hyperlinktest3" url="http://www.sun.com" > <ui:image url="myyahoo.gif" /><ui:staticText text="more text" /> </ui:hyperlink>
Example 4: Using f:params to add additional request parameters when the hyperlink action is invoked:
<ui:hyperlink id="hyperlinktest1" text="#{HyperlinkBean.label}" action="#{HyperlinkBean.success}" >     <f:param name="testingParam1" value="success!"/>     <f:param name="testingParam2" value="failure!"/> </ui:hyperlink>Note: After clicking on this hyperlink, the page will be submitted and the request parameter map will have 2 additional items in it: testingParam1 and testingParam2 with their associtated values

Auto-generated component class. Do NOT modify; all changes will be lost!

Constructor Summary
public HyperlinkBase()


Method Summary
public javax.faces.el.MethodBinding getAction()

public javax.faces.el.MethodBinding getActionListener()

public String getFamily()

Return the identifier of the component family to which this component belongs.
public String getOnBlur()

public String getOnClick()

Scripting code executed when a mouse click occurs over this component. If the component submits the form, the script should not return from this function.
public String getOnDblClick()

public String getOnFocus()

Scripting code executed when this component receives focus.
public String getOnKeyDown()

public String getOnKeyPress()

public String getOnKeyUp()

public String getOnMouseDown()

public String getOnMouseMove()

public String getOnMouseOut()

public String getOnMouseOver()

public String getOnMouseUp()

public String getShape()

The shape of the hot spot on the screen (for use in client-side image maps).
public String getStyle()

public String getStyleClass()

public int getTabIndex()

public String getTarget()

The resource at the specified URL is displayed in the frame that is specified with the target attribute.
public Object getText()

public String getToolTip()

public String getType()

public String getUrl()

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink.
public String getUrlLang()

public ValueBinding getValueBinding(String name)

public boolean isDisabled()

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
public void restoreState(FacesContext _context, Object _state)

public Object saveState(FacesContext _context)

public void setAction(javax.faces.el.MethodBinding action)

public void setActionListener(javax.faces.el.MethodBinding actionListener)

public void setDisabled(boolean disabled)

public void setOnBlur(String onBlur)

public void setOnClick(String onClick)

Scripting code executed when a mouse click occurs over this component. If the component submits the form, the script should not return from this function.
public void setOnDblClick(String onDblClick)

public void setOnFocus(String onFocus)

Scripting code executed when this component receives focus.
public void setOnKeyDown(String onKeyDown)

public void setOnKeyPress(String onKeyPress)

public void setOnKeyUp(String onKeyUp)

public void setOnMouseDown(String onMouseDown)

public void setOnMouseMove(String onMouseMove)

public void setOnMouseOut(String onMouseOut)

public void setOnMouseOver(String onMouseOver)

public void setOnMouseUp(String onMouseUp)

public void setShape(String shape)

The shape of the hot spot on the screen (for use in client-side image maps).
public void setStyle(String style)

public void setStyleClass(String styleClass)

public void setTabIndex(int tabIndex)

public void setTarget(String target)

The resource at the specified URL is displayed in the frame that is specified with the target attribute.
public void setText(Object text)

public void setToolTip(String toolTip)

public void setType(String type)

public void setUrl(String url)

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink.
public void setUrlLang(String urlLang)

public void setValueBinding(String name, ValueBinding binding)

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.

Constructor Detail
HyperlinkBase
public HyperlinkBase()(Code)

Construct a new HyperlinkBase.

Method Detail
getAction
public javax.faces.el.MethodBinding getAction()(Code)

Method binding representing a method that processes application actions from this component.

getActionListener
public javax.faces.el.MethodBinding getActionListener()(Code)

Method binding representing a method that receives action from this, and possibly other, components.

getFamily
public String getFamily()(Code)

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

getOnBlur
public String getOnBlur()(Code)

Scripting code executed when this element loses focus.

getOnClick
public String getOnClick()(Code)

Scripting code executed when a mouse click occurs over this component. If the component submits the form, the script should not return from this function. The return will be handled by the script that is appended to the onclick. It is ok to return from this script to abort the submit process if necessary.

getOnDblClick
public String getOnDblClick()(Code)

Scripting code executed when a mouse double click occurs over this component.

getOnFocus
public String getOnFocus()(Code)

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

getOnKeyDown
public String getOnKeyDown()(Code)

Scripting code executed when the user presses down on a key while the component has focus.

getOnKeyPress
public String getOnKeyPress()(Code)

Scripting code executed when the user presses and releases a key while the component has focus.

getOnKeyUp
public String getOnKeyUp()(Code)

Scripting code executed when the user releases a key while the component has focus.

getOnMouseDown
public String getOnMouseDown()(Code)

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

getOnMouseMove
public String getOnMouseMove()(Code)

Scripting code executed when the user moves the mouse pointer while over the component.

getOnMouseOut
public String getOnMouseOut()(Code)

Scripting code executed when a mouse out movement occurs over this component.

getOnMouseOver
public String getOnMouseOver()(Code)

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

getOnMouseUp
public String getOnMouseUp()(Code)

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

getShape
public String getShape()(Code)

The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).

getStyle
public String getStyle()(Code)

CSS style(s) to be applied when this component is rendered.

getStyleClass
public String getStyleClass()(Code)

CSS style class(es) to be applied when this component is rendered.

getTabIndex
public int getTabIndex()(Code)

The position of this component in the tabbing order sequence

getTarget
public String getTarget()(Code)

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

getText
public Object getText()(Code)

The text description of the hyperlink

getToolTip
public String getToolTip()(Code)

Display the text as a tooltip for this component

getType
public String getType()(Code)

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

getUrl
public String getUrl()(Code)

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink. If not specified, clicking this hyperlink will submit the surrounding form.

getUrlLang
public String getUrlLang()(Code)

The language code of the resource designated by this hyperlink.

getValueBinding
public ValueBinding getValueBinding(String name)(Code)

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

Parameters:
  name - Name of value binding to retrieve

isDisabled
public boolean isDisabled()(Code)

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.

isVisible
public boolean isVisible()(Code)

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.

restoreState
public void restoreState(FacesContext _context, Object _state)(Code)

Restore the state of this component.

saveState
public Object saveState(FacesContext _context)(Code)

Save the state of this component.

setAction
public void setAction(javax.faces.el.MethodBinding action)(Code)

Method binding representing a method that processes application actions from this component.

See Also:   HyperlinkBase.getAction()

setActionListener
public void setActionListener(javax.faces.el.MethodBinding actionListener)(Code)

Method binding representing a method that receives action from this, and possibly other, components.

See Also:   HyperlinkBase.getActionListener()

setDisabled
public void setDisabled(boolean disabled)(Code)

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.

See Also:   HyperlinkBase.isDisabled()

setOnBlur
public void setOnBlur(String onBlur)(Code)

Scripting code executed when this element loses focus.

See Also:   HyperlinkBase.getOnBlur()

setOnClick
public void setOnClick(String onClick)(Code)

Scripting code executed when a mouse click occurs over this component. If the component submits the form, the script should not return from this function. The return will be handled by the script that is appended to the onclick. It is ok to return from this script to abort the submit process if necessary.

See Also:   HyperlinkBase.getOnClick()

setOnDblClick
public void setOnDblClick(String onDblClick)(Code)

Scripting code executed when a mouse double click occurs over this component.

See Also:   HyperlinkBase.getOnDblClick()

setOnFocus
public void setOnFocus(String onFocus)(Code)

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

See Also:   HyperlinkBase.getOnFocus()

setOnKeyDown
public void setOnKeyDown(String onKeyDown)(Code)

Scripting code executed when the user presses down on a key while the component has focus.

See Also:   HyperlinkBase.getOnKeyDown()

setOnKeyPress
public void setOnKeyPress(String onKeyPress)(Code)

Scripting code executed when the user presses and releases a key while the component has focus.

See Also:   HyperlinkBase.getOnKeyPress()

setOnKeyUp
public void setOnKeyUp(String onKeyUp)(Code)

Scripting code executed when the user releases a key while the component has focus.

See Also:   HyperlinkBase.getOnKeyUp()

setOnMouseDown
public void setOnMouseDown(String onMouseDown)(Code)

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

See Also:   HyperlinkBase.getOnMouseDown()

setOnMouseMove
public void setOnMouseMove(String onMouseMove)(Code)

Scripting code executed when the user moves the mouse pointer while over the component.

See Also:   HyperlinkBase.getOnMouseMove()

setOnMouseOut
public void setOnMouseOut(String onMouseOut)(Code)

Scripting code executed when a mouse out movement occurs over this component.

See Also:   HyperlinkBase.getOnMouseOut()

setOnMouseOver
public void setOnMouseOver(String onMouseOver)(Code)

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

See Also:   HyperlinkBase.getOnMouseOver()

setOnMouseUp
public void setOnMouseUp(String onMouseUp)(Code)

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

See Also:   HyperlinkBase.getOnMouseUp()

setShape
public void setShape(String shape)(Code)

The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).

See Also:   HyperlinkBase.getShape()

setStyle
public void setStyle(String style)(Code)

CSS style(s) to be applied when this component is rendered.

See Also:   HyperlinkBase.getStyle()

setStyleClass
public void setStyleClass(String styleClass)(Code)

CSS style class(es) to be applied when this component is rendered.

See Also:   HyperlinkBase.getStyleClass()

setTabIndex
public void setTabIndex(int tabIndex)(Code)

The position of this component in the tabbing order sequence

See Also:   HyperlinkBase.getTabIndex()

setTarget
public void setTarget(String target)(Code)

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

See Also:   HyperlinkBase.getTarget()

setText
public void setText(Object text)(Code)

The text description of the hyperlink

See Also:   HyperlinkBase.getText()

setToolTip
public void setToolTip(String toolTip)(Code)

Display the text as a tooltip for this component

See Also:   HyperlinkBase.getToolTip()

setType
public void setType(String type)(Code)

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

See Also:   HyperlinkBase.getType()

setUrl
public void setUrl(String url)(Code)

Absolute, relative, or context relative (starting with "/") URL to the resource selected by this hyperlink. If not specified, clicking this hyperlink will submit the surrounding form.

See Also:   HyperlinkBase.getUrl()

setUrlLang
public void setUrlLang(String urlLang)(Code)

The language code of the resource designated by this hyperlink.

See Also:   HyperlinkBase.getUrlLang()

setValueBinding
public void setValueBinding(String name, ValueBinding binding)(Code)

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

Parameters:
  name - Name of value binding to set
Parameters:
  binding - ValueBinding to set, or null to remove

setVisible
public void setVisible(boolean visible)(Code)

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:   HyperlinkBase.isVisible()

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.