com.ibm.tivoli.maximo.skd.control.chart

Class SimpleChartBean

java.lang.Object

psdi.webclient.system.beans.WebClientBean

psdi.webclient.system.beans.DataBean

com.ibm.tivoli.maximo.skd.control.chart.SimpleChartBean

All Implemented Interfaces:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, DataBeanListener

Direct Known Subclasses:

SKDCompareCostChartBean, SKDComplianceTrendChartBean, SKDLabourHourComplianceChartBean, SKDScheduleComplianceChartBean, SKDWorkOrderComplianceChartBean

public abstract class SimpleChartBean
extends DataBean

A Chart Bean is a simple class that facilitates creating Chart Objects. The beanclass method for any chart MUST be a subclass of a SimpleChartBean.

Field Summary

Fields inherited from class psdi.webclient.system.beans.DataBean

ALL_BOOKMARKS, ALL_RECORDS, alwaysSelected, app, appDefaultValues, appName, appWhere, ATTR_COLUMN, ATTR_DEFAULT, ATTR_QBE, ATTR_READONLY, ATTR_REFRESH_TABLE, ATTR_REQUIRED, ATTR_RESET, attributes, boundAttributes, boundInputs, closingBean, conditionallyRequired, creatingEvent, currentQuery, currentQueryDescription, currentRecordData, currentRow, defaultDynamicQbe, defaultOrderBy, defaultQbe, defaultUserValues, descAttributeId, designerMboName, dialogReferences, dynamicDefaults, emptyOnClear, ermEntity, esigvalidated, eventrow, fetchData, globalAppTableRetain, hasTableData, hasUnappliedAppDefaults, hasUnappliedQbeDefaults, keyAttribute, keyAttributes, lastEventHandled, lastfetchedindex, listeners, listTableModified, listTableRetain, LOG_CATEGORY, MAX_TABLEROWS, mboName, mbosetfromzombie, mboSetRemote, multiQbe, newRowUnedited, orderBy, parent, parentRelationship, propCache, qbeAttributes, qualrestrict, queryDescBeforeReviseAction, queryNameBeforeReviseAction, refreshList, refreshQbe, removeOnCancel, requiredFields, resetList, resetRemote, returnAttribute, returnComponent, returnComponentlId, ROW_DELETE, ROW_IGNORE, ROW_INSERT, ROW_MODIFY, rowsperpage, saveCount, savedFilterSettings, savedQbeAttributes, screenDesignMode, smartFillValue, startEmpty, startrow, TABLE_ALL_SELECTED, TABLE_AT_FIRST_PAGE, TABLE_AT_FIRST_ROW, TABLE_AT_LAST_PAGE, TABLE_AT_LAST_ROW, TABLE_DETAILS_EXPANDED, TABLE_EXPANDED, TABLE_FILTER_EXPANDED, TABLE_FILTERED, TABLE_REFRESH_ALL_ROWS, TABLE_REFRESH_FILTER, TABLE_REFRESH_ROW, TABLE_REFRESH_TITLE, TABLE_ROW_CHANGED, TABLE_START_EMPTY, TABLE_SUBSELECT_ON, TABLE_USE_SUBSELECT, tableAttributes, tableData, tableDataInvalid, tableStateFlags, userQbeNotCommited, userWhereClause, zombieData

Fields inherited from class psdi.webclient.system.beans.WebClientBean

clientSession, creator, EVENT_CONTINUE, EVENT_HANDLED, EVENT_STOP_ALL, id, sessionContext

Constructor Summary

Constructors

Constructor and Description
SimpleChartBean()

Method Summary

Modifier and Type	Method and Description
ChartType	configureChartType(java.lang.String chartType) Factory for configuring a ChartType node for a given type.
abstract Chart	getChart(ChartRequestOptions options) Returns a Chart for the ChartRequestOptions.
java.util.Map	getChartIds() A ChartBean may create more than 1 chart, so this method should return the unique ids for those charts.
protected java.lang.String	getChartLabel(java.lang.String msgPrefix, java.lang.String defValue) Returns the localized chart label for the given msgPrefix.
com.ibm.json.java.JSONArray	getSupportedChartThemes() Return an Array of supported Dojo Chart Themes.
com.ibm.json.java.JSONArray	getSupportedChartTypes() Returns a JSONArray of ChartType JSON Objects that are configured and supported by this chart bean.
void	structureChangedEvent(DataBean speaker) event called by the "parent" DataBean which tells this DataBean that it references a new mbo or MboSetRemote.

