Class DeputyCCIStatusDropdown

constructor

• new DeputyCCIStatusDropdown(row, options?): DeputyCCIStatusDropdown

• Create a new DeputyCCIStatusDropdown object.

  Parameters

  • row: {
        casePage: DeputyCase;
        title: Title;
        type: "detailed" | "pageonly";
    }

    The origin row of this dropdown. For the root session, this is simply the row field of the DeputyContributionSurveyRow that is handling the row. For dependent sessions, this is a much simpler version which includes only the case page info and the row title.

    • casePage: DeputyCase

      The DeputyCase for this dropdown

    • title: Title

      The title of the row (page) that this dropdown accesses

    • type: "detailed" | "pageonly"
  • options: DeputyCCIStatusDropdownProps = {}

    Additional construction options, usually used by the root session.

  Returns DeputyCCIStatusDropdown

dropdown

dropdownChangeListener

dropdownUpdateListener

options

row

Static ReadonlymenuOptionIcons

status

• get status(): ContributionSurveyRowStatus

• Returns ContributionSurveyRowStatus

  The currently-selected status of this dropdown.
• set status(status): void

• Sets the currently-selected status of this dropdown.

  Parameters

  • status: ContributionSurveyRowStatus

  Returns void

addEventListener

• addEventListener(type, callback): void

• Parameters

  • type: "change"
  • callback: ((evt: Event & {
        status: ContributionSurveyRowStatus;
        type: "change";
    }) => void)
    • • (evt): void

      • Parameters

        • evt: Event & {
              status: ContributionSurveyRowStatus;
              type: "change";
          }

        Returns void

  Returns void

  Inherit Doc

• addEventListener(type, callback): void

• Parameters

  • type: "updateFail"
  • callback: ((evt: Event & {
        data: {
            former: ContributionSurveyRowStatus;
            target: ContributionSurveyRowStatus;
        };
    }) => void)
    • • (evt): void

      • Parameters

        • evt: Event & {
              data: {
                  former: ContributionSurveyRowStatus;
                  target: ContributionSurveyRowStatus;
              };
          }

        Returns void

  Returns void

  Inherit Doc

close

• close(): void

• Performs cleanup

  Returns void

getEnabledOptions

• getEnabledOptions(): ContributionSurveyRowStatus[]

• Gets a list of enabled options.

  Returns ContributionSurveyRowStatus[]

  An array of ContributionSurveyRowStatuses

refresh

• refresh(): void

• Refreshes the status dropdown for any changes. This function must NOT modify this.status, or else it will cause a stack overflow.

  Returns void

selectNextBestValue

• selectNextBestValue(status): void

• When an option is about to be closed and the current status matches that option, this function will find the next best option and select it. The next best value is as follows:

  For

  • Unfinished: WithoutViolations, unless it's pageonly, on which it'll be kept as is.
  • Unknown: Unfinished
  • WithViolations: usually not disabled, kept as is
  • WithoutViolations: usually not disabled, kept as is
  • Missing: usually not disabled, kept as is
  • PresumptiveRemoval: usually not disabled, kept as is

  Parameters

  • status: ContributionSurveyRowStatus

    The status that was changed into

  Returns void

setDisabled

• setDisabled(disabled): void

• Sets the disabled state of the dropdown. Does not affect menu options.

  Parameters

  • disabled: boolean

  Returns void

setEnabledOptions

• setEnabledOptions(enabledOptions, broadcast?): void

• Parameters

  • enabledOptions: ContributionSurveyRowStatus[]
  • broadcast: boolean = false

  Returns void

setOptionDisabled

• setOptionDisabled(status, disabled, broadcast?): void

• Sets the 'disable state' of specific menu options. For the Unknown option, a specific case is made which removes the option from the menu entirely.

  Parameters

  • status: ContributionSurveyRowStatus
  • disabled: boolean
  • broadcast: boolean = false

  Returns void