ilog.views.maps.faces.dhtml.renderkit

Class IlvFacesGoogleViewRenderer

java.lang.Object

jakarta.faces.render.Renderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

ilog.views.maps.faces.dhtml.renderkit.IlvFacesGoogleViewRenderer

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, Serializable

public class IlvFacesGoogleViewRenderer
extends IlvDHTMLRenderer

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

Since:

JViews 8.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION store/retrieve apiVersion instance JSF tag
static String	CONTROLS store/retrieve the tag containing the list of optional Google maps controls
static String	DIAGRAMMER store/retrieve diagrammer instance JSF tag
static String	KEY store/retrieve Google application key JSF tag
static String	LAT store/retrieve initial latitude or map center JSF tag
static String	LEVEL store/retrieve initial map zoom level JSF tag
static String	LON store/retrieve initial longitude or map center JSF tag
static String	NODE_MOVABLE store/retrieve the tag indicating whether nodes can be moved
static String	V2 value of API_VERSION for Google Maps version 2
static String	V3 value of API_VERSION for Google Maps version 3

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

Method Summary

Modifier and Type	Method and Description
protected void	emitJSCreation(jakarta.faces.context.FacesContext facesContext, jakarta.faces.component.UIComponent component) Creates the google map client component
protected void	emitJSSetProperties(jakarta.faces.context.FacesContext ctx, jakarta.faces.component.UIComponent component) Initializes Google map client component
void	encodeBegin(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Creates a DIV element, loads the JViews scripts and sets up styles.
void	encodeEnd(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Imports Google maps scripts with the correct key, import local scripts and emits the construction instruction.
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

decode, 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

Field Detail

LAT

public static final String LAT

store/retrieve initial latitude or map center JSF tag

See Also:

Constant Field Values

CONTROLS

public static final String CONTROLS

store/retrieve the tag containing the list of optional Google maps controls

See Also:

Constant Field Values

NODE_MOVABLE

public static final String NODE_MOVABLE

store/retrieve the tag indicating whether nodes can be moved

See Also:

Constant Field Values

KEY

public static final String KEY

store/retrieve Google application key JSF tag

See Also:

Constant Field Values

LON

public static final String LON

store/retrieve initial longitude or map center JSF tag

See Also:

Constant Field Values

LEVEL

public static final String LEVEL

store/retrieve initial map zoom level JSF tag

See Also:

Constant Field Values

DIAGRAMMER

public static final String DIAGRAMMER

store/retrieve diagrammer instance JSF tag

See Also:

Constant Field Values

API_VERSION

public static final String API_VERSION

store/retrieve apiVersion instance JSF tag

Since:

JViews 8.8

See Also:

Constant Field Values

V2

public static final String V2

value of API_VERSION for Google Maps version 2

Since:

JViews 8.8

See Also:

Constant Field Values

V3

public static final String V3

value of API_VERSION for Google Maps version 3

Since:

JViews 8.8

See Also:

Constant Field Values

Constructor Detail

IlvFacesGoogleViewRenderer

public IlvFacesGoogleViewRenderer()

Creates a new IlvFacesGoogleViewRenderer.

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.

encodeBegin

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

Creates a DIV element, loads the JViews scripts and sets up styles. 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:

Renderer.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

Imports Google maps scripts with the correct key, import local scripts and emits the construction instruction. 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

See Also:

Renderer.encodeEnd(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)

emitJSSetProperties

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

Initializes Google map client component

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

Creates the google map client component

Specified by:

emitJSCreation in class IlvDHTMLRenderer

Parameters:

facesContext - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

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. There are no dependencies for this component.

Specified by:

resolveDependencies in class IlvDHTMLRenderer

Parameters:

component - The component processed by this renderer.

dependencyManager - The dependency manager.

See Also:

IlvDHTMLRenderer.resolveDependencies(jakarta.faces.component.UIComponent, ilog.views.faces.dhtml.renderkit.IlvDependencyManager)