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

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

All Implemented Interfaces:

IlvFacesDiagrammerConstants, IlvDHTMLConstants, IlvDHTMLFrameworkConstants, IlvFacesConstants, IlvFrameworkConstants, Serializable

Direct Known Subclasses:

IlvFacesDashboardViewRenderer, IlvFacesDiagrammerViewRenderer

public abstract class IlvFacesDiagrammerBaseRenderer
extends IlvFacesViewRenderer
implements IlvFrameworkConstants, IlvFacesDiagrammerConstants

This class is the base renderer of JViews Diagrammer based view renderers.

Since:

JViews 8.0

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

IlvFacesDiagrammerBaseRenderer()
Creates a new IlvFacesDiagrammerBaseRenderer instance.

Method Summary

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.
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.
IlvScriptDescriptor	getScriptDescriptor(UIComponent component) Returns the script descriptor of this component. This object describes all the scripts that need to be imported before being able to create the JavaScript representation of this component.
protected IlvFacesTiledViewRenderer	getTiledRenderer() Returns the renderer of a tiled view.
protected void	installImageMapAreaGenerator(IlvFacesDHTMLViewSupport view) Installs the image map generator specified on all the objects contained by the manager.
protected void	maybeSaveViewInsession(FacesContext context, UIComponent component) Deprecated. Beginning with JViews 7.5 use maybeSaveViewInSession(FacesContext, UIComponent) instead.
protected abstract 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.

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

decode, emitJSSetProperties, getRendererType, getRendersChildren, isTiled, resolveDependencies

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

createDHTMLHelper, encodeRecursive

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

IlvFacesDiagrammerBaseRenderer

public IlvFacesDiagrammerBaseRenderer()

Creates a new IlvFacesDiagrammerBaseRenderer instance.

Method Detail

getTiledRenderer

protected IlvFacesTiledViewRenderer getTiledRenderer()

Returns the renderer of a tiled view.

Overrides:

getTiledRenderer in class IlvFacesViewRenderer

Returns:

The renderer of a tiled view.

Since:

JViews 8.0

getScriptDescriptor

public IlvScriptDescriptor getScriptDescriptor(UIComponent component)

Returns the script descriptor of this component. 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 IlvFacesViewRenderer

Parameters:

component - The component to render

Returns:

The script descriptor of this component.

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 IlvFacesViewRenderer

Returns:

The script descriptor of this component.

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 IlvFacesViewRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

maybeSaveViewInsession

protected void maybeSaveViewInsession(FacesContext context,
                                      UIComponent component)

Deprecated. Beginning with JViews 7.5 use maybeSaveViewInSession(FacesContext, UIComponent) instead.

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

Parameters:

context - The current faces context.

component - The component that is being rendered.

maybeSaveViewInSession

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

Parameters:

context - The current faces context.

component - The component that is being rendered.

installImageMapAreaGenerator

protected void installImageMapAreaGenerator(IlvFacesDHTMLViewSupport view)

Installs the image map generator specified on all the objects contained by the manager.

Overrides:

installImageMapAreaGenerator in class IlvFacesViewRenderer

Parameters:

view - The view component.