BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs.

com.bea.wlw.netui.tags.html
Class Anchor

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by com.bea.wlw.netui.tags.AbstractBaseTag
              extended by com.bea.wlw.netui.tags.html.Anchor
All Implemented Interfaces:
HtmlConstants, URLParams, IAttributeConsumer, Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ImageAnchor

public class Anchor
extends AbstractBaseTag
implements URLParams, IAttributeConsumer

Generates a hyperlink to a specified URI. Also adds support for URL re-writing and JavaScript-based form submission. An anchor must have one of five attributes to correctly create the hyperlink:

Attribute Descriptions
AttributeRequiredRuntime Expression Evaluation Data Bindable
accessKeyNoNoNo
Define the keyboard navigation key for the element.
actionNoNoRead Only
An action invoked by clicking the link.
formSubmitNoNoNo
True if clicking this link should submit its enclosing form.
forwardNoNoNo
The logical forward name from which to retrieve the hyperlink URI.
hrefNoNoRead Only
A URL destination to go to.
idNoNoNo
id is deprecated, use tagId. The id attribute of the generated Anchor. You should use the tagId which will encode the id correctly for containers such as the Portal which needs to rewrite id's to make them unique.
linkNameNoNoNo
An internal place in the page to move to.
locationNoNoNo
Location within the URI to visit
pageNoNoNo
page is deprecated The module-relative page URL to which this hyperlink will be rendered.
tagIdNoNoNo
The id of this anchor. The real id written to the HTML stream may be changed by the container (Portal), but may be looked up with the 'tagId' value through the JavaScript method getNetuiTagName( tag, tagId ) method written by the <netui:html> tag.
targetNoNoNo
The window target

See Also:
Form, Serialized Form
Example:
Submitting Form Data

In this sample, clicking on this anchor submits the form data and invokes the method submitForm.

      <netui:form action="formSubmit">
          Firstname:
          <netui:textBox dataSource="{actionForm.firstname}"/>
          Lastname:
          <netui:textBox dataSource="{actionForm.lastname}"/>
          <netui:anchor formSubmit="true">Submit</netui:anchor>
      </netui:form>

If the formSubmit attribute is set to true and no onClick attribute is set, the following JavaScript function will be written to the HTML page. This JavaScript function will be referenced by the onclick attribute of the generated anchor tag.

  function anchor_submit_form(netuiName, newAction)
  {
    for (var i=0; i<document.forms.length; i++) {
       if (document.forms[i].id == netuiName) {
          document.forms[i].method = "POST";
          document.forms[i].action = newAction;
          document.forms[i].submit();
       }
     }
  }

The JavaScript function will be invoked by the generated HTML anchor tag as follows:

 <a href="/WebApp/tagSamples/anchor/formSubmit.do" 
       onClick='anchor_submit_form("Netui_Form_0","/WebApp/tagSamples/anchor/formSubmit.do");return false;'>Submit</a>

Custom JavaScript Functions

It is possible to write a custom onClick JavaScript event handler that would do additional work, for example form validation, and still POST the form correctly. To accomplish this, add the custom JavaScript method to the page:

 function SubmitFromAnchor() 
 { 
   // implement custom logic here

   for(var i=0; i<document.forms.length; i++) 
   { 
     // submit to the action /aWebapp/formPost.do
     if (document.forms[i].action == "/aWebapp/formPost.do") 
     { 
       document.forms[i].method="POST"; 
       document.forms[i].action="/aWebapp/formPost.do"; 
       document.forms[i].submit(); 
     } 
   } 
 }
Then reference the JavaScript method from the <netui:anchor> tag:
 <netui:anchor formSubmit="true" onClick="SubmitFromAnchor(); return false;">Submit</netui:anchor>

Code Sample

[BEA_HOME]/weblogic81/samples/workshop/SamplesApp/WebApp/tagSamples/netui/anchor/
Beadoc.see:
<netui:anchor> Tag Sample, How Do I: Define an Action That Forwards Users to Another Page?
Beadoc.tagdescription:

The <netui:anchor> tag generates a link to another document or invokes an action method in the Controller file. The <netui:anchor> tag also supports JavaScript-based form submission and URL re-writing.

An anchor must have one of five attributes to correctly create the hyperlink:

  • action - the action method invoked by clicking the hyperlink
  • forward - the forward to redirect to
  • href - the URL to go to
  • linkName - an internal place in the page to move to
  • page - the module-relative page URL to which this hyperlink will be rendered


