ilog.views.faces.dhtml.renderkit
Class IlvDHTMLSizedRenderer

java.lang.Object
  extended by javax.faces.render.Renderer
      extended by ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer
          extended by ilog.views.faces.dhtml.renderkit.IlvDHTMLSizedRenderer
All Implemented Interfaces:
IlvDHTMLConstants, IlvFacesConstants, Serializable
Direct Known Subclasses:
IlvDHTMLImageButtonRenderer, IlvDHTMLViewHelperRenderer, IlvDHTMLViewRenderer, IlvFacesTiledViewRenderer, IlvMessageBoxRenderer

public abstract class IlvDHTMLSizedRenderer
extends IlvDHTMLRenderer

The IlvDHTMLSizedRenderer is the base class for sized component renderers. This renderer generates an instance of the IlvSizedViewProxy JavaScript proxy class.

Since:
JViews 6.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.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
IlvDHTMLSizedRenderer()
          Creates a new IlvDHTMLSizedRenderer instance.
 
Method Summary
 void decode(FacesContext context, UIComponent component)
          The "Apply Request Values" phase of JSF life cycle implementation.
protected  void emitOnLoadHandler(FacesContext ctx, UIComponent component)
          Emits the JavaScript handlers on the onload event of the page.
 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  String getPlaceHolderId(FacesContext ctx, UIComponent component)
          Returns the DOM ID of the place holder node of this component.
protected  String getReferenceNodeRef(FacesContext ctx, UIComponent component)
          Returns the DOM ID of the reference node of this component.
protected  String getReferencodeNodeRef(FacesContext ctx, UIComponent component)
          Deprecated. Beginning with JViews 8.0 use getReferenceNodeRef(FacesContext, UIComponent) instead.
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)
          Closes the DIV opened in the renderStartDT method.
protected  void renderStartDT(FacesContext context, UIComponent component, ResponseWriter out)
          Renders a DIV tag to represent the sized component in design time mode.
 
Methods inherited from class ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer
emitJSCreation, emitJSSetProperties, emitJSToHTML, emitResolvedDependencies, emitScriptsLoad, emitStateSavingHTMLObject, getParameterMap, getScriptDescriptor, getScriptDescriptor, getTestParameterMap, resolveDependencies, resolveDependency, resolveDependency, resolveVBDependency, resolveVBDependency, setTestParameterMap
 
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
 

Constructor Detail

IlvDHTMLSizedRenderer

public IlvDHTMLSizedRenderer()
Creates a new IlvDHTMLSizedRenderer instance.

Method Detail

getReferencodeNodeRef

protected String getReferencodeNodeRef(FacesContext ctx,
                                       UIComponent component)
Deprecated. Beginning with JViews 8.0 use getReferenceNodeRef(FacesContext, UIComponent) instead.

Returns the DOM ID of the reference node of this component.

Parameters:
ctx - The current faces context.
component - The component that being rendered.
Returns:
The ID of the reference node.

getReferenceNodeRef

protected String getReferenceNodeRef(FacesContext ctx,
                                     UIComponent component)
Returns the DOM ID of the reference node of this component.

Parameters:
ctx - The current faces context.
component - The component that being rendered.
Returns:
The ID of the reference node.
Since:
JViews 8.0

getPlaceHolderId

protected String getPlaceHolderId(FacesContext ctx,
                                  UIComponent component)
Returns the DOM ID of the place holder node of this component.

Parameters:
ctx - The current faces context.
component - The component that being rendered.
Returns:
The ID of the reference node.

decode

public void decode(FacesContext context,
                   UIComponent component)
The "Apply Request Values" phase of JSF life cycle implementation.

Overrides:
decode in class IlvDHTMLRenderer

renderStartDT

protected void renderStartDT(FacesContext context,
                             UIComponent component,
                             ResponseWriter out)
                      throws IOException
Renders a DIV tag to represent the sized component in design time mode.

Overrides:
renderStartDT in class IlvDHTMLRenderer
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
Closes the DIV opened in the renderStartDT method.

Overrides:
renderEndDT in class IlvDHTMLRenderer
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.

Overrides:
renderAttributesDT in class IlvDHTMLRenderer
Parameters:
context - The current faces context.
component - The component processed by this renderer.
out - The response writer.
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 IlvDHTMLRenderer
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 IlvDHTMLRenderer
Throws:
IOException

emitOnLoadHandler

protected void emitOnLoadHandler(FacesContext ctx,
                                 UIComponent component)
                          throws IOException
Emits the JavaScript handlers on the onload event of the page.

Overrides:
emitOnLoadHandler in class IlvDHTMLRenderer
Parameters:
ctx - The current faces context.
component - The component processed by this renderer.
Throws:
IOException


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.   . All Rights Reserved.