Package com.znize.platform.model.dialog

Class ProgressBean

java.lang.Object

com.znize.platform.model.bean.Component

com.znize.platform.model.bean.BackingBean

com.znize.platform.model.bean.PersistenceDataBackingBean<T>

com.znize.platform.model.bean.EntityBackingBean<T>

com.znize.platform.model.bean.HierarchyAwareBackingBean<T>

com.znize.platform.model.bean.MapEntityBean<MapEntity>

com.znize.platform.model.dialog.ProgressBean

All Implemented Interfaces:

EntityExportHandler<MapEntity>, EntityImportHandler, MenuNodeActionHandler, java.io.Serializable, java.lang.Cloneable

public class ProgressBean
extends MapEntityBean<MapEntity>

ProgressBean that has a progress property, which can be shown in modal dialog to block UI while displaying progress bar.

Since:

4.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.znize.platform.model.bean.MapEntityBean

MapEntityBean.ActionHandler<T extends MapEntity>, MapEntityBean.DefaultActionHandler<T extends MapEntity>

Nested classes/interfaces inherited from class com.znize.platform.model.bean.EntityBackingBean

EntityBackingBean.OrderByProperty, EntityBackingBean.PropertyQueryCriterion, EntityBackingBean.ShowTypeAfterCommit

Nested classes/interfaces inherited from class com.znize.platform.model.bean.PersistenceDataBackingBean

PersistenceDataBackingBean.GeneratedBeanPageContent, PersistenceDataBackingBean.HelpPathInfo

Nested classes/interfaces inherited from class com.znize.platform.model.bean.BackingBean

BackingBean.MessageLocation

Nested classes/interfaces inherited from class com.znize.platform.model.bean.Component

Component.ComponentVisitor

Nested classes/interfaces inherited from interface com.znize.platform.model.entimport.EntityImportHandler

EntityImportHandler.HandleResult<T extends PersistenceEntity>

Field Summary

Fields inherited from class com.znize.platform.model.bean.EntityBackingBean

groupByProperties, orderByProperties, PROPERTY_PAGE_NUMBER, PROPERTY_SUB_NUMBER

Fields inherited from class com.znize.platform.model.bean.PersistenceDataBackingBean

COMMAND_EMAIL, COMMAND_HELP, COMMAND_OPEN_QUERY_FORM, COMMAND_PRINT_VIEW, entityAttrsMap, entityDataSource, entityPropertyList, entityPropertyListData, footerMenuBean, generatedBeans, hasCreatePermission, hasDeletePermission, hasEditPermission, hasViewPermission, headerMenuBean, initialViewConfig

Fields inherited from class com.znize.platform.model.bean.BackingBean

containerBean, hidden, messages, styleClass, title, viewConfig

Fields inherited from class com.znize.platform.model.bean.Component

parentComponent, uiView

Constructor Summary

Constructors

Constructor	Description
ProgressBean()

Method Summary

Modifier and Type	Method	Description
protected void	addMenuNodes(ModeType modeType)	Add menu nodes to header or footer menu.
PageNavigation	clickMenuNode(MenuNode menuNode)	Handle menu node action by delegating to its ActionHandler.
static DialogBean	createProgressModalDialog(MenuNode targetMenuNode, java.lang.Integer initialValue, java.lang.String labelTemplate, boolean ajax, boolean displayOnly, boolean closeDialogOncomplete, ContainerBean containerBean)	Create modal dialogBean with progressBean.
protected ParameterizedMessage	getDefaultTitle()	Get default title using current mode and entity type display name.
EntityProgressProperty<MapEntity>	getProgressProperty()	Get progress property that is the only property in the progressBean.
MenuNode	getTargetMenuNode()	Get the target menuNode whose command execution progress will be tracked
static ProgressBean	newInstance(MenuNode targetMenuNode, java.lang.Integer initialValue, java.lang.String labelTemplate, boolean ajax, boolean displayOnly, boolean closeDilaogOncomplete, ContainerBean containerBean)	Create progressBean with progress property and start menu node.

Methods inherited from class com.znize.platform.model.bean.MapEntityBean

