Module org.omnifaces

Package org.omnifaces.component.script

Class ScriptFamily

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.script.ScriptFamily

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

Direct Known Subclasses:

DeferredScript, Notification, OnloadScript, ScriptErrorHandler, Socket, Sse

public abstract class ScriptFamily
extends UIComponentBase

Base class which is to be shared between all components of the Script family.

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY	The standard component family.

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
ScriptFamily()

Method Summary

Modifier and Type	Method	Description
void	encodeBegin(FacesContext context)	If this component is rendered, then start the <script> element.
void	encodeEnd(FacesContext context)	If this component is rendered, then end the <script> element.
String	getFamily()	Returns COMPONENT_FAMILY.
boolean	getRendersChildren()	Returns true.
protected boolean	moveToBody(ComponentSystemEvent event)	Move this ScriptFamily component to end of body and returns true if done so.

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family.

See Also:

• Constant Field Values

Constructor Details

ScriptFamily

public ScriptFamily()

Method Details

getFamily

public String getFamily()

Returns COMPONENT_FAMILY.

Specified by:

getFamily in class UIComponent

getRendersChildren

public boolean getRendersChildren()

Returns true.

Overrides:

getRendersChildren in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

If this component is rendered, then start the <script> element.

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

If this component is rendered, then end the <script> element.

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

moveToBody

protected boolean moveToBody(ComponentSystemEvent event)

Move this ScriptFamily component to end of body and returns true if done so. This method needs to be called from UIComponent.processEvent(ComponentSystemEvent) during PostAddToViewEvent or PostRestoreStateEvent. This has basically the same effect as setting target="body" on a component resource.

Parameters:

event - The involved event, which can be either PostAddToViewEvent or PostRestoreStateEvent.

Returns:

true if the move has taken place.