Class ViewSectionAbstract

content

collapse

• collapse(): Promise<void>

• Collapse the section if expanded

  Returns Promise<void>

  Promise resolving when the section is collapsed

expand

• expand(): Promise<void>

• Expand the section if collapsed

  Returns Promise<void>

  Promise resolving when the section is expanded

Abstract findItem

• findItem(label, maxLevel?): Promise<undefined | ViewItem>

• Find an item in this view section by label. Does not perform recursive search through the whole tree. Does however scroll through all the expanded content. Will find items beyond the current scroll range.

  Parameters

  • label: string

    Label of the item to search for.

  • Optional maxLevel: number

    Limit how deep the algorithm should look into any expanded items, default unlimited (0)

  Returns Promise<undefined | ViewItem>

  Promise resolving to ViewItem object is such item exists, undefined otherwise

findWelcomeContent

• findWelcomeContent(): Promise<undefined | WelcomeContentSection>

• Finds Welcome Content present in this ViewSection and returns it. If none is found, then undefined is returned

  Returns Promise<undefined | WelcomeContentSection>

getAction

• getAction(label): Promise<undefined | ViewPanelAction>

• Retrieve an action button on the sections's header by its label

  Parameters

  • label: string

    label/title of the button

  Returns Promise<undefined | ViewPanelAction>

  ViewPanelAction object if found, undefined otherwise

getActions

• getActions(): Promise<ViewPanelAction[]>

• Retrieve the action buttons on the section's header

  Returns Promise<ViewPanelAction[]>

  Promise resolving to array of ViewPanelAction objects

getTitle

• getTitle(): Promise<string>

• Get the title of the section as string

  Returns Promise<string>

  Promise resolving to section title

Abstract getVisibleItems

• getVisibleItems(): Promise<ViewItem[]>

• Retrieve all items currently visible in the view section. Note that any item currently beyond the visible list, i.e. not scrolled to, will not be retrieved.

  Returns Promise<ViewItem[]>

  Promise resolving to array of ViewItem objects

isExpanded

• isExpanded(): Promise<boolean>

• Finds whether the section is expanded

  Returns Promise<boolean>

  Promise resolving to true/false

moreActions

• moreActions(): Promise<undefined | ContextMenu>

• Click on the More Actions... item if it exists

  Returns Promise<undefined | ContextMenu>

  ContextMenu page object if the action succeeds, undefined otherwise

Abstract openItem

• openItem(...path): Promise<ViewItem[]>

• Open an item with a given path represented by a sequence of labels

  e.g to open 'file' inside 'folder', call openItem('folder', 'file')

  The first item is only searched for directly within the root element (depth 1). The label sequence is handled in order. If a leaf item (a file for example) is found in the middle of the sequence, the rest is ignored.

  If the item structure is flat, use the item's title to search by.

  Parameters

  • Rest ...path: string[]

    Sequence of labels that make up the path to a given item.

  Returns Promise<ViewItem[]>

  Promise resolving to array of ViewItem objects representing the last item's children. If the last item is a leaf, empty array is returned.