ilog.views.faces.dhtml.interactor

Class IlvFacesAjaxInteractor

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.faces.interactor.IlvInteractor

ilog.views.faces.dhtml.interactor.IlvFacesAjaxInteractor

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, IlvFacesInteractor, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

public class IlvFacesAjaxInteractor
extends IlvInteractor

The IlvFacesAjaxInteractor is the class for JViews Faces ajax interactor component. An ajax interactor is used to generate a JSF 3 specific jsf.ajax.request() query to render other JSF 3 components on the page

Since:

JViews 8.7

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesAjaxInteractor() Creates a new IlvFacesAjaxInteractor instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component (its class name).
String	getFamily() Returns the identifier of the component family to which this component belongs.
String	getRender() Get the render targets for ajax interactor.
String	getRendererType()
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(jakarta.faces.context.FacesContext context) Returns the state of this component.
void	setRender(String render) Set the render targets for ajax interactor.
void	updateModel(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.faces.interactor.IlvInteractor

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesAjaxInteractor

public IlvFacesAjaxInteractor()

Creates a new IlvFacesAjaxInteractor instance.

Method Detail

getFamily

public String getFamily()

Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate renderer for this component instance.

Overrides:

getFamily in class IlvInteractor

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component (its class name).

Returns:

The component type.

getRendererType

public String getRendererType()

Overrides:

getRendererType in class jakarta.faces.component.UIComponentBase

updateModel

public void updateModel(jakarta.faces.context.FacesContext context)

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Overrides:

updateModel in class IlvInteractor

Parameters:

context - The current faces context.

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvInteractor

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.

getRender

public String getRender()

Get the render targets for ajax interactor.

Returns:

The render targets IDs separated by spaces as a String object.

setRender

public void setRender(String render)

Set the render targets for ajax interactor.

Parameters:

render - The render targets IDs separated by spaces.