ilog.views.faces.dhtml.renderkit

Class IlvFacesPanToolRenderer

java.lang.Object

jakarta.faces.render.Renderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLSizedRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLViewHelperRenderer

ilog.views.faces.dhtml.renderkit.IlvFacesPanToolRenderer

All Implemented Interfaces:

IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, Serializable

public class IlvFacesPanToolRenderer
extends IlvDHTMLViewHelperRenderer
implements IlvDHTMLFrameworkConstants

This class is the DHTML renderer for a IlvFacesPanTool component.
This renderer generates an instance of the IlvPanToolProxy JavaScript proxy class.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

scriptDescriptor

Fields inherited from class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLFrameworkConstants

SESSION_ID_PREFIX, STATE_URL, STATIC_LAYERS_COUNT_PARAM, TILE_MANAGER, UPDATE_INTERVAL

Fields inherited from interface ilog.views.faces.IlvFrameworkConstants

AUTO_REFRESH, BOUNDING_BOX, COLOR, CONSTRAINED_ON_CONTENTS, GROUPABLE, HITMAP_LAYERS, IGNORE_CONTENT_ASPECT_RATIO, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, OPACITY, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TEMPLATE, TILE_SIZE, TOLERANCE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

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
IlvFacesPanToolRenderer() Creates a new IlvFacesPanToolRenderer instance.

Method Summary

Modifier and Type	Method and Description
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Implementation of the "Apply Values from Request" phase of the JSF life cycle.
protected void	emitJSCreation(jakarta.faces.context.FacesContext facesContext, jakarta.faces.component.UIComponent component) Emits the JavaScript proxy declaration of the component that is rendered.
protected void	emitJSSetProperties(jakarta.faces.context.FacesContext ctx, jakarta.faces.component.UIComponent component) Emits the setting of the properties of the JavaScript object representation.
static String	getRendererType() Returns the type of this renderer.
IlvScriptDescriptor	getScriptDescriptor() Returns the script descriptor of this renderer.

Methods inherited from class ilog.views.faces.dhtml.renderkit.IlvDHTMLViewHelperRenderer

resolveDependencies

Methods inherited from class ilog.views.faces.dhtml.renderkit.IlvDHTMLSizedRenderer

emitOnLoadHandler, encodeBegin, encodeEnd, getPlaceHolderId, getReferenceNodeRef, getReferencodeNodeRef, renderAttributesDT, renderEndDT, renderStartDT

Methods inherited from class ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

emitJSToHTML, emitResolvedDependencies, emitScriptsLoad, emitStateSavingHTMLObject, getParameterMap, getScriptDescriptor, getTestParameterMap, resolveDependency, resolveDependency, resolveVBDependency, resolveVBDependency, setTestParameterMap

Methods inherited from class jakarta.faces.render.Renderer

convertClientId, encodeChildren, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesPanToolRenderer

public IlvFacesPanToolRenderer()

Creates a new IlvFacesPanToolRenderer instance.

Method Detail

getScriptDescriptor

public IlvScriptDescriptor getScriptDescriptor()

Returns the script descriptor of this renderer. This object describes all the scripts that need to be imported before being able to create the JavaScript representation of this component.

Overrides:

getScriptDescriptor in class IlvDHTMLRenderer

Returns:

The script descriptor of this component.

getRendererType

public static String getRendererType()

Returns the type of this renderer.

Returns:

The type of this renderer.

emitJSCreation

protected void emitJSCreation(jakarta.faces.context.FacesContext facesContext,
                              jakarta.faces.component.UIComponent component)
                       throws IOException

Emits the JavaScript proxy declaration of the component that is rendered. Warning: the toHTML must NOT be generated here. The ID of the JavaScript object must be the client ID of the component. It must be called by the subclass.

Specified by:

emitJSCreation in class IlvDHTMLRenderer

Parameters:

facesContext - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

emitJSSetProperties

protected void emitJSSetProperties(jakarta.faces.context.FacesContext ctx,
                                   jakarta.faces.component.UIComponent component)
                            throws IOException

Emits the setting of the properties of the JavaScript object representation.

Overrides:

emitJSSetProperties in class IlvDHTMLViewHelperRenderer

Parameters:

ctx - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

decode

public void decode(jakarta.faces.context.FacesContext context,
                   jakarta.faces.component.UIComponent component)

Implementation of the "Apply Values from Request" phase of the JSF life cycle. Decodes from the request the update data for this component, and updates the component according to this data.

Overrides:

decode in class IlvDHTMLViewHelperRenderer