ilog.views.faces.dhtml.renderkit

Class IlvDHTMLImageButtonRenderer

java.lang.Object

jakarta.faces.render.Renderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLSizedRenderer

ilog.views.faces.dhtml.renderkit.IlvDHTMLImageButtonRenderer

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, Serializable

public class IlvDHTMLImageButtonRenderer
extends IlvDHTMLSizedRenderer

The IlvDHTMLImageButtonRenderer is the renderer designed to render an IlvDHTMLImageButton component. This renderer generates an instance of the IlvImageButtonProxy 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 class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

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
IlvDHTMLImageButtonRenderer() Creates a new IlvDHTMLImageButtonRenderer instance.

Method Summary

Modifier and Type	Method and Description
void	decode(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent component) The "Apply Request Values" phase of JSF life cycle implementation.
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 facesContext, jakarta.faces.component.UIComponent component) Emits the setting of the properties of the JavaScript object representation.
protected jakarta.faces.component.UIForm	getParentForm(jakarta.faces.context.FacesContext context, jakarta.faces.component.UICommand command) Deprecated. Beginning with JViews 8.1, UIComponent might be contain in forms not inheriting from UIForm. Use IlvRendererUtil.getFormClientId(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) instead.
static String	getRendererType() Returns the type of this renderer.
protected 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.
protected 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.
protected 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 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.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, 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

IlvDHTMLImageButtonRenderer

public IlvDHTMLImageButtonRenderer()

Creates a new IlvDHTMLImageButtonRenderer instance.

Method Detail

getRendererType

public static String getRendererType()

Returns the type of this renderer.

Returns:

The type of this renderer.

renderStartDT

protected 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

renderEndDT

protected 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

renderAttributesDT

protected 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

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 facesContext,
                                   jakarta.faces.component.UIComponent component)
                            throws IOException

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

Overrides:

emitJSSetProperties in class IlvDHTMLRenderer

Parameters:

facesContext - The current faces context.

component - The component processed by this renderer.

Throws:

IOException

getParentForm

@Deprecated
protected jakarta.faces.component.UIForm getParentForm(jakarta.faces.context.FacesContext context,
                                                                   jakarta.faces.component.UICommand command)

Deprecated. Beginning with JViews 8.1, UIComponent might be contain in forms not inheriting from UIForm. Use IlvRendererUtil.getFormClientId(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) instead.

Returns the enclosing form component if found, null otherwise.

Parameters:

context - The faces context.

command - The base component to start the search with.

Returns:

The enclosing form or null if not found.

resolveDependencies

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

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

Specified by:

resolveDependencies in class IlvDHTMLRenderer

Parameters:

component - The component processed by this renderer.

depManager - The dependency manager.

decode

public void decode(jakarta.faces.context.FacesContext context,
                   jakarta.faces.component.UIComponent component)

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

Overrides:

decode in class IlvDHTMLSizedRenderer