ilog.tgo.faces.graph.dhtml.renderkit

Class IltFacesGraphViewRenderer

java.lang.Object

jakarta.faces.render.Renderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLSizedRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLViewRenderer

ilog.views.faces.dhtml.renderkit.IlvFacesViewRenderer

ilog.tgo.faces.graph.dhtml.renderkit.IltFacesGraphViewRenderer

All Implemented Interfaces:

IltFacesJTGOConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, Serializable

Direct Known Subclasses:

IltFacesEquipmentViewRenderer, IltFacesNetworkViewRenderer

public abstract class IltFacesGraphViewRenderer
extends IlvFacesViewRenderer
implements IlvFrameworkConstants, IltFacesJTGOConstants

This class implements the common DHTML renderer features for the network and equipment Faces components.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRAPHVIEW The graph view property of a component.
static String	VIEW_PROXY_UTIL_CLASS The JavaScript class name that is needed by proxy views' DHTML representation.

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

Fields inherited from interface ilog.tgo.faces.IltFacesJTGOConstants

CONTEXT, DATA_SOURCE, DATA_SOURCE_ID, DEFAULT_STYLE_SHEET, EQUIPMENT, NETWORK, OBJECT_ACTION_MB, PROPERTY_ACCESSOR, STYLE_SHEETS

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltFacesGraphViewRenderer() Creates a new IltFacesGraphViewRenderer instance.

Method Summary

Modifier and Type	Method and Description
protected abstract ilog.tgo.faces.graph.component.internal.IltFacesGraphCleaner	createCleaner(IlpGraphView view) Returns a new cleaner to be used for the provided view.
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Implementation of the "Apply Values from Request" phase of the JSF lifecycle.
protected void	emitJSCreation(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Emits the JavaScript proxy declaration of the component that is rendered.
protected void	emitJSSetProperties(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Emit DHTML code to set properties of the JavaScript proxy objects.
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.
protected abstract IlpGraphicComponent	getGraphicComponent(jakarta.faces.component.UIComponent component) Returns the underlying IlpGraphicComponent associated with the provided component.
protected abstract String	getProxyClass() Returns the JavaScript proxy class.
protected abstract IlpGraphView	getViewFromComponent(jakarta.faces.component.UIComponent component) Returns the IlpGraphView from the provided component.
protected String	handleData(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Handles the data tag attribute of a graph based Faces component processed by this renderer.
protected void	maybeSaveViewInSession(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Stores in the session the bound TGO Graph view instance to be displayed using the ID property as identifier (if the view is not null).
protected void	persistStructures(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) If needed, persists the necessary structures in the session for proper functioning.
protected void	resolveDependencies(jakarta.faces.component.UIComponent component, IlvDependencyManager depManager) 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.IlvFacesViewRenderer

getRendererType, getRendersChildren, getScriptDescriptor, getScriptDescriptor, getTiledRenderer, installImageMapAreaGenerator, isTiled

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

createDHTMLHelper, encodeRecursive

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

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

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

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

Methods inherited from class jakarta.faces.render.Renderer

convertClientId, encodeChildren, getConvertedValue

Methods inherited from class java.lang.Object

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

Field Detail

GRAPHVIEW

public static final String GRAPHVIEW

The graph view property of a component.

See Also:

Constant Field Values

VIEW_PROXY_UTIL_CLASS

public static final String VIEW_PROXY_UTIL_CLASS

The JavaScript class name that is needed by proxy views' DHTML representation.

Since:

JViews 8.0

See Also:

Constant Field Values

Internal: do not use!

Constructor Detail

IltFacesGraphViewRenderer

protected IltFacesGraphViewRenderer()

Creates a new IltFacesGraphViewRenderer instance.

Method Detail

createCleaner

protected abstract ilog.tgo.faces.graph.component.internal.IltFacesGraphCleaner createCleaner(IlpGraphView view)

Returns a new cleaner to be used for the provided view.

Since:

JViews 8.0

Internal: do not use!

getProxyClass

protected abstract String getProxyClass()

Returns the JavaScript proxy class.

Internal: do not use!

getGraphicComponent

protected abstract IlpGraphicComponent getGraphicComponent(jakarta.faces.component.UIComponent component)
                                                    throws Exception

Returns the underlying IlpGraphicComponent associated with the provided component.

Parameters:

component - The UIComponent of interest.

Returns:

The underlying IlpGraphicComponent associated with the component being processed by this renderer.

Throws:

Exception - if not able to get the IlpGraphicComponent from the provided UIComponent.

Since:

JViews 8.0

Internal: do not use!

getViewFromComponent

protected abstract IlpGraphView getViewFromComponent(jakarta.faces.component.UIComponent component)
                                              throws Exception

Returns the IlpGraphView from the provided component.

Parameters:

component - The UIComponent of interest.

Returns:

The IlpGraphView associated with the component being processed by this renderer.

Throws:

Exception - if not able to get the IlpGraphView from the provided UIComponent.

Since:

JViews 8.8

Internal: do not use!

resolveDependencies

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

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

Overrides:

resolveDependencies in class IlvFacesViewRenderer

Parameters:

component - The component processed by this renderer.

depManager - The dependency manager.

emitJSSetProperties

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

Emit DHTML code to set properties of the JavaScript proxy objects.

Overrides:

emitJSSetProperties in class IlvFacesViewRenderer

Parameters:

context - The current faces context.

component - The IltFacesGraphView component processed by this renderer.

Throws:

IOException

emitJSCreation

protected void emitJSCreation(jakarta.faces.context.FacesContext context,
                              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.

Overrides:

emitJSCreation in class IlvFacesViewRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

maybeSaveViewInSession

protected void maybeSaveViewInSession(jakarta.faces.context.FacesContext context,
                                      jakarta.faces.component.UIComponent component)

Stores in the session the bound TGO Graph view instance to be displayed using the ID property as identifier (if the view is not null).

Parameters:

context - The current faces context.

component - The component that is being rendered.

Since:

JViews 8.7

persistStructures

protected void persistStructures(jakarta.faces.context.FacesContext context,
                                 jakarta.faces.component.UIComponent component)

If needed, persists the necessary structures in the session for proper functioning.

Parameters:

context - The current faces context.

component - The component processed by this renderer.

Since:

JViews 8.0

Internal: do not use!

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 lifecycle. It decodes the request updating the faces component accordingly.

Overrides:

decode in class IlvFacesViewRenderer

Parameters:

context - The current faces context.

component - The IltFacesGraphView component processed by this renderer.

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 IlvDHTMLSizedRenderer

Throws:

IOException

handleData

protected String handleData(jakarta.faces.context.FacesContext context,
                            jakarta.faces.component.UIComponent component)

Handles the data tag attribute of a graph based Faces component processed by this renderer.

It also handles the other variations of data:

• project tag attribute
• dataSource tag attribute
• dataSourceId tag attribute

Parameters:

context - The current faces context.

component - The IltFacesGraphView Faces component.

Returns:

Either one of

• PROJECT: data is the URL of a TGO project
• DATA_SOURCE_ID: data is a data source ID
• null: data is unknown or just empty

Internal: do not use!