clickPropertyMenuNode, createMapEntityBean, createMapEntityBean, createMapEntityBean, createMapEntityBean, createNameValueListBean, createTextBean, createTextBean, getActionHandler, handlePartialBehaviorEvent, postRefreshEntityListPropertyModel, postRefreshEntityPropertyModel, setActionHandler, setActionHandler

Methods inherited from class com.znize.platform.model.bean.HierarchyAwareBackingBean

getRootHierarchyId, isLeafRequired

Methods inherited from class com.znize.platform.model.bean.EntityBackingBean

addCommonMenuNodes, addContextMenuNodes, addGroupByProperties, addHiddenPropertyQueryElements, addHiddenPropertyQueryElements, addMenuNodes, addOrderByProperties, addPrerequisites, addRowCommandMenuNodes, afterBeanFlowNavigate, applyChange, applyChange, authorizeAccess, beanFlowNavigate, beforeBeanFlowNavigate, beforeImportEntities, beforeLoadInitialPage, buildEntityListViewConfig, buildEntityTabView, buildFormBean, buildFormBean, buildQueryTabView, buildViewConfig, calculateStatistics, checkPermissionBeforeCreate, checkQuantityQuotaBeforeCreate, clearCache, clearFormBeanPropertyValueFlags, clickCommonMenuNode, clickContextMenuNode, clickEntityRowCommand, clickPropertyValue, convertPropertyInputDialogData, create, create, createDialogContent, createEntitiesElement, createEntityCaptchaProperty, createEntityElement, createEntityRowCommandProperty, delete, delete, editModeChanged, enableEdit, entitiesDeletedFromMemory, entityI18NCommitted, execBeanFlowNavigationCommand, exportEntities, exportEntitiesElementCreated, exportEntitiesToDirectory, exportEntitiesToFile, exportEntitiesToFile, fillEntityData, formBeanPropertyEntitiesToBeDeleted, generateNormativeIdDuringPrepareEntity, getActionDescriptor, getAutoCompleteQueryElement, getAutoCompleteQueryProperties, getAutoCompleteSuggestions, getBeanFlowFormDesignList, getBeanFlowHistory, getChangedMessages, getCheckImageURL, getCommandConfirmMessage, getCommandHandler, getCommandIcon, getCommandIcon, getCommandVisibleName, getConflictActionSelectItems, getCreatedMessages, getCurrencyCode, getCurrentModeType, getDataAccessUnit, getDataAccessUnit, getDataFromEntityDataSource, getDefaultPrimaryProperties, getDefaultQueryOrders, getDomEventDynamicHandler, getDynamicHelpMessage, getDynamicRenderStyle, getDynamicSelectItems, getDynamicSelectPropertyQueryElements, getEmbeddedStatisticsEntityRowLabel, getEntity, getEntityAssociatedWithFormBean, getEntityAttrComparator, getEntityAttrs, getEntityAttrsCacheKey, getEntityAttrsFromCache, getEntityBackingBean, getEntityCaptchaProperty, getEntityDeletionDescriptor, getEntityFetchGraph, getEntityFetchGraph, getEntityFileIdentifier, getEntityFilePath, getEntityImportValidator, getEntityListFormBeans, getEntityName, getEntityNameResolver, getEntityTypeAndName, getEntityTypeForPropertyInputDialog, getExportAsExcelSheetName, getFileNameExtension, getFileUploadOptions, getFormDesign, getFormDesignEntityType, getFormDesignEntityType, getFormEnctype, getGroupByProperties, getGroupByPropertySelectItems, getHelper, getHiddenPropertyQueryElements, getHiddenQueryRestrictionProperties, getIdRule, getImpliedStyleClass, getKeywordEntityProperty, getManageModeAfterCommit, getOneEntity, getOrderByAscSelectItems, getOrderByProperties, getOrderByPropertySelectItems, getOwningTenant, getPersistedEntityCount, getPositionToAddRows, getProgressDescriptor, getProgressDescriptor, getProgressDescriptor, getPropertiesToShowSelectItems, getPropertyDynamicValue, getPropertyPartialBehaviorSupport, getPropertySelectItems, getQueryCommandInfo, getQueryCriterion, getQueryJoinGraph, getQueryPropertyValue, getQueryResultPageSizeSelectItems, getQueryResultTitle, getQueryResultTransformer, getQueryResultViewEntityType, getRowStyleClass, getShowEntityRowCount, getShowTypeAfterCommit, getStatisticsProperties, getSystemEntityImportDescriptor, getTitle, getTransactionListener, getTypeDescriptorForSelectDialog, getTypeName, getViewConfig, getVisibleQueryRestrictionProperties, handlePartialBehaviorEvent, hasPropertyAnnotations, importEntities, importEntities, importEntitiesCompleted, initEntitiesToInsert, isAddChildEntityTypeToContextMenu, isApplyChangeRenderable, isAutoSetEntityRowSequenceNumbers, isCaptchaRequired, isCaptchaRequired, isCaptchaRequired, isCheckRowCommandPermissionsForEntities, isCreateSupported, isCreating, isDeleteEnabled, isDynamicHelpRenderable, isEditEnabled, isEmbeddedStatisticsEntity, isEmpty, isEntityHidden, isEntityListCreateInPlace, isEntityListEditInPlace, isEntityListInsertBeforeEnabled, isEntityListMoveUpDownEnabled, isEntityListNavigatableToEntity, isFormBeanPropertyEntitiesSaveOnDelete, isFormDesignAutoEnabled, isFormDesignSupported, isFormDesignSupported, isGroupBySelectRenderable, isHasActivatePermission, isHasCreatePermission, isHasDeletePermission, isHasDeletePermission, isHasEditPermission, isHasEditPermission, isHasPermission, isHasPermission, isHasViewPermission, isHasViewPermission, isLoginRequiredForCreate, isNextEntityCommandRenderable, isOpenDialogEnabledForNavigateToEntity, isOpenEntitySelectDialogEnabled, isOrderBySelectRenderable, isOverrideDataAccessUnitByTenantAttribute, isParentComponentRowEntityView, isPersistDataRequested, isPersistDataRequested, isPreviousEntityCommandRenderable, isPrintViewMenuNodeRenderable, isPropertyMenuNodeRenderable, isPropertyRenderable, isPropertyShowing, isPropertyValueRenderable, isQueryView, isReadOnly, isRemoveFormBeanEntity, isRequiredAnnotationUsedForQueryView, isUpdateFormBeanPropertyValueOnDelete, isVerifyBeforeApplyChangeRequired, isVerifyBeforeCreateRequired, loadEntityFromFile, nextEntity, pageRetrievedFromPersistence, pageSizeAdjusted, paginationChanged, postMerge, postPersist, postProcessStatistics, postRefreshDataModel, postRefreshViewAfterCommit, postRefreshViewAfterCommitEntityList, postRefreshViewAfterRollback, postRemove, postRemoveEntityList, preMerge, prepareEntity, prepareEntityListCreateEntity, prePersist, preRefreshColumnListModel, preRefreshEntityPropertyModel, preRemove, preReturnEdit, previousEntity, propertyValueChanged, refreshDataModel, refreshEntityPropertyModel, refreshMenuBeans, resolveDataDescriptor, resolveRegularExpression, setEntity, setEntity, setGroupByProperties, setHiddenPropertyQueryElements, setOrderByProperties, setQueryResultTransformer, showDefaultEmptyEntity, statisticsCalculated, storeEntityToFile, updateInitialViewConfig, useMinAvailableId, validate, validateEntityDataSource, verifyShowingMode, walkComponentTree

