ilog.views.maps.faces.dhtml.renderkit

Class IlvFacesLayerVisibilityToolRenderer

java.lang.Object

jakarta.faces.render.Renderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

ilog.views.maps.faces.dhtml.renderkit.IlvFacesLayerVisibilityToolRenderer

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, Serializable

public class IlvFacesLayerVisibilityToolRenderer
extends IlvDHTMLRenderer

This class is the DHTML renderer for a IlvFacesLayerVisibilityTool component.
This renderer generates a IlvFacesLayerVisibilityTool Javascript object.

Since:

JViews 8.0

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

Method Summary

Modifier and Type	Method and Description
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Implements 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.
void	encodeBegin(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) This method is used in the "Render Response" phase of the JSF life cycle implementation.
void	encodeEnd(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) This method is used in the "Render Response" phase of the JSF life cycle implementation.
static String	getRendererType() Returns the type of this renderer.
IlvScriptDescriptor	getScriptDescriptor() Returns the script descriptor of this renderer.
protected void	resolveDependencies(jakarta.faces.component.UIComponent component, IlvDependencyManager dependencyManager) Resolves the dependencies needed by this component or register listeners on the dependency manager if some dependencies cannot be resolved.

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

emitJSToHTML, emitOnLoadHandler, emitResolvedDependencies, emitScriptsLoad, emitStateSavingHTMLObject, getParameterMap, getScriptDescriptor, getTestParameterMap, renderAttributesDT, renderEndDT, renderStartDT, 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

IlvFacesLayerVisibilityToolRenderer

public IlvFacesLayerVisibilityToolRenderer()

Creates a new IlvFacesLayerVisibilityToolRenderer 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.

decode

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

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

Overrides:

decode in class IlvDHTMLRenderer

resolveDependencies

protected void resolveDependencies(jakarta.faces.component.UIComponent component,
                                   IlvDependencyManager dependencyManager)

Resolves the dependencies needed by this component or register listeners on the dependency manager if some dependencies cannot be resolved.

Specified by:

resolveDependencies in class IlvDHTMLRenderer

Parameters:

component - The component processed by this renderer.

dependencyManager - The dependency manager.

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 IlvDHTMLRenderer

Parameters:

ctx - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

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

encodeBegin

public void encodeBegin(jakarta.faces.context.FacesContext context,
                        jakarta.faces.component.UIComponent component)
                 throws IOException

This method is used in the "Render Response" phase of the JSF life cycle implementation. It handles the start of the rendering process for the specified UIComponent to the output stream or writer associated with the response we are creating. Note that it is used at design time only.

Overrides:

encodeBegin in class IlvDHTMLRenderer

Throws:

IOException

See Also:

IlvDHTMLRenderer.encodeBegin(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)

encodeEnd

public void encodeEnd(jakarta.faces.context.FacesContext context,
                      jakarta.faces.component.UIComponent component)
               throws IOException

This method is used in the "Render Response" phase of the JSF life cycle implementation. It handles the end of the rendering of the current state of the specified UIComponent. This key method tries to resolve the dependencies and prepare the component for the emit methods.

Overrides:

encodeEnd in class IlvDHTMLRenderer

Throws:

IOException