Methods inherited from class psdi.webclient.system.beans.DataBean

_useAllBookmarksQuery, _useAllRecsQuery, _usequery, addAttribute, addConditionalProperties, addDialogReference, addListener, addQbeAttribute, addrow, addSigOption, afterSetValue, applyValuesToSharedAttributes, applyValuesToSharedAttributes, asyncLocked, bindComponent, boundToTable, buildPortalMsg, callBeanMethod, callBeanMethod, callBeanMethod, callBeanMethod, callMethod, callMethod, callMethod, callMethod, callRemoteMethod, callRemoteMethod, cancelDialog, canCloseBean, canFetchData, changeRequiredField, checkAndDistributeRequiredError, checkESigAuthenticated, checkForAppError, checkMethodAccess, cleanup, clearBean, clearfilter, clearQbeAttributes, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, dataChangedEvent, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, execute, fetchRecordData, fetchTableData, fetchTableData, filterrows, findAndCallMethod, fireChildChangedEvent, fireDataChangedEvent, fireDataChangedEvent, fireStructureChangedEvent, fireStructureChangedEvent, getAppWhere, getAttributes, getBoolean, getBoolean, getCacheRowIndex, getColumnDate, getColumnString, getCompleteWhere, getConditionalProperties, getCurrentQueryDescription, getCurrentQueryName, getCurrentRow, getDataAsArray, getDataAsArray, getDataList, getDataList, getDataList, getDataList, getDataListFromMboSetRemote, getDate, getDefaultOrderBy, getDefaultValue, getDescAttributeId, getEndRow, getEventRowIndex, getKeyAttribute, getKeyAttributes, getLastEventHandled, getLastFetchIndex, getList, getList, getList, getLockedByDisplayName, getMbo, getMbo, getMboForUniqueId, getMboName, getMboOrZombie, getMboRowIndex, getMboSet, getMboSetData, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetRemote, getMboValueData, getMboValueData, getMboValueInfo, getMXSession, getNullRequiedFields, getOrderBy, getPageEndRow, getPageRowCount, getPageStartIndex, getParent, getParentRelationship, getQbe, getQbe, getQbeAttributes, getQueryDescBeforeReviseAction, getQueryNameBeforeReviseAction, getRemoteForDownload, getRemoteForLookup, getReturnAttribute, getReturnComponent, getReturnComponentId, getReturnControlId, getRowIndexFromEvent, getSavedFilterSettings, getSelectedDataAsArray, getSelectedDataAsArray, getSelection, getShowDetails, getSmartFillValue, getSortOrder, getString, getString, getTableAttributes, getTableOffset, getTableStateFlags, getTitle, getUIERMEntity, getUniqueIdFromSmartFill, getUniqueIdFromSmartFill, getUniqueIdName, getUniqueIdValue, getUserAndQbeWhere, getUserWhere, getWarnings, getWorkflowDirections, getZombie, getZombieMboValueData, handleRemoteException, handleRequiredFieldException, hasLongDescriptionText, hasLongDescriptionText, hasMboSetRemote, hasPageRows, hasRow, hasSameMboSet, hasSigOptionAccess, hasSigOptionAccess, hierarchicalmove, highlightrow, highlightrow, initialize, insert, insert, insertAtEnd, instantdelete, invalidateTableData, isAppTableRetain, isAttribute, isAttributeHidden, isAttributeHidden, isColumnSorted, isEmpty, isListTableModified, isListTableRetain, isLookupMultiSelect, isMboHidden, isMboHidden, isMboSetSame, isModifiedRow, isModifiedRow, isNewRow, isNewRow, isNewRowUnedited, isRowDeleted, isRowLocked, isSelected, isSubSelect, isTableAttribute, isTablePostionMarked, isTableRowSelected, isTableStateFlagSet, listenerChangedEvent, madeRequiredConditionally, markTablePosition, moveTo, moveToMboFromDataBean, needToAuthenticate, next, nextrow, notExist, positionState, preSaveChecks, previous, prevrow, propagateRequired, queryAllBookmarks, queryAllRecs, refreshFieldErrors, refreshTable, registerDynamicControlsWithERM, reloadTable, removeDialogReference, removeListener, removeRowOnCancel, rePosition, reserveOnePair, reset, resetDataBean, resetJSPFlags, resetQbe, resetWithSelection, restoreSavedQbeSettings, retainPosition, returnLookupValue, returnLookupValue, returnLookupValue, returnLookupValue, save, save, saveCurrentQbeSettings, scrollnext, scrollprev, select, select, selectAll, selectrecord, selectRows, sendRefreshTable, setApp, setApp, setAppDefault, setAppDefaults, setApplicationError, setAppWhere, setAsyncLock, setAttributes, setCurrentQueryDescription, setCurrentQueryName, setCurrentRecordData, setCurrentRow, setDate, setDate, setDate, setDefaultOrderBy, setDefaultQbe, setDefaultValue, setDefaultValue, setDescAttributeId, setDynamicAppDefaults, setDynamicDefault, setDynamicQbeDefaults, setEmptyOnClear, setERMOnMboSet, setEsigValidated, setEventRowIndex, setfiltervalue, setLastEventHandled, setListTableModified, setListTableRetain, setMboName, setNewRowUnedited, setOrderBy, setPageRowCount, setParent, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeAttributes, setQbeCaseSensitive, setQbeDefaults, setQbeExactMatch, setQueryBySiteQbe, setQueryDescBeforeReviseAction, setQueryNameBeforeReviseAction, setRemoveOnCancel, setReturnAttribute, setReturnComponent, setReturnComponentId, setReturnControlId, setShowDetails, setSmartFillValue, setTableFlag, setupBean, setupBean, setupNonPersistent, setUserDefaults, setUserWhere, setvalue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromComponent, smartFill, smartFill, sort, sort, sortcolumn, sortcolumn, sqlwhere, toBeSaved, toggledeleterow, toggledetailstate, toggleselectallrows, toggleselectrow, toString, turnEmptyStateOn, unbindComponent, undelete, undelete, unselect, unselect, unselectAll, useAllBookmarksQuery, useAllRecsQuery, useqbe, usequery, useQuery, useStoredQuery, validate, validateChildren, validateClause, validateMbo, validateRow, valueBound, valueUnbound

