ilog.views.faces.dhtml.renderkit
Class IlvDHTMLRenderer

java.lang.Object
  javax.faces.render.Renderer
      ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, Serializable

Direct Known Subclasses:

IlvDHTMLSizedRenderer, IlvFacesDiagrammerDataSourceRenderer, IlvFacesLayerVisibilityToolRenderer, IlvFacesMenuRenderer, IlvFacesSelectionManagerRenderer, IlvInteractorRenderer

public abstract class IlvDHTMLRenderer
extends Renderer
implements Serializable, IlvDHTMLConstants, IlvFacesConstants

The IlvDHTMLRenderer is the base class for the JViews Faces DHTML renderers. This class implements the dependency and script managing mechanisms. Each subclass must do the following:

• override the encodeEnd method;
• call the super.codeEnd method;
• call each emitXXX method in the correct order. Each subclass could also override each emitXXX method to perform its own rendering.

  Since:

  JViews 6.0

  See Also:

  Serialized Form

  Field Summary

  static IlvScriptDescriptor

  scriptDescriptor Returns the script descriptor of the renderer.

  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

  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

  Constructor Summary

  protected

  IlvDHTMLRenderer() Creates a new IlvDHTMLRenderer instance.

  Method Summary

  void	decode(FacesContext context, UIComponent component) The "Apply Request Values" phase of JSF life cycle implementation.
  protected abstract void	emitJSCreation(FacesContext facesContext, UIComponent component) Emits the JavaScript proxy declaration of the component that is rendered.
  protected void	emitJSSetProperties(FacesContext facesContext, UIComponent component) Emits the setting of the properties of the JavaScript object representation.
  protected void	emitJSToHTML(ResponseWriter writer, UIComponent component) Emits the toHTML method of the JavaScript representation of the current component that is being rendered.
  protected void	emitOnLoadHandler(FacesContext facesContext, UIComponent component) Emits the JavaScript handlers on the onload event of the page.
  protected void	emitResolvedDependencies(ResponseWriter writer, UIComponent component) Emits the JavaScript of the dependencies that have been resolved by the creation of the component that is currently rendered.
  protected void	emitScriptsLoad(ResponseWriter writer) Emits the scripts that are need to be loaded before the creation of the JavaScript objects by the subclassed renderer.
  protected void	emitStateSavingHTMLObject(ResponseWriter writer, UIComponent component) Emits the hidden HTML object that will hold the state of the rendered component.
  void	encodeBegin(FacesContext context, UIComponent component) This method is used in the "Render Response" phase of the JSF life cycle implementation.
  void	encodeEnd(FacesContext context, UIComponent component) This method is used in the "Render Response" phase of the JSF life cycle implementation.
  protected HashMap	getParameterMap(FacesContext context, UIComponent component) Returns the parameters extracted from the request for this component.
  IlvScriptDescriptor	getScriptDescriptor() Returns the script descriptor of this renderer.
  IlvScriptDescriptor	getScriptDescriptor(UIComponent component) Returns the script descriptor of this component.
  HashMap	getTestParameterMap()
  protected void	renderAttributesDT(FacesContext context, UIComponent component, ResponseWriter out) Renders the tag attributes of the component representation during the design time.
  protected void	renderEndDT(FacesContext context, UIComponent component, ResponseWriter out) Renders the closing tag of the component representation during the design time.
  protected void	renderStartDT(FacesContext context, UIComponent component, ResponseWriter out) Renders the opening tag of the component representation during design time.
  protected abstract void	resolveDependencies(UIComponent component, IlvDependencyManager dependencyManager) Resolves the dependencies needed by this component or register listeners on the dependency manager if some dependencies cannot be resolved.
  protected void	resolveDependency(UIComponent component, String property, String id, IlvDependencyManager dependencyManager) Resolves a dependency from the component parameter to another designed by the ID parameter.
  protected void	resolveDependency(UIComponent component, String property, String id, IlvDependencyManager dependencyManager, ComponentCreationListener listener) Resolves a dependency from the component parameter to another designed by the ID parameter.
  protected void	resolveVBDependency(UIComponent component, String property, String propertyId, IlvDependencyManager dependencyManager) Resolves a dependency on a component.
  protected void	resolveVBDependency(UIComponent component, String property, String propertyId, IlvDependencyManager dependencyManager, ComponentCreationListener listener) Resolves a dependency on a component.
  void	setTestParameterMap(HashMap map)

  Methods inherited from class javax.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

  scriptDescriptor

  public static final IlvScriptDescriptor scriptDescriptor

  Returns the script descriptor of the renderer. Include the main class of the JavaScript proxies.

  Constructor Detail

  IlvDHTMLRenderer

  protected IlvDHTMLRenderer()

  Creates a new IlvDHTMLRenderer instance.

  Method Detail

  decode

  public void decode(FacesContext context,
                     UIComponent component)

  The "Apply Request Values" phase of JSF life cycle implementation.

  Overrides:

  decode in class Renderer

  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 Renderer

  Throws:

  IOException

  encodeEnd

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

  Throws:

  IOException

  renderStartDT

  protected void renderStartDT(FacesContext context,
                               UIComponent component,
                               ResponseWriter out)
                        throws IOException

  Renders the opening tag of the component representation during design time. This method is called by the encodeBegin method if we are in design time mode.

  Parameters:

  context - The current faces context.

  component - The component processed by this renderer.

  out - The response writer.

  Throws:

  IOException

  renderEndDT

  protected void renderEndDT(FacesContext context,
                             UIComponent component,
                             ResponseWriter out)
                      throws IOException

  Renders the closing tag of the component representation during the design time. This method is called by the encodeEnd method if we are in design time mode. It renders a simple representation of the component using exclusively simple HTML elements.

  Parameters:

  context - The current faces context.

  component - The component processed by this renderer.

  out - The response writer.

  Throws:

  IOException

  renderAttributesDT

  protected void renderAttributesDT(FacesContext context,
                                    UIComponent component,
                                    ResponseWriter out)
                             throws IOException

  Renders the tag attributes of the component representation during the design time. This method is called by the encodeBegin method if we are in design time mode.

  Parameters:

  context - The current faces context.

  component - The component processed by this renderer.

  out - The response writer.

  Throws:

  IOException

  resolveDependencies

  protected abstract void resolveDependencies(UIComponent component,
                                              IlvDependencyManager dependencyManager)

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

  Parameters:

  component - The component processed by this renderer.

  dependencyManager - The dependency manager.

  emitJSCreation

  protected abstract void emitJSCreation(FacesContext facesContext,
                                         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.

  Parameters:

  facesContext - The current faces context.

  component - The component processed by this renderer.

  Throws:

  IOException

  emitScriptsLoad

  protected void emitScriptsLoad(ResponseWriter writer)
                          throws IOException

  Emits the scripts that are need to be loaded before the creation of the JavaScript objects by the subclassed renderer.

  Parameters:

  writer - The response writer.

  Throws:

  IOException

  emitResolvedDependencies

  protected void emitResolvedDependencies(ResponseWriter writer,
                                          UIComponent component)
                                   throws IOException

  Emits the JavaScript of the dependencies that have been resolved by the creation of the component that is currently rendered.

  Parameters:

  writer - The response writer.

  component - The component rendered.

  Throws:

  IOException

  Since:

  JViews 8.1

  emitStateSavingHTMLObject

  protected void emitStateSavingHTMLObject(ResponseWriter writer,
                                           UIComponent component)
                                    throws IOException

  Emits the hidden HTML object that will hold the state of the rendered component.

  Parameters:

  writer - The response writer.

  component - The component rendered.

  Throws:

  IOException

  emitJSToHTML

  protected void emitJSToHTML(ResponseWriter writer,
                              UIComponent component)
                       throws IOException

  Emits the toHTML method of the JavaScript representation of the current component that is being rendered.

  Parameters:

  writer - The current response writer.

  component - The component processed by this renderer.

  Throws:

  IOException

  emitJSSetProperties

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

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

  Parameters:

  facesContext - The current faces context.

  component - The component processed by this renderer.

  Throws:

  IOException

  emitOnLoadHandler

  protected void emitOnLoadHandler(FacesContext facesContext,
                                   UIComponent component)
                            throws IOException

  Emits the JavaScript handlers on the onload event of the page.

  Parameters:

  facesContext - The current faces context.

  component - The component processed by this renderer.

  Throws:

  IOException

  resolveVBDependency

  protected void resolveVBDependency(UIComponent component,
                                     String property,
                                     String propertyId,
                                     IlvDependencyManager dependencyManager,
                                     ComponentCreationListener listener)

  Resolves a dependency on a component. If the dependency is resolved, the property parameter of the component is set to the resolved component. If not, or if the dependency was not rendered already, the listener is registered on the dependency manager.

  Parameters:

  component - The component that needs a property to be resolved.

  property - The property to be set if the dependency is resolved.

  propertyId - The corresponding property identifier.

  dependencyManager - The dependency manager.

  listener - The listener to register if the dependency component is not found.

  Since:

  JViews 6.5

  resolveVBDependency

  protected void resolveVBDependency(UIComponent component,
                                     String property,
                                     String propertyId,
                                     IlvDependencyManager dependencyManager)

  Resolves a dependency on a component. If the dependency is resolved, the property parameter of the component is set to the resolved component. If not, or if the dependency was not rendered already, the listener is registered on the dependency manager.

  Parameters:

  component - The component that needs a property to be resolved.

  property - The property to be set if the dependency is resolved.

  propertyId - The corresponding property identifier.

  dependencyManager - The dependency manager.

  Since:

  JViews 6.5

  resolveDependency

  protected void resolveDependency(UIComponent component,
                                   String property,
                                   String id,
                                   IlvDependencyManager dependencyManager,
                                   ComponentCreationListener listener)

  Resolves a dependency from the component parameter to another designed by the ID parameter. If the ID is null, do nothing. If the dependency is resolved, the property parameter of the component is set to the resolved component. If not, or if the dependency was not rendered already, the listener is registered on the dependency manager.

  Parameters:

  component - The component that needs a property to be resolved.

  property - The property to be set if the dependency is resolved.

  id - The ID of the component to be resolved.

  dependencyManager - The dependency manager.

  listener - The listener to register if the dependency component is not found.

  resolveDependency

  protected void resolveDependency(UIComponent component,
                                   String property,
                                   String id,
                                   IlvDependencyManager dependencyManager)

  Resolves a dependency from the component parameter to another designed by the ID parameter. If the ID is null, do nothing. If the dependency is resolved the property parameter of the component is set to the resolved component. If not, a default ComponentCreationListener is registered on the dependency manager.

  Parameters:

  component - The component that needs a property to be resolved.

  property - The property to be set if the dependency is resolved.

  id - The ID of the component to be resolved.

  dependencyManager - The dependency manager.

  getParameterMap

  protected HashMap getParameterMap(FacesContext context,
                                    UIComponent component)

  Returns the parameters extracted from the request for this component.

  Parameters:

  context - The current faces context.

  component - The component decoded by this renderer.

  Returns:

  A map containing the parameters extracted from the request.

  getTestParameterMap

  public HashMap getTestParameterMap()

  Since:

  JViews 6.5

  Internal method or field: do not use!

  setTestParameterMap

  public void setTestParameterMap(HashMap map)

  Since:

  JViews 6.5

  Internal method or field: do not use!

  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.

  Returns:

  The script descriptor of this component.

  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.

  Parameters:

  component - The component to render

  Returns:

  The script descriptor of this component.

  Since:

  JViews 8.0