Methods inherited from class com.znize.platform.model.bean.PersistenceDataBackingBean

addEmailMenuNode, addEntityCollectionProperty, addEntityFormBeanProperty, addEntityFormBeanProperty, addEntityProperty, addEntityProperty, addEntityProperty, addEntityPropertyAfter, addEntityPropertyBefore, addGeneratedBean, addGeneratedBean, addMenuNode, addMultitenantProperty, addPrintViewMenuNode, addPropertyRenderTarget, addPropertyRenderTarget, addPropertyRenderTargets, addPropertyRenderTargets, authorizeAccessEntityType, buildViewConfig, cacheEntityAttrs, callLifecycleListenerAfterPhase, callLifecycleListenerBeforePhase, canUserAccessEntityType, checkAvailability, checkAvailabilityAfterValidation, clearGeneratedBeans, clearInvalidUserInput, createDialogContent, createHelpMenuNode, getBeanLocation, getCachedEntityAttrs, getContainerRenderRegions, getCurrentDeviceType, getDataDescriptor, getDefaultCommandMenuNode, getDomEventDynamicHandler, getEntityBackingBean, getEntityBackingBean, getEntityDataSource, getEntityFormBeanProperties, getEntityFormBeanProperty, getEntityProperties, getEntityProperties, getEntityProperties, getEntityPropertiesOfType, getEntityProperty, getEntityProperty, getEntityProperty, getEntityPropertyIndex, getEntityPropertyList, getEntityPropertyList, getEntityPropertyListData, getEntityPropertyMap, getEntityType, getErrorSupplementalMessages, getFlattenedEntityProperties, getFooterMenuBean, getFooterMenuViewConfig, getFormBean, getGeneratedBeans, getHeaderMenuBean, getHeaderMenuViewConfig, getHelpPathInfo, getInitialViewConfig, getMenuBean, getMenuNode, getMenuNodeFactory, getOverriddenCreatePermission, getOverriddenDeletePermission, getOverriddenEditPermission, getOverriddenPermission, getOverriddenViewPermission, getPersistableEntityType, getPropertyCurrentEntitiesOnPathTo, getPropertyEntityType, getQueryDescriptor, getQueryHints, getTypeDisplayName, getTypeName, groupEntityProperties, groupEntityProperties, groupEntityProperties, groupEntityProperties, hasInvalidUserInputs, isAllowDeleteInManageMode, isCreateEnabled, isEditEnabled, isEmailMenuNodeRenderable, isHasPermission, isHelpMenuNodeRenderable, isMenuNodeRenderable, isOpenInputDialog, isReadOnly, isUserHasPermission, isValueReserved, isVisibleAfterInit, printView, refreshDataModel, refreshDataModel, refreshEntityPropertyModel, removeEntityProperty, removeEntityPropertyGroup, removeEntityPropertyInvalidUserInput, removeInvalidUserInput, removeValidationErrorMessages, sendEmail, setBackingBean, setContainerBean, setEntityDataSource, setEntityPropertyList, setEntityType, setFooterMenuBean, setHeaderMenuBean, setInitialViewConfig, setPropertyCurrentEntitiesOnPathTo, setReadOnly, setViewConfig, visitEntityProperties