Methods inherited from class psdi.webclient.system.beans.WebClientBean

getCreator, getId, setCreator, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleChartBean

public SimpleChartBean()

Method Detail

getChartIds

public java.util.Map getChartIds()

A ChartBean may create more than 1 chart, so this method should return the unique ids for those charts. If your bean only returns 1 chart, then this can return null.

Returns:

getChart

public abstract Chart getChart(ChartRequestOptions options)
                        throws java.rmi.RemoteException,
                               MXException

Returns a Chart for the ChartRequestOptions. options may be null, but if not, then the options can be used to select a specify chart. If getChartIds() returns one or more chart ids, then the ChartRequestOptions may contain the chartId that is being requested. At the time that this method is called, this Chart Bean will have both the data bean and control set, so they can be used when creating the chart.

Returns:

Throws:

MXException

java.rmi.RemoteException

getSupportedChartTypes

public com.ibm.json.java.JSONArray getSupportedChartTypes()

Returns a JSONArray of ChartType JSON Objects that are configured and supported by this chart bean. If it returns Null, then only a single chart type is supported, which is defined by the getChart() method. If this returns more than 1 item, then the chart control will enable the ability to switch between different chart types. By Default this method returns the supportedcharttypes property from the presentation, calling configureChartType for each chart listed.

Returns:

JSONArray of Supported Chart Types

configureChartType

public ChartType configureChartType(java.lang.String chartType)

Factory for configuring a ChartType node for a given type. Subclasses can use this to provide default configurations for supported chart types. The default implementation, simple returns a CharType with the configure chartType, or null, if the chartType is not a valid chart type.

Parameters:

chartType -

Returns:

getSupportedChartThemes

public com.ibm.json.java.JSONArray getSupportedChartThemes()

Return an Array of supported Dojo Chart Themes. By default this will read the supportedthemes property from the presentation control. It is valid for this method to return null, to indicate that there are no additional chart themes. But, if this method returns more than 1 theme, then a chart theme selector will be rendered with the chart

Returns:

getChartLabel

protected java.lang.String getChartLabel(java.lang.String msgPrefix,
                                         java.lang.String defValue)

Returns the localized chart label for the given msgPrefix.

Parameters:

msgPrefix - chart prefix id (_chart will be automatically appended)

defValue - default title if the title is not localized.

Returns:

structureChangedEvent

public void structureChangedEvent(DataBean speaker)

Description copied from class: DataBean

event called by the "parent" DataBean which tells this DataBean that it references a new mbo or MboSetRemote. The fireStructureChangedEvent is called thus setting the resetRemote flag for all the "children" DataBeans

Specified by:

structureChangedEvent in interface DataBeanListener

Overrides:

structureChangedEvent in class DataBean