ilog.views.chart.faces.dhtml.renderkit

Class IlvChartLegendRenderer

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.chart.faces.dhtml.renderkit.IlvChartViewComponentRenderer

ilog.views.chart.faces.dhtml.renderkit.IlvChartLegendRenderer

All Implemented Interfaces:

IlvChartConstants, IlvDHTMLConstants, IlvFacesConstants, Serializable

public class IlvChartLegendRenderer
extends IlvChartViewComponentRenderer
implements IlvChartConstants

This class is the renderer for an IlvChartDHTMLLegend component. This renderer generates an instance of the IlvChartLegendProxy JavaScript proxy class.

See Also:

Serialized Form

Field Summary

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.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

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

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

Constructor Summary

Constructors

Constructor and Description
IlvChartLegendRenderer() Creates a new IlvChartLegendRenderer instance.

Method Summary

Modifier and Type	Method and Description
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) Implementation of the "Apply Values from Request" phase of the JSF life cycle.
protected void	emitJSCreation(jakarta.faces.context.FacesContext facesContext, jakarta.faces.component.UIComponent component) Emits the JavaScript proxy declaration of the component that is rendered.
protected void	emitJSSetProperties(jakarta.faces.context.FacesContext ctx, jakarta.faces.component.UIComponent component) Script files that must be included in the response before the rendering JavaScript code can be generated by this renderer.
static String	getRendererType() Returns the type of this renderer.
IlvScriptDescriptor	getScriptDescriptor() Returns the script descriptor of this renderer.
void	renderAttributesDT(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, jakarta.faces.context.ResponseWriter out) Renders the tag attributes of the component representation during the design time.
void	renderEndDT(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, jakarta.faces.context.ResponseWriter out) Closes the DIV opened in the renderStartDT method.
void	renderStartDT(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component, jakarta.faces.context.ResponseWriter out) Renders a DIV tag to represent the sized component in design time mode.
protected void	resolveDependencies(jakarta.faces.component.UIComponent component, IlvDependencyManager dependencyManager) 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.IlvDHTMLViewRenderer

createDHTMLHelper, encodeRecursive

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

emitOnLoadHandler, encodeBegin, encodeEnd, getPlaceHolderId, getReferenceNodeRef, getReferencodeNodeRef

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

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

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

IlvChartLegendRenderer

public IlvChartLegendRenderer()

Creates a new IlvChartLegendRenderer instance.

Method Detail

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 IlvDHTMLRenderer

Returns:

The script descriptor of this component.

getRendererType

public static String getRendererType()

Returns the type of this renderer.

Returns:

The type of this renderer.

emitJSCreation

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

Specified by:

emitJSCreation in class IlvDHTMLRenderer

Parameters:

facesContext - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

emitJSSetProperties

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

Script files that must be included in the response before the rendering JavaScript code can be generated by this renderer.

Overrides:

emitJSSetProperties in class IlvChartViewComponentRenderer

Parameters:

ctx - The current faces context.

component - The component that is being rendered.

Throws:

IOException

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 life cycle. Decodes from the request the update data for this component, and updates the component according to this data.

Overrides:

decode in class IlvChartViewComponentRenderer

resolveDependencies

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

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

Overrides:

resolveDependencies in class IlvDHTMLViewRenderer

Parameters:

component - The component processed by this renderer.

dependencyManager - The dependency manager.

renderStartDT

public void renderStartDT(jakarta.faces.context.FacesContext context,
                          jakarta.faces.component.UIComponent component,
                          jakarta.faces.context.ResponseWriter out)
                   throws IOException

Renders a DIV tag to represent the sized component in design time mode.

Overrides:

renderStartDT in class IlvDHTMLSizedRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

out - The response writer.

Throws:

IOException

renderAttributesDT

public void renderAttributesDT(jakarta.faces.context.FacesContext context,
                               jakarta.faces.component.UIComponent component,
                               jakarta.faces.context.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 IlvDHTMLSizedRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

out - The response writer.

Throws:

IOException

renderEndDT

public void renderEndDT(jakarta.faces.context.FacesContext context,
                        jakarta.faces.component.UIComponent component,
                        jakarta.faces.context.ResponseWriter out)
                 throws IOException

Closes the DIV opened in the renderStartDT method.

Overrides:

renderEndDT in class IlvDHTMLSizedRenderer

Parameters:

context - The current faces context.

component - The component processed by this renderer.

out - The response writer.

Throws:

IOException