Methods inherited from class com.znize.platform.model.bean.BackingBean

addAsRenderTarget, addMessage, addMessage, addMessages, asVisitTarget, buildComponentDisplayTitle, getAccessControlAccessor, getBackingBeanContext, getCalendar, getContainerBean, getContainerDialogBean, getCurrentDate, getDisplayMessage, getDisplayTitle, getEnclosingBean, getEnclosingEntityProperty, getLocale, getMessage, getName, getOnFormSubmitJS, getRenewableSubscriptionsQueryCriteria, getRequestHelper, getRequestResult, getRootEnclosingBean, getSelfRenderRegions, getStyleClass, getStyleClass, getTimeZone, getTimeZoneId, handleError, hasMessages, isContainerDialogBean, isHidden, isManageMode, isMobile, isPanelVisible, isProgressDialogOpened, isRenderable, removeFromPageContent, setEnclosingPropertyEditEnabled, setHidden, setManageMode, setMessage, setMessage, setMessage, setName, setStyleClass, setTitle

Methods inherited from class com.znize.platform.model.bean.Component

existPathToAncestorType, getAuthenticatedUser, getCalcContext, getChildOfClosestAncestor, getClientId, getClosestAncestor, getComponentsOnPathTo, getCountryFromCurrentLocale, getCurrencyCode, getCurrentLocalDateTime, getDataAccessUnit, getDataConverter, getDisplayValue, getInstanceUser, getParameters, getParameters, getParentComponent, getPathTo, getPersistenceEntityManager, getPersistenceEntityManager, getPersistenceEntityManager, getPersistenceEntityManager, getResourceBundle, getRootComponent, getString, getUiView, getUiView, getYearStartDate, isAncestorComponentOf, isEntityI18NEnabled, isInPageContent, setClientId, setParentComponent, setUiView

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.znize.platform.model.entimport.EntityImportHandler

getEntityType

Methods inherited from interface com.znize.platform.model.menu.MenuNodeActionHandler

getContainerBean

Constructor Detail

ProgressBean

public ProgressBean()

Method Detail

newInstance

public static ProgressBean newInstance(MenuNode targetMenuNode,
                                       java.lang.Integer initialValue,
                                       java.lang.String labelTemplate,
                                       boolean ajax,
                                       boolean displayOnly,
                                       boolean closeDilaogOncomplete,
                                       ContainerBean containerBean)
                                throws SystemException

Create progressBean with progress property and start menu node.

Parameters:

targetMenuNode - the menu node to show progress for

initialValue - progress initial value, default is zero

labelTemplate - progress label template such as {value}%

ajax - whether to ajax poll progress value from server side

displayOnly - whether to display progress statically

closeDilaogOncomplete - whether to close progress dialog when targetMenuNode command is successfully executed.

containerBean - can be progress dialogBean

Returns:

progressBean

Throws:

SystemException - throw if an error occurs in creating ProgressBean

getTargetMenuNode

public MenuNode getTargetMenuNode()

Get the target menuNode whose command execution progress will be tracked

Returns:

target MenuNode

getDefaultTitle

protected ParameterizedMessage getDefaultTitle()

Description copied from class: EntityBackingBean

Get default title using current mode and entity type display name.

Overrides:

getDefaultTitle in class EntityBackingBean<MapEntity>

Returns:

default title

getProgressProperty

public EntityProgressProperty<MapEntity> getProgressProperty()

Get progress property that is the only property in the progressBean.

Overrides:

getProgressProperty in class BackingBean

Returns:

progress property. return null if progress modal dialog does not exist.

addMenuNodes

protected void addMenuNodes(ModeType modeType)
                     throws SystemException

Description copied from class: EntityBackingBean

Add menu nodes to header or footer menu.

Overrides:

addMenuNodes in class EntityBackingBean<MapEntity>

Parameters:

modeType - current mode of this entityBackingBean.

Throws:

SystemException - throw if an error occurs in creating menu nodes

clickMenuNode

public PageNavigation clickMenuNode(MenuNode menuNode)
                             throws SystemException

Description copied from class: MapEntityBean

Handle menu node action by delegating to its ActionHandler.

Specified by:

clickMenuNode in interface MenuNodeActionHandler

Overrides:

clickMenuNode in class MapEntityBean<MapEntity>

Parameters:

menuNode - the menu node clicked.

Returns:

webPage

Throws:

SystemException - throw if an error occurs in handling action

See Also:

MapEntityBean.ActionHandler.clickMenuNode(MapEntityBean, MenuNode)

createProgressModalDialog

public static DialogBean createProgressModalDialog(MenuNode targetMenuNode,
                                                   java.lang.Integer initialValue,
                                                   java.lang.String labelTemplate,
                                                   boolean ajax,
                                                   boolean displayOnly,
                                                   boolean closeDialogOncomplete,
                                                   ContainerBean containerBean)
                                            throws SystemException

Create modal dialogBean with progressBean.

Parameters:

targetMenuNode - the menu node for which to track progress

initialValue - progress initial value, default is zero.

labelTemplate - progress label template such as {value}%, use default if null

ajax - whether to ajax poll progress value from server side

displayOnly - whether to display progress statically

closeDialogOncomplete - whether to close progress dialog when targetMenuNode command is successfully executed

containerBean - parent containerBean of dialogBean to be created

Returns:

dialogBean

Throws:

SystemException - throw if an error occurs in creating progress bean