Skip navigation links

org.apache.myfaces.trinidad.component.html
Class HtmlScript

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.html.HtmlScript

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlScript

extends UIXComponentBase

<html:p> The script component supports both the importing of libraries and inline scripts. </html:p>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	GENERATES_CONTENT_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SOURCE_KEY
static PropertyKey	TEXT_KEY
static FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	HtmlScript() Construct an instance of the HtmlScript.
protected	HtmlScript(java.lang.String rendererType) Construct an instance of the HtmlScript.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getSource() Gets the URI of a script library to import.
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	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setSource(java.lang.String source) Sets the URI of a script library to import.
void	setText(java.lang.String text) Sets the inline script

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

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

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_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.

HtmlScript

protected HtmlScript(java.lang.String rendererType)

Construct an instance of the HtmlScript.

Method Detail

getText

public final java.lang.String getText()

Gets the inline script

Returns:

the new text value

setText

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

Sets the inline script

Parameters:

text - the new text value

getSource

public final java.lang.String getSource()

Gets the URI of a script library to import.

Returns:

the new source value

setSource

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

Sets the URI of a script library to import.

Parameters:

source - the new source value

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.

Returns:

the new generatesContent value

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.

Parameters:

generatesContent - the new generatesContent value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

partialTriggers - the new partialTriggers value

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase

Skip navigation links