Class DeputyContributionSurveySection

constructor

• new DeputyContributionSurveySection(casePage, heading): DeputyContributionSurveySection

• Creates a DeputyContributionSurveySection from a given heading.

  Parameters

  • casePage: DeputyCasePage
  • heading: HTMLHeadingElement

  Returns DeputyContributionSurveySection

casePage

closeButton

closingCheckbox

closingComments

closingCommentsSign

container

disabled

heading

originalList

revid

reviewButton

rowElements

rows

saveButton

sectionNodes

wikitextLines

closed

• get closed(): boolean

• Returns boolean

  true if this section is (or will be) closed
• set closed(value): void

• Sets the close state of this section

  Parameters

  • value: boolean

  Returns void

comments

• get comments(): string

• Returns string

  The closing comments for this section
• set comments(value): void

• Sets the comments of a section.

  Parameters

  • value: string

  Returns void

editSummary

• get editSummary(): string

• Returns string

  The edit summary for this section's changes.

headingN

• get headingN(): number

• Returns number

  the n of the section heading, if applicable.

headingName

• get headingName(): string

• Returns string

  the name of the section heading.

modified

• get modified(): boolean

• Returns boolean

  true if this section has been modified

wikitext

• get wikitext(): string

• Returns string

  The wikitext for this section.

close

• close(): void

• Destroys the element from the DOM and re-inserts in its place the original list. This should return the section back to its original look. This does NOT remove the section from the session or cache. Use DeputySession.closeSection instead.

  Returns void

getSection

• getSection(wikitext?): Promise<ContributionSurveySection>

• Get the ContributionSurveySection for this section

  Parameters

  • Optionalwikitext: string & {
        revid: number;
    }

    Internal use only. Used to skip section loading using existing wikitext.

  Returns Promise<ContributionSurveySection>

  The ContributionSurveySection for this section

loadData

• loadData(): Promise<void>

• Makes all rows of this section being loading data.

  Returns Promise<void>

  A Promise that resolves when all rows have finished loading data.

prepare

• prepare(): Promise<boolean>

• Perform any required pre-render operations.

  Returns Promise<boolean>

  true if prepared successfully. false if not (invalid section, already closed, etc.)

render

• render(): HTMLElement

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

  Returns HTMLElement

save

• save(sectionId): Promise<any>

• Saves the current section to the case page.

  Parameters

  • sectionId: number

  Returns Promise<any>

  Save data, or false if the save hit an error

setDisabled

• setDisabled(disabled): void

• Sets the disabled state of this section.

  Parameters

  • disabled: boolean

  Returns void

toggleClosingElements

• toggleClosingElements(show): void

• Toggles the closing comments input box and signature checkbox. This will disable the input box AND hide the element from view.

  Parameters

  • show: boolean

  Returns void

toggleSectionElements

• toggleSectionElements(toggle): void

• Toggle section elements. Removes the section elements (but preservers them in this.sectionElements) if false, re-appends them to the DOM if true.

  Parameters

  • toggle: boolean

  Returns void