Field Summary
protected  AnchorTag.State _state
           
static String HREF
           
protected  String id
           
 
Fields inherited from class com.bea.wlw.netui.tags.AbstractBaseTag
ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, JAVASCRIPT_STATUS, NETUI_UNIQUE_CNT
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface com.bea.wlw.netui.tags.html.HtmlConstants
ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEIGHT, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, RULES, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TD, TEXT, TEXTAREA, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Anchor()
           
 
Method Summary
 void addParameter(String name, Object value)
          Adds a URL parameter to the generated hyperlink.
protected  String calculateURL(String forward, String href, String page, String location)
          Return the complete URL to which this hyperlink will direct the user.
protected  boolean createAnchorBeginTag(weblogic.utils.UnsyncStringBuffer results, weblogic.utils.UnsyncStringBuffer script, TagRenderingBase trb, boolean encodeAction)
          This method will take all of the internal variables and create an anchor.
 int doAfterBody()
          Save the body content of the Anchor.
 int doEndTag()
          Render the hyperlink.
 int doStartTag()
          Prepare the hyperlink for rendering
 String getAccessKey()
          Gets the accessKey attribute value.
 String getAction()
          Return the action of the Anchor.
protected  String getFormAction()
           
protected  String getFormActionURL()
           
 boolean getFormSubmit()
          Return the formSubmit indicator.
 String getForward()
          Return the forward name of the Anchor.
 String getHref()
          Return the href of the Anchor.
 String getId()
          Return the ID associated with this tag.
 String getLinkName()
          Return the link name of the Anchor.
 String getLocation()
          Returns the anchor to be added to the end of the generated hyperlink.
 String getOnBlur()
          Gets the onBlur javascript event.
 String getOnClick()
          Gets the onClick javascript event.
 String getOnDblClick()
          Gets the onDblClick javascript event.
 String getOnFocus()
          Gets the onFocus javascript event.
 String getOnKeyDown()
          Gets the onKeyDown javascript event.
 String getOnKeyPress()
          Gets the onKeyPress javascript event.
 String getOnKeyUp()
          Gets the onKeyUp javascript event.
 String getOnMouseDown()
          Gets the onMouseDown javascript event.
 String getOnMouseMove()
          Gets the onMouseMove javascript event.
 String getOnMouseOut()
          Gets the onMouseOut javascript event.
 String getOnMouseOver()
          Gets the onMouseOver javascript event.
 String getOnMouseUp()
          Gets the onMouseUp javascript event.
 String getPage()
          Returns the module-relative page URL to which this hyperlink will be rendered.
protected  String getRealFormName()
          This will get the real name of the form.
 String getStyle()
          Gets the style of the rendered html tag.
 String getStyleClass()
          Gets the style class of the rendered html tag.
 String getTabindex()
          Gets the tabIndex of the rendered html tag.
 String getTagId()
          Return the ID of the tag.
 String getTagName()
          Returns the name of the Tag.
 String getTarget()
          Returns the window target.
protected  void localRelease()
          Release any acquired resources.
 void setAccessKey(String accessKey)
          Sets the accessKey attribute value.
 void setAction(String action)
          Set the name of the action for the Anchor.
 void setAttribute(String name, String value)
          Set an attribute value.
 void setFormSubmit(boolean formSubmit)
          Sets the formSubmit indicator.
 void setForward(String forward)
          Sets the forward name of the Anchor.
 void setHref(String href)
          Sets the href of the Anchor.
 void setId(String id)
          Set the ID attribute of the tag.
 void setLinkName(String linkName)
          Sets the link name of the Anchor.
 void setLocation(String location)
          Sets the anchor to be added to the end of the generated hyperlink.
 void setOnBlur(String onblur)
          Sets the onBlur javascript event.
 void setOnClick(String onclick)
          Sets the onClick javascript event.
 void setOnDblClick(String ondblclick)
          Sets the onDblClick javascript event.
 void setOnFocus(String onfocus)
          Sets the onFocus javascript event.
 void setOnKeyDown(String onkeydown)
          Sets the onKeyDown javascript event.
 void setOnKeyPress(String onkeypress)
          Sets the onKeyPress javascript event.
 void setOnKeyUp(String onkeyup)
          Sets the onKeyUp javascript event.
 void setOnMouseDown(String onmousedown)
          Sets the onMouseDown javascript event.
 void setOnMouseMove(String onmousemove)
          Sets the onMouseMove javascript event.
 void setOnMouseOut(String onmouseout)
          Sets the onMouseOut javascript event.
 void setOnMouseOver(String onmouseover)
          Sets the onMouseOver javascript event.
 void setOnMouseUp(String onmouseup)
          Sets the onMouseUp javascript event.
 void setPage(String page)
          Sets the module-relative page URL to which this hyperlink will be rendered.
 void setStyle(String style)
          Sets the style of the rendered html tag.
 void setStyleClass(String styleClass)
          Sets the style class of the rendered html tag.
 void setTabindex(String tabindex)
          Sets the tabIndex of the rendered html tag.
 void setTagId(String tagId)
          Set the ID of the tag.
 void setTarget(String target)
          Sets the window target.
