Class DeputyPageToolbar

constructor

• new DeputyPageToolbar(options): DeputyPageToolbar

• Parameters

  • options: DeputyPageToolbarOptions

    The data received from a page status request. Used to initialize some values.

  Returns DeputyPageToolbar

element

ReadonlyinstanceId

nextRevisionButton

options

previousRevisionButton

Optionalrevision

revisionCheckbox

revisionNavigationSection

ReadonlyrevisionStatusUpdateListener

row

state

statusDropdown

close

• close(): void

• Performs cleanup and removes the element from the DOM.

  Returns void

onRevisionStatusUpdate

• onRevisionStatusUpdate(root0): void

• Listener for revision status updates from the root session.

  Parameters

  • root0: DeputyMessageEvent<DeputyRevisionStatusUpdateMessage>

  Returns void

prepare

• prepare(): Promise<void>

• Returns Promise<void>

  Inherit Doc

render

• render(): HTMLElement

• Renders the element. This must return an HTMLElement that can be appended directly to the DOM.

  Returns HTMLElement

renderCaseInfo

• renderCaseInfo(): Element

• Renders the "current case" section on the toolbar.

  Returns Element

  The "current case" section

renderCollapsed

• renderCollapsed(): Element

• Renders the collapsed toolbar button.

  Returns Element

  The render button, to be included in the main toolbar.

renderMenus

• renderMenus(): Element

• Renders the "Analysis" and "Tools" sections.

  Returns Element

  The section HTML

renderMissingRevisionInfo

• renderMissingRevisionInfo(): Element

• Replaces renderRevisionInfo if a revision does not exist. Placeholder to allow tools to be used anyway, even without having an active revision associated.

  Returns Element

  The "Revision out of scope" section

renderOpen

• renderOpen(): Element[]

• Rends the page toolbar actions and main section, if the dropdown is open.

  Returns Element[]

renderRevisionInfo

• renderRevisionInfo(): Element

• Renders the "revision" section on the toolbar.

  Returns Element

  The "Revision #XXXXXXXXXX" section

renderRevisionNavigationButtons

• renderRevisionNavigationButtons(): Element

• Renders the next revision button. Used to navigate to the next unassessed revision for a row.

  Returns Element

  The OOUI ButtonWidget element.

renderStatusDropdown

• renderStatusDropdown(): Element

• Instantiates a DeputyCCIStatusDropdown and returns the HTML element for it.

  Returns Element

  The OOUI dropdown's HTMLElement

runAsyncJobs

• runAsyncJobs(): Promise<void>

• Runs asynchronous preparation jobs. Makes loading more seamless later in execution, as this will run functions that cache data in the background.

  Returns Promise<void>

setDisabled

• setDisabled(disabled): void

• Sets the disabled state of the toolbar.

  Parameters

  • disabled: boolean

  Returns void

setState

• setState(state): void

• Sets the display state of the toolbar. This will also set the initial state configuration option for the user.

  Parameters

  • state: DeputyPageToolbarState

  Returns void