ilog.views.chart.faces.interactor

Class IlvChartPanInteractor

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.faces.interactor.IlvInteractor

ilog.views.faces.interactor.IlvDragRectInteractor

ilog.views.chart.faces.interactor.IlvChartPanInteractor

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, IlvDHTMLConstants, IlvFacesConstants, IlvFacesInteractor, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class IlvChartPanInteractor
extends IlvDragRectInteractor
implements IlvChartConstants, IlvDHTMLConstants

This defines an interactor that allows you to pan on a chart view. This interactor must be set on a chart view to take effect.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.faces.interactor.IlvDragRectInteractor

LINE_WIDTH_DEFAULT_VALUE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_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
IlvChartPanInteractor() Creates a new IlvChartPanInteractor 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.
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
boolean	isXPanAllowed() Returns true if the user can zoom along the x-axis.
boolean	isYPanAllowed() Returns true if the user can zoom along the y-axis.
void	restoreState(FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(FacesContext context) Returns the state of this component.
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.
void	setXPanAllowed(boolean xPanAllowed) Sets whether a zoom along the x-axis is allowed.
void	setYPanAllowed(boolean yPanAllowed) Sets whether a zoom along the y-axis is allowed.
void	updateModel(FacesContext ctx) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.faces.interactor.IlvDragRectInteractor

getLineColor, getLineWidth, setLineColor, setLineWidth

Methods inherited from class ilog.views.faces.interactor.IlvInteractor

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartPanInteractor

public IlvChartPanInteractor()

Creates a new IlvChartPanInteractor instance.

Method Detail

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getFamily

public String getFamily()

Returns the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate renderer for this component instance.

Overrides:

getFamily in class IlvDragRectInteractor

Returns:

The family to which this component belongs.

isXPanAllowed

public boolean isXPanAllowed()

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

Returns:

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

isYPanAllowed

public boolean isYPanAllowed()

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

Returns:

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

setXPanAllowed

public void setXPanAllowed(boolean xPanAllowed)

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

Parameters:

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

setYPanAllowed

public void setYPanAllowed(boolean yPanAllowed)

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

Parameters:

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

getActionName

public String getActionName()

Returns the action name that will be sent by the client representation to the servlet. The default value is PAN_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 PAN_ACTION_NAME.

Parameters:

actionName - The action name used by this interactor.

updateModel

public void updateModel(FacesContext ctx)

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Overrides:

updateModel in class IlvDragRectInteractor

Parameters:

ctx - The current faces context.

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvDragRectInteractor

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(FacesContext context,
                         Object stateObj)

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvDragRectInteractor

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.