oracle.adf.view.faces.component.html
Class HtmlScript

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.html.HtmlScript

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlScript

extends UIXComponentBase

The script bean supports both the importing of libraries and inline scripts. This class is derived from MarlinBean for backwards-compatibility only. The only methods supported are those found on BaseMutableUINode. On pages targeted to mobile devices, scripts should only be used to enhance the user experience, not to provide correct behavior, because not all mobile devices support scripting.

Example:

Example of a simple Javascript function script.

     <script>
      <contents>
       function doubleIt()
       { 
         var proxy = new TableProxy('table1');
         var currTextField = proxy.getFormElement('numbers', 0);
         var dbl = 2 * (currTextField.value - 0);
         proxy._form.doubleField.value = dbl; 
       }
      </contents>
     </script>

Almost the same example, but using the text attribute.

       <script text="function doubleOrTriple()
                     {
                       var p = new TableProxy('table1');
                       var c = p.getFormElement('numbers', 0);
                       var t = (c.value - 0);
                       if (t &lt; 10)
                       { t *= 2 }
                       else 
                       { t *= 3}
                       p._form.newValueField.value = t;
                     }"/>

It does not support any children.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	GENERATES_CONTENT_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SOURCE_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TEXT_KEY
static FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

HtmlScript()
Construct an instance of the HtmlScript.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
Style	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getSource() Gets the URI of a script library to import.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getText() Gets the inline script
boolean	isGeneratesContent() Gets if the script generates content using document.write() or document.writeln(), set this to true.
void	setGeneratesContent(boolean generatesContent) Sets if the script generates content using document.write() or document.writeln(), set this to true.
void	setInlineStyle(Style inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setSource(java.lang.String source) Sets the URI of a script library to import.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setText(java.lang.String text) Sets the inline script

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, broadcast, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FacesBean.Type TYPE

TEXT_KEY

public static final PropertyKey TEXT_KEY

SOURCE_KEY

public static final PropertyKey SOURCE_KEY

GENERATES_CONTENT_KEY

public static final PropertyKey GENERATES_CONTENT_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlScript

public HtmlScript()

Construct an instance of the HtmlScript.

Method Detail

getText

public final java.lang.String getText()

Gets the inline script

setText

public final void setText(java.lang.String text)

Sets the inline script

getSource

public final java.lang.String getSource()

Gets the URI of a script library to import.

setSource

public final void setSource(java.lang.String source)

Sets the URI of a script library to import.

isGeneratesContent

public final boolean isGeneratesContent()

Gets if the script generates content using document.write() or document.writeln(), set this to true. It defaults to false.

setGeneratesContent

public final void setGeneratesContent(boolean generatesContent)

Sets if the script generates content using document.write() or document.writeln(), set this to true. It defaults to false.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getInlineStyle

public final Style getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(Style inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase