ilog.views.diagrammer.faces.dhtml.renderkit
Class IlvFacesDiagrammerViewRenderer

java.lang.Object
  javax.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.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerBaseRenderer
                          ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerViewRenderer

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, Serializable

Direct Known Subclasses:

IlvFacesMapViewRenderer

public class IlvFacesDiagrammerViewRenderer
extends IlvFacesDiagrammerBaseRenderer

This class is the DHTML renderer for a IlvFacesDHTMLDiagrammerView component.
This renderer generates an instance of the IlvDiagrammerViewProxy 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 interface ilog.views.faces.IlvFrameworkConstants

ACTION_NAME, AUTO_REFRESH, BOUNDING_BOX, CONSTRAINED_ON_CONTENTS, INTERACTOR, INTERACTOR_ID, MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, NB_BUTTONS, ORIENTATION, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, PAN_FACTOR, STATIC_LAYERS_COUNT, TILE_SIZE, VISIBLE_LAYERS, ZOOM_FACTOR, ZOOM_LEVELS

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Fields inherited from interface ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, 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

AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, 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, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

Constructor Summary

IlvFacesDiagrammerViewRenderer()
Creates a new IlvFacesDiagrammerViewRenderer instance.

Method Summary

void	decode(FacesContext context, 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.
protected void	emitJSCreation(FacesContext context, UIComponent component) 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.
protected void	emitJSSetProperties(FacesContext context, UIComponent component) Emits the setting of the properties of the JavaScript object representation.
void	encodeBegin(FacesContext context, UIComponent component) 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.
static String	getRendererType() Returns the type of this renderer.
protected void	maybeSaveViewInSession(FacesContext context, UIComponent component) Stores in the session the bound SDM view instance to be displayed and the ID property as identifier if the view is not null.
protected boolean	processData(FacesContext context, UIComponent component, Object data) This method processes the data property to configure the component correctly.
protected void	resetData(UIComponent component) Resets the data property to properly remove the configuration of a specific component.
protected void	resolveDependencies(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.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerBaseRenderer

getScriptDescriptor, getScriptDescriptor, getTiledRenderer, installImageMapAreaGenerator, maybeSaveViewInsession

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

getRendersChildren, 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 javax.faces.render.Renderer

convertClientId, encodeChildren, getConvertedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesDiagrammerViewRenderer

public IlvFacesDiagrammerViewRenderer()

Creates a new IlvFacesDiagrammerViewRenderer instance.

Method Detail

getRendererType

public static String getRendererType()

Returns the type of this renderer.

Returns:

The type of this renderer.

resolveDependencies

protected void resolveDependencies(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.

emitJSCreation

protected void emitJSCreation(FacesContext context,
                              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 IlvFacesDiagrammerBaseRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

emitJSSetProperties

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

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

Overrides:

emitJSSetProperties in class IlvFacesViewRenderer

Parameters:

context - The current faces context.

component - The component that is being rendered.

Throws:

IOException

encodeBegin

public void encodeBegin(FacesContext context,
                        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

decode

public void decode(FacesContext context,
                   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 IlvFacesViewRenderer

resetData

protected void resetData(UIComponent component)
                  throws Exception

Resets the data property to properly remove the configuration of a specific component.

Parameters:

component - The component that is being rendered.

Throws:

Exception

Since:

JViews 8.0

processData

protected boolean processData(FacesContext context,
                              UIComponent component,
                              Object data)
                       throws Exception

This method processes the data property to configure the component correctly.

Parameters:

context - The faces context.

component - The component that is being rendered.

data - The data to set.

Returns:

If the configuration succeeds, true is returned.

Throws:

Exception

Since:

JViews 8.0

maybeSaveViewInSession

protected void maybeSaveViewInSession(FacesContext context,
                                      UIComponent component)

Stores in the session the bound SDM view instance to be displayed and the ID property as identifier if the view is not null.

Specified by:

maybeSaveViewInSession in class IlvFacesDiagrammerBaseRenderer

Parameters:

context - The current faces context.

component - The component that is being rendered.

Since:

JViews 7.5