protected  String stripSlashes(String original)
           
 
Methods inherited from class com.bea.wlw.netui.tags.AbstractBaseTag
addTagIdMapping, containsExpression, evaluateAttributeToString, evaluateExpression, filter, filter, formatErrorString, formatString, getAttribute, getErrorsReport, getExpressionEvaluator, getJavaScriptUtils, getNearestForm, getNextId, getQualifiedBundleName, getScriptReporter, getUserLocale, hasErrors, isExpression, prepForRendering, registerAttribute, registerError, registerTagError, release, removeAttribute, renderAttribute, renderAttributes, reportErrors, rewriteName, setPageContext, updateExpression, write
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setParent
 

Field Detail

_state

protected AnchorTag.State _state

id

protected String id

HREF

public static final String HREF
See Also:
Constant Field Values
Constructor Detail

Anchor

public Anchor()
Method Detail

getTagName

public String getTagName()
Returns the name of the Tag.

Specified by:
getTagName in class AbstractBaseTag

setAttribute

public void setAttribute(String name,
                         String value)
                  throws javax.servlet.jsp.JspException
Set an attribute value. The name represents the name of the attribute. The value represents the value and may contain a netui expression. This method may result in errors being generated. This requires that the tag buffer its body and write attributes in the end tag. For the anchor tag it is not legal to set the id, name, or href attributes with this method.

Specified by:
setAttribute in interface IAttributeConsumer
Parameters:
name - The name of the attribute. This value may not be null or the empty string.
value - The value of the attribute. This may contain a netui expression.
Throws:
javax.servlet.jsp.JspException - A JspException may be thrown if there is an error setting the attribute.

getAction

public String getAction()
Return the action of the Anchor.

Returns:
a String representing the action name of the Anchor.

setAction

public void setAction(String action)
Set the name of the action for the Anchor.

Parameters:
action - - the name of the action to set for the Anchor.
Beadoc.attributedescription:
The action method to invoke. The action method must be in the Controller file of the Page Flow directory.
Beadoc.attributesyntaxvalue:
string_action
Beadoc.databindable:
false

getFormSubmit

public boolean getFormSubmit()
Return the formSubmit indicator.

Returns:
a String representing whether or not the enclosing Form should be submitted.

setFormSubmit

public void setFormSubmit(boolean formSubmit)
Sets the formSubmit indicator.

Parameters:
formSubmit - - whether or not the enclosing Form should be submitted.
Beadoc.attributedescription:
Boolean. If formSubmit is set to true, and the <netui:anchor> tag is within a <netui:form> tag, then the form data will be submitted to the method named in the <netui:form> tag's action attribute.
Beadoc.attributesyntaxvalue:
boolean_formSubmit
Beadoc.databindable:
false

getForward

public String getForward()
Return the forward name of the Anchor.

Returns:
the Anchor's logical forward name

setForward

public void setForward(String forward)
Sets the forward name of the Anchor.

Parameters:
forward - - the logical forward name from which to retrieve the hyperlink URI.
Beadoc.attributedescription:
The logical forward name from which to retrieve the hyperlink URI.
Beadoc.attributesyntaxvalue:
string_forward
Beadoc.databindable:
false

getHref

public String getHref()
Return the href of the Anchor.

Returns:
the hyperlink URI

setHref

public void setHref(String href)
Sets the href of the Anchor.

