The ProjectEditor is the container for all project based plugins like ProjectDataPlugin and ItemListPlugin etc.

  • Plugin category = ProjectEditor

Hierarchy

Properties

baseRestrictions: ReadonlySet<UserRestriction>

Set of base user restrictions of this project editor. The base restrictions are defined by the application and the host of this project editor. Should not be used directly by most plugins. Use effectiveRestrictions instead.

basket: Basket
editorMode: ProjectEditorMode

Current mode of the editor.

effectiveRestrictions: ReadonlySet<UserRestriction>

Set of currently effective restrictions for the current user. The effective restictions are a combination of the baseRestrictions and the current restrictions of the workflow. These restrictions may change during life time of this project editor. Plugins should react to the eventEffectiveRestrictionsChanged event.

eventBaseRestrictionsChanged: ListenableEvent<void, ProjectEditor>

Will be triggered every time the baseRestrictions have changed. Should not be used directly by most plugins. Use eventEffectiveRestrictionsChanged instead.

eventEffectiveRestrictionsChanged: ListenableEvent<void, ProjectEditor>

Will be triggered every time the effectiveRestrictions have changed.

eventPointOfSaleModeChanged: ListenableEvent<void, ProjectEditor>

Will be triggered every time the pointOfSaleMode has changed.

eventProjectMetaDataChanged: ListenableEvent<void, ProjectEditor>

Will be triggered every time the projectMetaData has changed.

isActive?: boolean

Optional activity state of this component. Initial component state should be inactive (false or undefined).

itemList: null | ItemList
itemLockManager: ItemLockManager

The ItemLockManager is used to lock certain item related operations.

itemStatusProvider: null | ItemStatusProvider
itemTree: null | ItemTree
pointOfSaleMode: boolean

If true the editor is used at point of sale. Critical information like discounts should be hidden in this case.

projectMetaData: Readonly<ProjectMetaData>

Project related meta data which may be used by certain operations (e.g. ordering)

workflow: null | ProjectWorkflow

Methods

  • Called if this instance is no longer in use. Should be used to clean-up resources.

    Returns Promise<void>

  • Will be called everytime the main menu gets opened.

    Returns null | readonly MenuAction[]

  • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

    Parameters

    • pActive: boolean

    Returns Promise<void>

  • Used to enable/disable point of sale mode

    Parameters

    • pEnabled: boolean

    Returns void

  • Shows the catalog if not already shown.

    Returns void

Generated using TypeDoc