public class IlvChartDHTMLView extends IlvChartDHTMLViewComponent
IlvChartDHTMLView is a JViews Faces DHTML component that
displays a chart image. This component is the central component of a JViews
Chart Faces application. It is possible to connect interactors to
interact (zoom, pan, point) on this view through the interactor
property. An overview displays the visible window of the current view.
By default, this component displays the chart area and the legend of this
chart if visible. Only the chart area can be displayed if the
component property is set to "area".
In order to prevent unnecessary server round trips, a DHTML proxy is
declared during the generation of the page. You can call methods on this
proxy in JavaScript handler to make actions on this view without redisplaying
the whole page. Change interactors with JavaScript handlers
example:
<jvcf:chartZoomInteractor id="zoomInteractor" ... />
<jvcf:chartPanInteractor id="panInteractor" ... />
<jvcf:chartView id="chartView" interactorId="zoomInteractor" ... />
<h:commandButton value="Zoom Interactor" onclick="chartView.setInteractor(zoomInteractor)" />
<h:commandButton value="Pan Interactor" onclick="chartView.setInteractor(panInteractor)" />
IlvChartDHTMLOverview,
IlvChart,
Serialized FormACCESSIBLE_DEFAULT_VALUE, RESIZABLE_DEFAULT_VALUEDEFAULT_OBJECT_FINDERATTRS_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_KEYACCESSIBLE, 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_IMAGEAFTER_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, WIDTHAUTO_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| Constructor and Description |
|---|
IlvChartDHTMLView()
Creates a new
IlvChartDHTMLView instance. |
| Modifier and Type | Method and Description |
|---|---|
String |
getBeforeSessionExpirationHandler()
Returns the JavaScript code that will be called when the session is about to expire.
|
IlvChart |
getChart()
Returns the
IlvChart instance linked to this chart or
null if no chart was bound to this component. |
String |
getComponent()
Returns the type of component to be displayed.
|
static String |
getComponentType()
Returns The type of this component.
|
String |
getFamily()
Returns the identifier of the component family to which this component
belongs.
|
String |
getStyleSheet()
Returns a style sheet.
|
String |
getStyleSheets()
Returns the list of comma-separated style sheets.
|
int |
getUpdateInterval()
Returns the automatic update interval (in seconds) of the chart.
|
boolean |
isKeepVisibleWindow()
Returns whether the current visible window has to be kept between two JSF requests.
|
void |
maybeStoreChartInSession()
Stores in the session the bound chart instance to be displayed, and the ID
property as identifier if the chart is not
null. |
void |
restoreState(javax.faces.context.FacesContext context,
Object stateObj)
Restores the state of this component from the
stateObj parameter. |
Object |
saveState(javax.faces.context.FacesContext context)
Returns the state of this component.
|
void |
setBeforeSessionExpirationHandler(String handler)
Sets the JavaScript code that will be called when the session is about to expire.
|
void |
setChart(IlvChart chart)
Sets the
IlvChart instance to be displayed by the chart view component. |
void |
setComponent(String comp)
Sets the component type to be displayed.
|
void |
setDefaultChartVisibleWindow()
Overrides the current stored visible window with the displayed chart
visible window.
|
void |
setKeepVisibleWindow(boolean keepVisibleWindow)
Sets whether the current visible window has to be kept between two JSF requests.
|
void |
setStyleSheet(String styleSheet)
Sets a style sheet.
|
void |
setStyleSheets(String styleSheets)
Sets the comma-separated cascading style sheets.
|
void |
setUpdateInterval(int updateInterval)
Changes the automatic update interval of the chart.
|
void |
updateModel(javax.faces.context.FacesContext context)
This method updates the referenced values with the local values of the
component if these values were updated from the client.
|
createDHTMLHelper, getBackgroundColor, getErrorMessage, getHotkeys, getImageFormat, getImageMapGenerator, getImageMapGeneratorClass, getOnCapabilitiesLoaded, getOnImageLoaded, getServlet, getServletClass, getServletURL, getWaitingImage, isAccessible, isGenerateImageMap, isImageMapVisible, isResizable, setAccessible, setBackgroundColor, setErrorMessage, setGenerateImageMap, setHotkeys, setImageFormat, setImageMapGenerator, setImageMapGeneratorClass, setImageMapVisible, setOnCapabilitiesLoaded, setOnImageLoaded, setResizable, setServlet, setServletClass, setServletURL, setValue, setWaitingImagegetClientState, getDataSource, getDataSourceId, getDefaultObjectFinder, getInteractor, getInteractorId, getProject, getType, getXZoomFactor, getYZoomFactor, setClientState, setDataSource, setDataSourceId, setInteractor, setInteractorId, setProject, setType, setXZoomFactor, setYZoomFactorclearDecodedPropertyMap, createFacesComponent, getAttributes, getBaseTextDirection, getData, getHeight, getMessageBox, getMessageBoxId, getStyle, getStyleClass, getWidth, isDecodedProperty, processUpdates, resetDecodedProperties, setBaseTextDirection, setData, setDecodedProperty, setHeight, setMessageBox, setMessageBoxId, setStyle, setStyleClass, setWidthgetUrl, getValue, getValueBinding, getValueExpression, setUrl, setValueBinding, setValueExpressionaddClientBehavior, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTreepublic IlvChartDHTMLView()
IlvChartDHTMLView instance.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.
getFamily in class IlvChartViewpublic static String getComponentType()
public IlvChart getChart()
IlvChart instance linked to this chart or
null if no chart was bound to this component.public void setDefaultChartVisibleWindow()
public void setChart(IlvChart chart)
IlvChart instance to be displayed by the chart view component.chart - The chart to display.public void maybeStoreChartInSession()
null.public void setStyleSheets(String styleSheets)
styleSheets - The list of comma-separated style sheets.public void setStyleSheet(String styleSheet)
styleSheet - a style sheet,The parameter can be a URL or inline stylepublic String getStyleSheets()
public String getStyleSheet()
public int getUpdateInterval()
public void setUpdateInterval(int updateInterval)
updateInterval - The new interval in seconds. An interval of zero
stops the automatic update.public void setComponent(String comp)
comp - The type of component to display.public String getComponent()
public boolean isKeepVisibleWindow()
true to keep state, false otherwise.public void setKeepVisibleWindow(boolean keepVisibleWindow)
keepVisibleWindow - true to keep state, false otherwise.public String getBeforeSessionExpirationHandler()
public void setBeforeSessionExpirationHandler(String handler)
This code can use the view implicit variable that represents the JavaScript proxy of this component.
handler - The JavasScript code.public void updateModel(javax.faces.context.FacesContext context)
updateModel in interface IlvDHTMLHelperupdateModel in class IlvChartDHTMLViewComponentcontext - The current faces context.public Object saveState(javax.faces.context.FacesContext context)
saveState in interface IlvFacesComponentsaveState in interface IlvDHTMLHelpersaveState in interface javax.faces.component.StateHoldersaveState in class IlvChartDHTMLViewComponentcontext - The current faces context.state of this component.public void restoreState(javax.faces.context.FacesContext context,
Object stateObj)
stateObj parameter.restoreState in interface IlvFacesComponentrestoreState in interface IlvDHTMLHelperrestoreState in interface javax.faces.component.StateHolderrestoreState in class IlvChartDHTMLViewComponentcontext - The current faces context.stateObj - The previously saved state of this component.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.