Parameters:
href - - the hyperlink URI for the Anchor.
Beadoc.attributedescription:
The URL to go to.
Beadoc.attributesyntaxvalue:
string_href
Beadoc.databindable:
false

getId

public String getId()
Return the ID associated with this tag.

Overrides:
getId in class javax.servlet.jsp.tagext.TagSupport
Returns:
the ID.

setId

public void setId(String id)
Set the ID attribute of the tag.

Overrides:
setId in class javax.servlet.jsp.tagext.TagSupport
Parameters:
id - - the ID.
Beadoc.attributedescription:
The id attribute is deprecated, use the tagId attribute instead. The id attribute of the rendered HTML tag.
Beadoc.attributesyntaxvalue:
string_id
Beadoc.databindable:
false

getTagId

public String getTagId()
Return the ID of the tag. The id may be rewritten by the container (such as a portal) to make sure it is unique. JavaScript my lookup the actual id of the element by looking it up in the netui_names table written into the HTML.

Returns:
the tagId.

setTagId

public void setTagId(String tagId)
Set the ID of the tag.

Parameters:
tagId - - the tagId.
Beadoc.attributedescription:

String value. Sets the id (or name) attribute of the rendered HTML tag. Note that the real id attribute rendered in the browser may be changed by the application container (for example, Portal containers may change the rendered id value to ensure the uniqueness of id's on the page). In this case, the real id rendered in the browser may be looked up through the JavaScript function getNetuiTagName( tagId, tag ).

For example, assume that some tag's tagId attribute is set to foo.

    <netui:textBox tagId="foo" />

Then the following JavaScript function will return the real id attribute rendered in the browser:

    getNetuiTagName( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function getNetuiTagName( tagId, tag ). For example, assume that there is a <netui:form> whose tagId attribute is set to bar.

    <netui:form tagId="bar" >

Then the following JavaScript function will return the <netui:form> element and its children (packaged as an array).

    document[getNetuiTagName( "bar", this )]

To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.

    document[getNetuiTagName("bar", this)][getNetuiTagName("foo", this)].value

The second parameter ensures that the JavaScript function begins its search within the correct Portlet scope. Pass the JavaScript keyword this as the second parameter. For detailed information on using the function getNetuiTagName( tagId, tag ) see Using JavaScript in Page Flow and Portal Applications.

Beadoc.attributesyntaxvalue:
string_tagId
Beadoc.databindable:
false

getLinkName

public String getLinkName()
Return the link name of the Anchor.

Returns:
the linkName

setLinkName

public void setLinkName(String linkName)
Sets the link name of the Anchor.

Parameters:
linkName - - the link name for the Anchor.
Beadoc.attributedescription:
An internal place on the page to go to.
Beadoc.attributesyntaxvalue:
string_linkName
Beadoc.databindable:
false

getLocation

public String getLocation()
Returns the anchor to be added to the end of the generated hyperlink.

Returns:
the name of the location anchor.

setLocation

public void setLocation(String location)
Sets the anchor to be added to the end of the generated hyperlink.

Parameters:
location - - the name of the location anchor.
Beadoc.attributedescription:
Location within the URI to visit.
Beadoc.attributesyntaxvalue:
string_location
Beadoc.databindable:
false

getPage

public String getPage()
Returns the module-relative page URL to which this hyperlink will be rendered.

Returns:
the page URL.

setPage

public void setPage(String page)
Sets the module-relative page URL to which this hyperlink will be rendered.

Parameters:
page - - the page URL.
Beadoc.attributedescription:
The page attribute is deprecated. The module-relative page URL to which this hyperlink will be rendered.
Beadoc.attributesyntaxvalue:
string_page
Beadoc.databindable:
false

getTarget

public String getTarget()
Returns the window target.

Returns:
the window target.

getAccessKey

public String getAccessKey()
Gets the accessKey attribute value.

Returns:
the accessKey value.

setAccessKey

public void setAccessKey(String accessKey)
Sets the accessKey attribute value. This should key value of the keyboard navigation key. It is recommended not to use the following values because there are often used by browsers A, C, E, F, G, H, V, left arrow, and right arrow.

Parameters:
accessKey - - the accessKey value.
Beadoc.attributedescription:
The keyboard navigation key for the element. The following values are not recommended because they are often used by browsers: A, C, E, F, G, H, V, left arrow, and right arrow
Beadoc.attributesyntaxvalue:
string_accessKey
Beadoc.databindable:
false

setTarget

public void setTarget(String target)
Sets the window target.

Parameters:
target - - the window target.
Beadoc.attributedescription:
The window target.
Beadoc.attributesyntaxvalue:
string_action
Beadoc.databindable:
false

getOnBlur

public String getOnBlur()
Gets the onBlur javascript event.

Returns:
the onBlur event.

setOnBlur

public void setOnBlur(String onblur)
Sets the onBlur javascript event.

Parameters:
onblur - - the onBlur event.
Beadoc.attributedescription:
The onBlur JavaScript event.
Beadoc.attributesyntaxvalue:
string_onBlur
Beadoc.databindable:
false

getOnFocus

public String getOnFocus()
Gets the onFocus javascript event.

Returns:
the onFocus event.

setOnFocus

public void setOnFocus(String onfocus)
Sets the onFocus javascript event.

Parameters:
onfocus - - the onFocus event.
Beadoc.attributedescription:
The onFocus JavaScript event.
Beadoc.attributesyntaxvalue:
string_onFocus
Beadoc.databindable:
false

addParameter

public void addParameter(String name,
                         Object value)
                  throws javax.servlet.jsp.JspException
Adds a URL parameter to the generated hyperlink.

Specified by:
addParameter in interface URLParams
Parameters:
name - - the name of the parameter to be added.
value - - the value of the parameter to be added (a String or String[]).
Throws:
javax.servlet.jsp.JspException

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Prepare the hyperlink for rendering

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
Save the body content of the Anchor.

Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Overrides:
doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Render the hyperlink.

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

createAnchorBeginTag

protected boolean createAnchorBeginTag(weblogic.utils.UnsyncStringBuffer results,
                                       weblogic.utils.UnsyncStringBuffer script,
                                       TagRenderingBase trb,
                                       boolean encodeAction)
                                throws javax.servlet.jsp.JspException
This method will take all of the internal variables and create an anchor.

Throws:
javax.servlet.jsp.JspException

localRelease

protected void localRelease()
Release any acquired resources.

Overrides:
localRelease in class AbstractBaseTag

calculateURL

protected String calculateURL(String forward,
                              String href,
                              String page,
                              String location)
                       throws javax.servlet.jsp.JspException
Return the complete URL to which this hyperlink will direct the user.

Throws:
javax.servlet.jsp.JspException - if an exception is thrown calculating the value
Exclude:

getFormAction

protected String getFormAction()
Exclude:

getRealFormName

protected String getRealFormName()
This will get the real name of the form. This is set in the id attribute.

Returns:
The String real name of the containing form.

getFormActionURL

protected String getFormActionURL()
Exclude:

stripSlashes

protected String stripSlashes(String original)
Exclude:

setTabindex

public void setTabindex(String tabindex)
Sets the tabIndex of the rendered html tag.

Parameters:
tabindex - - the tab index.
Beadoc.attributedescription:
The tabIndex of the rendered HTML tag. This attribute determines the position of the rendered HTML tag in the sequence of tags that the user may advance through by pressing the TAB key.
Beadoc.attributesyntaxvalue:
string_tabIndex
Beadoc.databindable:
false

getTabindex

public String getTabindex()
Gets the tabIndex of the rendered html tag.

Returns:
the tabindex.

setStyle

public void setStyle(String style)
Sets the style of the rendered html tag.

Parameters:
style - - the html style.
Beadoc.attributedescription:
The style of the rendered HTML tag.
Beadoc.attributesyntaxvalue:
string_Style
Beadoc.databindable:
false

getStyle

public String getStyle()
Gets the style of the rendered html tag.

Returns:
the style.

setStyleClass

public void setStyleClass(String styleClass)
Sets the style class of the rendered html tag.

Parameters:
styleClass - - the html style class.
Beadoc.attributedescription:
The class of the rendered HTML tag.
Beadoc.attributesyntaxvalue:
string_Class
Beadoc.databindable:
false

getStyleClass

public String getStyleClass()
Gets the style class of the rendered html tag.

Returns:
the style class.

getOnClick

public String getOnClick()
Gets the onClick javascript event.

Returns:
the onClick event.

setOnClick

public void setOnClick(String onclick)
Sets the onClick javascript event.

Parameters:
onclick - - the onClick event.
Beadoc.attributedescription:
The onClick JavaScript event.
Beadoc.attributesyntaxvalue:
string_onClick
Beadoc.databindable:
false

getOnDblClick

public String getOnDblClick()
Gets the onDblClick javascript event.

Returns:
the onDblClick event.

setOnDblClick

public void setOnDblClick(String ondblclick)
Sets the onDblClick javascript event.

Parameters:
ondblclick - - the onDblClick event.
Beadoc.attributedescription:
The onDblClick JavaScript event.
Beadoc.attributesyntaxvalue:
string_onDblClick
Beadoc.databindable:
false

getOnKeyDown

public String getOnKeyDown()
Gets the onKeyDown javascript event.

Returns:
the onKeyDown event.

setOnKeyDown

public void setOnKeyDown(String onkeydown)
Sets the onKeyDown javascript event.

Parameters:
onkeydown - - the onKeyDown event.
Beadoc.attributedescription:
The onKeyDown JavaScript event.
Beadoc.attributesyntaxvalue:
string_onKeyDown
Beadoc.databindable:
false

getOnKeyPress

public String getOnKeyPress()
Gets the onKeyPress javascript event.

Returns:
the onKeyPress event.

setOnKeyPress

public void setOnKeyPress(String onkeypress)
Sets the onKeyPress javascript event.

Parameters:
onkeypress - - the onKeyPress event.
Beadoc.attributedescription:
The onKeyPress JavaScript event.
Beadoc.attributesyntaxvalue:
string_onKeyPress
Beadoc.databindable:
false

getOnKeyUp

public String getOnKeyUp()
Gets the onKeyUp javascript event.

Returns:
the onKeyUp event.

setOnKeyUp

public void setOnKeyUp(String onkeyup)
Sets the onKeyUp javascript event.

Parameters:
onkeyup - - the onKeyUp event.
Beadoc.attributedescription:
The onKeyUp JavaScript event.
Beadoc.attributesyntaxvalue:
string_onKeyUp
Beadoc.databindable:
false

getOnMouseDown

public String getOnMouseDown()
Gets the onMouseDown javascript event.

Returns:
the onMouseDown event.

setOnMouseDown

public void setOnMouseDown(String onmousedown)
Sets the onMouseDown javascript event.

Parameters:
onmousedown - - the onMouseDown event.
Beadoc.attributedescription:
The onMouseDown JavaScript event.
Beadoc.attributesyntaxvalue:
string_onMouseDown
Beadoc.databindable:
false

getOnMouseMove

public String getOnMouseMove()
Gets the onMouseMove javascript event.

Returns:
the onMouseMove event.

setOnMouseMove

public void setOnMouseMove(String onmousemove)
Sets the onMouseMove javascript event.

Parameters:
onmousemove - - the onMouseMove event.
Beadoc.attributedescription:
The onMouseMove JavaScript event.
Beadoc.attributesyntaxvalue:
string_onMouseMove
Beadoc.databindable:
false

getOnMouseOut

public String getOnMouseOut()
Gets the onMouseOut javascript event.

Returns:
the onMouseOut event.

setOnMouseOut

public void setOnMouseOut(String onmouseout)
Sets the onMouseOut javascript event.

Parameters:
onmouseout - - the onMouseOut event.
Beadoc.attributedescription:
The onMouseOut JavaScript event.
Beadoc.attributesyntaxvalue:
string_onMouseOut
Beadoc.databindable:
false

getOnMouseOver

public String getOnMouseOver()
Gets the onMouseOver javascript event.

Returns:
the onMouseOver event.

setOnMouseOver

public void setOnMouseOver(String onmouseover)
Sets the onMouseOver javascript event.

Parameters:
onmouseover - - the onMouseOver event.
Beadoc.attributedescription:
The onMouseOver JavaScript event.
Beadoc.attributesyntaxvalue:
string_onMouseOver
Beadoc.databindable:
false

getOnMouseUp

public String getOnMouseUp()
Gets the onMouseUp javascript event.

Returns:
the onMouseUp event.

setOnMouseUp

public void setOnMouseUp(String onmouseup)
Sets the onMouseUp javascript event.

Parameters:
onmouseup - - the onMouseUp event.
Beadoc.attributedescription:
The onMouseUp JavaScript event.
Beadoc.attributesyntaxvalue:
string_onMouseUp
Beadoc.databindable:
false

BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs.