|
||||||||||
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
com.sun.webui.jsf.component.WebuiComponent
com.sun.webui.jsf.component.Anchor
public class Anchor
The Anchor component is used to create an XHTML <a> anchor element.
Use the webuijsf:anchor
tag to
The value of the id attribute of the rendered anchor element will be the component id, not the component's client id. In order to obtain the DOM node of the anchor element, on the client, the component id must be used and not the component's client id. This means that the component id must be unique in the page and not just unique within the closest NamingContainer.
The anchor component has an attribute called disabled which when set to true will prevent the anchor from being generating a request when it is clicked.
When UIParameter components are specified as children to the anchor component, the renderer processes these children and appends the name and value specified in the UIParameter component as query paramters to the url.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
Anchor()
Default constructor. |
Method Summary | |
---|---|
java.lang.String |
getAccessKey()
This attribute assigns an access key to an element. |
java.lang.String |
getCharset()
Specifies the character encoding of the target URL/p> |
java.lang.String |
getCoords()
Specifies the coordinates appropriate to the shape attribute to define a region of an image for image maps |
java.lang.String |
getFamily()
Return the family for this component. |
java.lang.String |
getFocusElementId(javax.faces.context.FacesContext context)
Returns the id of an HTML element suitable to receive the focus. |
java.lang.String |
getHtmlTemplate()
Get alternative HTML template to be used by the anchor component. |
javax.faces.component.UIComponent |
getIndicatorComponent(javax.faces.context.FacesContext context,
Label label)
Return a component instance that can be referenced by a Label in order to evaluate the required
and valid states of this component. |
java.lang.String |
getLabeledElementId(javax.faces.context.FacesContext context)
Returns the absolute ID of an HTML element suitable for use as the value of an HTML LABEL element's for attribute. |
java.lang.String |
getOnBlur()
Scripting code executed when this element loses focus. |
java.lang.String |
getOnClick()
Scripting code that is executed when a mouse click occurs over this component. |
java.lang.String |
getOnDblClick()
Scripting code executed when a mouse double click occurs over this component. |
java.lang.String |
getOnFocus()
Scripting code that is executed when the anchor component receives focus. |
java.lang.String |
getOnKeyDown()
Scripting code that is executed when the user presses down on a key while the anchor component has focus. |
java.lang.String |
getOnKeyPress()
Scripting code that is executed when the user presses and releases a key while the component has focus. |
java.lang.String |
getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus. |
java.lang.String |
getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component. |
java.lang.String |
getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component. |
java.lang.String |
getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component. |
java.lang.String |
getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component. |
java.lang.String |
getPrimaryElementID(javax.faces.context.FacesContext context)
Deprecated. |
java.lang.String |
getRel()
Specifies the relationship between the current document and the target URL |
java.lang.String |
getRendererType()
Return the renderer type for this component. |
java.lang.String |
getRev()
Specifies the relationship between the target URL and the current document |
java.lang.String |
getShape()
The shape of the hot spot on the screen (for use in client-side image maps). |
java.lang.String |
getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when this component is rendered. |
int |
getTabIndex()
Position of this element in the tabbing order of the current document. |
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()
|
java.lang.String |
getToolTip()
Sets the value of the title attribute for the HTML element. |
java.lang.String |
getType()
The MIME content type of the resource specified by the anchor component. |
java.lang.String |
getUrl()
Absolute, relative, or context relative (starting with "/") URL to the resource selected by this anchor. |
java.lang.String |
getUrlLang()
The language code of the resource designated by this anchor. |
boolean |
isDisabled()
Flag indicating that clicking this component by the user is not currently permitted. |
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 |
setAccessKey(java.lang.String accessKey)
This attribute assigns an access key to an element. |
void |
setCharset(java.lang.String charset)
Specifies the character encoding of the target URL/p> |
void |
setCoords(java.lang.String coords)
Specifies the coordinates appropriate to the shape attribute to define a region of an image for image maps |
void |
setDisabled(boolean disabled)
Flag indicating that clicking this component by the user is not currently permitted. |
void |
setHtmlTemplate(java.lang.String htmlTemplate)
Get alternative HTML template to be used by the anchor component. |
void |
setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus. |
void |
setOnClick(java.lang.String onClick)
Scripting code that is executed when a mouse click occurs over this component. |
void |
setOnDblClick(java.lang.String onDblClick)
Scripting code that is executed when a mouse double click occurs over this component. |
void |
setOnFocus(java.lang.String onFocus)
Scripting code that is executed when the anchor component receives focus. |
void |
setOnKeyDown(java.lang.String onKeyDown)
Scripting code thta is executed when the user presses down on a key while the anchor component has focus. |
void |
setOnKeyPress(java.lang.String onKeyPress)
Scripting code that is executed when the user presses and releases a key while the component has focus. |
void |
setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus. |
void |
setOnMouseDown(java.lang.String onMouseDown)
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component. |
void |
setOnMouseMove(java.lang.String onMouseMove)
Scripting code executed when the user moves the mouse pointer while over the component. |
void |
setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component. |
void |
setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component. |
void |
setOnMouseUp(java.lang.String onMouseUp)
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component. |
void |
setRel(java.lang.String rel)
Specifies the relationship between the current document and the target URL |
void |
setRev(java.lang.String rev)
Specifies the relationship between the target URL and the current document |
void |
setShape(java.lang.String shape)
The shape of the hot spot on the screen (for use in client-side image maps).Used with the coords attribute. |
void |
setStyle(java.lang.String style)
CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when this component is rendered. |
void |
setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. |
void |
setTarget(java.lang.String target)
The resource at the specified URL is displayed in the frame that is specified with the target attribute. |
void |
setText(java.lang.Object text)
The text to be displayed for the anchor element. |
void |
setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. |
void |
setType(java.lang.String type)
The MIME content type of the resource specified by the anchor component. |
void |
setUrl(java.lang.String url)
Absolute, relative, or context relative (starting with "/") URL to the resource selected by this anchor. |
void |
setUrlLang(java.lang.String urlLang)
The language code of the resource designated by this anchor. |
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 com.sun.webui.jsf.component.WebuiComponent |
---|
processDecodes, processUpdates, processValidators, setId, setRendered |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, 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 Anchor()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public java.lang.String getRendererType()
Return the renderer type for this component.
getRendererType
in class javax.faces.component.UIComponentBase
public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex()
public java.lang.String getToolTip()
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
public void setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
getToolTip()
public java.lang.String getShape()
The shape of the hot spot on the screen (for use in client-side image maps). Used with the coords attribute.Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
public void setShape(java.lang.String shape)
The shape of the hot spot on the screen (for use in client-side image maps).Used with the coords attribute. Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
getShape()
public java.lang.String getRel()
Specifies the relationship between the current document and the target URL
public void setRel(java.lang.String rel)
Specifies the relationship between the current document and the target URL
public java.lang.String getRev()
Specifies the relationship between the target URL and the current document
public void setRev(java.lang.String rev)
Specifies the relationship between the target URL and the current document
public java.lang.String getCoords()
Specifies the coordinates appropriate to the shape attribute to define a region of an image for image maps
public void setCoords(java.lang.String coords)
Specifies the coordinates appropriate to the shape attribute to define a region of an image for image maps
public java.lang.String getType()
The MIME content type of the resource specified by the anchor component.
public void setType(java.lang.String type)
The MIME content type of the resource specified by the anchor component.
getType()
public java.lang.String getUrl()
Absolute, relative, or context relative (starting with "/") URL to the resource selected by this anchor. If the url attribute is specified, clicking the anchor sends the browser to the new location. If UIParameter components are specified as child to the anchor component, then the renderer processes these name value pairs of the UIParameter components and appends them as query parameters to the specified url.
public void setUrl(java.lang.String url)
Absolute, relative, or context relative (starting with "/") URL to the resource selected by this anchor. If the url attribute is specified, clicking the anchor sends the browser to the new location. If UIParameter components are specified as child to the anchor component, then the renderer processes these name value pairs of the UIParameter components and appends them as query parameters to the specified url.
public java.lang.String getUrlLang()
The language code of the resource designated by this anchor.
public void setUrlLang(java.lang.String urlLang)
The language code of the resource designated by this anchor.
getUrlLang()
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 java.lang.String getTarget()
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
public void setTarget(java.lang.String target)
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()
public java.lang.Object getText()
public void setText(java.lang.Object text)
The text to be displayed for the anchor element.
getText()
public java.lang.String getLabeledElementId(javax.faces.context.FacesContext context)
for
attribute.
If the ComplexComponent
has sub-compoents, and one of
the sub-components is the target of a label, if that sub-component
is a ComplexComponent
, then
getLabeledElementId
must called on the sub-component and
the value returned. The value returned by this
method call may or may not resolve to a component instance.
getLabeledElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the request
for
attribute.public javax.faces.component.UIComponent getIndicatorComponent(javax.faces.context.FacesContext context, Label label)
Label
in order to evaluate the required
and valid
states of this component.
This implementation returns null
.
Anchor
does not support the required or valid states
getIndicatorComponent
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The current FacesContext
instancelabel
- The Label
that labels this component.
UIComponent
in order to evaluate the
required and valid states.public java.lang.String getFocusElementId(javax.faces.context.FacesContext context)
ComplexComponent
has sub-compoents, and one of
the sub-components is to reveive the focus, if that sub-component
is a ComplexComponent
, then
getFocusElementId
must called on the sub-component and
the value returned. The value returned by this
method call may or may not resolve to a component instance.
This implementations returns the value of
getLabeledElementId
.
getFocusElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the requestpublic java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
getPrimaryElementID
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext for the request
getLabeledElementId(javax.faces.context.FacesContext)
,
getFocusElementId(javax.faces.context.FacesContext)
public java.lang.String getOnBlur()
Scripting code executed when this element loses focus.
public void setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus.
getOnBlur()
public java.lang.String getOnClick()
Scripting code that is executed when a mouse click occurs over this component. If the component submits the form (by using the action attribute), the script that you use with the onClick attribute should not return from the function. When the action attribute is used, the component handles the return with a script that is appended to the anchor element's onclick property. When you supply an onClick attribute, this return script is appended after your script in the anchor's onclick. You can return from your script to abort the submit process if necessary.
public void setOnClick(java.lang.String onClick)
Scripting code that is executed when a mouse click occurs over this component. If the component submits the form (by using the action attribute), the script that you use with the onClick attribute should not return from the function. When the action attribute is used, the component handles the return with a script that is appended to the anchor element's onclick property. When you supply an onClick attribute, this return script is appended after your script in the anchor's onclick. You can return from your script to abort the submit process if necessary.
getOnClick()
public java.lang.String getOnDblClick()
Scripting code executed when a mouse double click occurs over this component.
public void setOnDblClick(java.lang.String onDblClick)
Scripting code that is executed when a mouse double click occurs over this component.
getOnDblClick()
public java.lang.String getOnFocus()
Scripting code that is executed when the anchor component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
public void setOnFocus(java.lang.String onFocus)
Scripting code that is executed when the anchor component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
getOnFocus()
public java.lang.String getOnKeyDown()
Scripting code that is executed when the user presses down on a key while the anchor component has focus.
public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code thta is executed when the user presses down on a key while the anchor component has focus.
getOnKeyDown()
public java.lang.String getOnKeyPress()
Scripting code that is executed when the user presses and releases a key while the component has focus.
public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code that is executed when the user presses and releases a key while the component has focus.
getOnKeyPress()
public java.lang.String getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus.
public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus.
getOnKeyUp()
public java.lang.String getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
public void setOnMouseDown(java.lang.String onMouseDown)
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
getOnMouseDown()
public java.lang.String getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component.
public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code executed when the user moves the mouse pointer while over the component.
getOnMouseMove()
public java.lang.String getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component.
public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component.
getOnMouseOut()
public java.lang.String getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
getOnMouseOver()
public java.lang.String getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
public void setOnMouseUp(java.lang.String onMouseUp)
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
getOnMouseUp()
public java.lang.String getCharset()
Specifies the character encoding of the target URL/p>
public void setCharset(java.lang.String charset)
Specifies the character encoding of the target URL/p>
public java.lang.String getAccessKey()
This attribute assigns an access key to an element. An access key is a single character from the document character set.
public void setAccessKey(java.lang.String accessKey)
This attribute assigns an access key to an element. An access key is a single character from the document character set.
public java.lang.String getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style or styles to be applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public java.lang.String getHtmlTemplate()
public void setHtmlTemplate(java.lang.String htmlTemplate)
public boolean isDisabled()
Flag indicating that clicking this component by the user is not currently permitted.
public void setDisabled(boolean disabled)
Flag indicating that clicking this component by the user is not currently permitted.
isDisabled()
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.UIComponentBase
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.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |