ilog.views.chart.faces.dhtml.taglib

Class IlvChartZoomInteractorTag

java.lang.Object

javax.faces.webapp.UIComponentTagBase

javax.faces.webapp.UIComponentClassicTagBase

javax.faces.webapp.UIComponentTag

javax.faces.webapp.UIComponentBodyTag

ilog.views.faces.taglib.IlvBaseTag

ilog.views.faces.taglib.IlvInteractorTag

ilog.views.faces.taglib.IlvDragRectInteractorTag

ilog.views.chart.faces.dhtml.taglib.IlvChartZoomInteractorTag

All Implemented Interfaces:

IlvChartConstants, IlvDHTMLConstants, IlvFacesConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class IlvChartZoomInteractorTag
extends IlvDragRectInteractorTag
implements IlvChartConstants

This class defines a custom tag handler for a DHTML zoom interactor component.

Since:

JViews 6.0

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

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

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getActionName() Returns the action name that will be sent by the client representation to the servlet.
String	getComponentType() Returns the component type for the component that is or will be bound to this tag.
String	getRendererType() Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly.
String	getXZoomAllowed() Returns true if the user can zoom along the x-axis.
String	getYZoomAllowed() Returns true if the user can zoom along the y-axis.
void	setActionName(String actionName) Sets the action name that will be sent to the servlet that generates the image when this interactor is used on a view.
protected void	setProperties(UIComponent component) Overrides properties and attributes of the specified component if the corresponding properties of this tag handler instance were explicitly set.
void	setxZoomAllowed(String xZoomAllowed) Sets whether a zoom along the x-axis is allowed.
void	setXZoomAllowed(String xZoomAllowed) Sets whether a zoom along the x-axis is allowed.
void	setyZoomAllowed(String yZoomAllowed) Sets whether a zoom along the y-axis is allowed.
void	setYZoomAllowed(String yZoomAllowed) Sets whether a zoom along the y-axis is allowed.

Methods inherited from class ilog.views.faces.taglib.IlvDragRectInteractorTag

getLineColor, getLineWidth, setLineColor, setLineWidth

Methods inherited from class ilog.views.faces.taglib.IlvInteractorTag

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

Methods inherited from class ilog.views.faces.taglib.IlvBaseTag

getPartialTriggers, getStringArray, setPartialTriggers, setProperty, setVBProperty, testSetProperties

Methods inherited from class javax.faces.webapp.UIComponentTag

createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class javax.faces.webapp.UIComponentTagBase

getELContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

IlvChartZoomInteractorTag

public IlvChartZoomInteractorTag()

Creates a new IlvChartZoomInteractorTag instance.

Method Detail

setProperties

protected void setProperties(UIComponent component)

Overrides properties and attributes of the specified component if the corresponding properties of this tag handler instance were explicitly set.

Overrides:

setProperties in class IlvDragRectInteractorTag

Parameters:

component - The UIComponent whose properties are to be overridden.

getComponentType

public String getComponentType()

Returns the component type for the component that is or will be bound to this tag.

This implementation returns null, subclasses must override this method to return the appropriate value.

Overrides:

getComponentType in class IlvDragRectInteractorTag

getRendererType

public String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. This implementation return null, subclasses must override this method to return the appropriate value.

Overrides:

getRendererType in class IlvBaseTag

getXZoomAllowed

public String getXZoomAllowed()

Returns true if the user can zoom along the x-axis.

Returns:

true if the user can zoom along the x-axis, false otherwise.

getYZoomAllowed

public String getYZoomAllowed()

Returns true if the user can zoom along the y-axis.

Returns:

true if the user can zoom along the y-axis, false otherwise.

setXZoomAllowed

public void setXZoomAllowed(String xZoomAllowed)

Sets whether a zoom along the x-axis is allowed.

Parameters:

xZoomAllowed - A Boolean that indicates whether a zoom along the x-axis is allowed.

setYZoomAllowed

public void setYZoomAllowed(String yZoomAllowed)

Sets whether a zoom along the y-axis is allowed.

Parameters:

yZoomAllowed - A Boolean that indicates whether a zoom along the y-axis is allowed.

setxZoomAllowed

public void setxZoomAllowed(String xZoomAllowed)

Sets whether a zoom along the x-axis is allowed.

Parameters:

xZoomAllowed - A Boolean that indicates whether a zoom along the x-axis is allowed.

Since:

JViews 6.5

setyZoomAllowed

public void setyZoomAllowed(String yZoomAllowed)

Sets whether a zoom along the y-axis is allowed.

Parameters:

yZoomAllowed - A Boolean that indicates whether a zoom along the y-axis is allowed.

Since:

JViews 6.5

getActionName

public String getActionName()

Returns the action name that will be sent by the client representation to the servlet. The default value is ZOOM_ACTION_NAME.

Returns:

The action name used by this interactor.

setActionName

public void setActionName(String actionName)

Sets the action name that will be sent to the servlet that generates the image when this interactor is used on a view. The default value is ZOOM_ACTION_NAME.

Parameters:

actionName - The action name used by this interactor.