psdi.webclient.controls

Class KPIPortlet

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.system.controller.DatasrcInstance

psdi.webclient.controls.PortletDataInstance

psdi.webclient.controls.KPIPortlet

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

KPIGraphPortlet, KPIListPortlet

public class KPIPortlet
extends PortletDataInstance

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KPI_APP
static java.lang.String	KPIVIEWER_APP

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
KPIPortlet()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKPIApptoLink() returns the proper kpi app to link to depending on security settings.
static java.lang.String	getKPIClass(KPIUtil.Status status) Utility method that returns Css class or Image for KPI status.
static java.lang.String	getKPIStatusColor(KPIUtil.Status status, WebClientSession sessionContext) Utility method that returns image url for the trend of the KPI These are common to the KPI Portlets
void	openrecord() Call through the method in superclass to open an app with unqiueid

Methods inherited from class psdi.webclient.controls.PortletDataInstance

checkOrStoreCachedProperty, cleanup, createRenderData, deleteportlet, editportlet, filter, formatNumber, getAppBean, getAppId, getKPIImage, getLabels, getPortletCacheId, getSortAttribute, getStartCenterPane, getStateManager, hasData, initialize, instantiatedatasrc, isFiltered, isFilterOpen, isFilterToggled, isLinkedToKPI, isLinkedToReport, isMaximised, isPortletStateChanged, isPortletUpdated, isPortletVisible, openrecord, openreport, percentKPIMark, refreshdata, scroll, setFiltered, setFilterToggled, setHasData, setHasLinkedReportsOrKPIs, setPortletStateChanged, setPortletUpdated, sort, togglefilter, toggleportlet

Methods inherited from class psdi.webclient.system.controller.DatasrcInstance

broadcastEvent, getDataBean, instantiatedatasrcdesign, render

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, clearComponent, clearErrors, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRender, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KPI_APP

public static final java.lang.String KPI_APP

See Also:

Constant Field Values

KPIVIEWER_APP

public static final java.lang.String KPIVIEWER_APP

See Also:

Constant Field Values

Constructor Detail

KPIPortlet

public KPIPortlet()

Method Detail

getKPIStatusColor

public static java.lang.String getKPIStatusColor(KPIUtil.Status status,
                                                 WebClientSession sessionContext)

Utility method that returns image url for the trend of the KPI These are common to the KPI Portlets

Parameters:

String - - trend of the KPI

WebClientSession - - trend of the KPI

Returns:

TrendImage

getKPIClass

public static java.lang.String getKPIClass(KPIUtil.Status status)

Utility method that returns Css class or Image for KPI status. These are common to the KPI Portlets

Parameters:

String - - status of KPI

Returns:

String - cssclassname

openrecord

public void openrecord()

Call through the method in superclass to open an app with unqiueid

getKPIApptoLink

public java.lang.String getKPIApptoLink()

returns the proper kpi app to link to depending on security settings. If there is no access to the kpi app, return the kpi viewer app if they have access to that.

Returns: