ilog.views.chart.faces.dhtml.component

Class IlvChartDHTMLOverview

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIGraphic

ilog.views.faces.component.IlvBasicView

ilog.views.faces.component.IlvBasicViewHelper

ilog.views.chart.faces.dhtml.component.IlvChartDHTMLOverview

All Implemented Interfaces:

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

public class IlvChartDHTMLOverview
extends IlvBasicViewHelper
implements IlvChartConstants, IlvDHTMLConstants

This class defines an overview to a JViews Faces DHTML chart view.
To link this overview to a chart view use the setViewId method.
If the chart displayed is in Cartesian mode, the overview displays a rectangle representing the current visible window displayed by the view linked to this overview.
This rectangle also allows this visible window to be panned.

Since:

JViews 6.0

See Also:

IlvChartDHTMLView, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	RESIZABLE_DEFAULT_VALUE Default value of resizable property

Fields inherited from class ilog.views.faces.component.IlvBasicView

DEFAULT_OBJECT_FINDER

Fields inherited from class javax.faces.component.UIGraphic

COMPONENT_FAMILY, COMPONENT_TYPE

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

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the identifier of the component family to which this component belongs.
Color	getLineColor() Returns a string representing the HTML color of the rectangle representing the main view.
int	getLineWidth() Returns the line width of the rectangle representing the main view.
String	getMessage() Returns the message displayed in the window status bar and in the message box if defined.
String	getWaitingImage() Returns the path to the image displayed when the view loads the image.
boolean	isAutoRefresh() Returns true if the overview is in auto refresh mode.
boolean	isResizable() Returns whether the view is resizable or not.
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	setAutoRefresh(boolean autoRefresh) Sets the auto refresh mode of the overview.
void	setLineColor(Color lineColor) Sets the line color of the rectangle representing the main view.
void	setLineWidth(int lineWidth) Sets the line width of the rectangle representing the main view.
void	setMessage(String message) Sets the message displayed in the window status bar and in the message box if defined.
void	setResizable(boolean resizable) Sets whether the view is resizable or not.
void	setWaitingImage(String waitingImage) Sets the path of the image displayed when the view loads the image.
void	updateModel(FacesContext ctx) This method updates the referenced values by the local values of the component if these values were updated from the client.

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

createViewHelper, getView, getViewId, setView, setViewId

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

clearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getDefaultObjectFinder, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidth

Methods inherited from class javax.faces.component.UIGraphic

getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

RESIZABLE_DEFAULT_VALUE

public static final Boolean RESIZABLE_DEFAULT_VALUE

Default value of resizable property

Since:

JViews 6.5

Constructor Detail

IlvChartDHTMLOverview

public IlvChartDHTMLOverview()

Creates a new IlvChartDHTMLOverview 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.

This implementation returns the fully qualified class name.

Overrides:

getFamily in class IlvBasicViewHelper

Returns:

The family to which this component belongs.

getLineWidth

public int getLineWidth()

Returns the line width of the rectangle representing the main view.

Returns:

The line width of rectangle representing the main view.

setLineWidth

public void setLineWidth(int lineWidth)

Sets the line width of the rectangle representing the main view.

Parameters:

lineWidth - The line width of the rectangle representing the main view.

getLineColor

public Color getLineColor()

Returns a string representing the HTML color of the rectangle representing the main view.

Returns:

The color of the rectangle representing the main view.

setLineColor

public void setLineColor(Color lineColor)

Sets the line color of the rectangle representing the main view.

Parameters:

lineColor - The color of the rectangle representing the main view.

isAutoRefresh

public boolean isAutoRefresh()

Returns true if the overview is in auto refresh mode. In this mode the overview will be recomputed each time an image is computed in the main view.

Returns:

true if the overview is in auto refresh mode.

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)

Sets the auto refresh mode of the overview. In this mode the overview is recomputed each time the main view is computed. If the auto refresh mode is disabled, it is possible to update the image displayed by calling the DHTML updateImage method on the overview proxy.

Parameters:

autoRefresh - A Boolean set to true if you want to activate the auto refresh mode.

getMessage

public String getMessage()

Returns the message displayed in the window status bar and in the message box if defined.

Returns:

The message displayed by the message box and the windows status bar.

setMessage

public void setMessage(String message)

Sets the message displayed in the window status bar and in the message box if defined.

Parameters:

message - The message displayed by the message box and the windows status bar.

getWaitingImage

public String getWaitingImage()

Returns the path to the image displayed when the view loads the image.

Returns:

The path to the image displayed when the view loads the image.

setWaitingImage

public void setWaitingImage(String waitingImage)

Sets the path of the image displayed when the view loads the image.

Parameters:

waitingImage - The path of the image displayed when the view loads the image.

isResizable

public boolean isResizable()

Returns whether the view is resizable or not.

Returns:

The resizable state of the view.

Since:

JViews 6.5

setResizable

public void setResizable(boolean resizable)

Sets whether the view is resizable or not.

Parameters:

resizable - The resizable state of the view to set.

Since:

JViews 6.5

updateModel

public void updateModel(FacesContext ctx)

This method updates the referenced values by the local values of the component if these values were updated from the client.

Specified by:

updateModel in interface IlvViewHelper

Overrides:

updateModel in class IlvBasicViewHelper

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 IlvViewHelper

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvBasicViewHelper

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 IlvViewHelper

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class IlvBasicViewHelper

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.