Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabPanelDashboardLayoutRegion

Hierarchy

Index

Constructors

constructor

Properties

content

content: TabPanel

Protected metadata

typeName

typeName: LayoutTypes = LayoutTypes.TabPanelDashboardLayoutRegion

Accessors

widgets

Methods

Private _markSubtreeForUpdate

  • _markSubtreeForUpdate(): void

Private _updateSkippedSubtrees

  • _updateSkippedSubtrees(): void

addChild

clearAttachedProperties

copyAttachedProperties

createDragShadow

  • Create a drag shadow for one of this region's children.

    remarks

    Drag shadows are signifiers of the region being dragged, and indicate to the user what the dragged region is. For some regions (like the Canvas), it's useful to customize this shadow to expose more information (such as how it will be positioned in the CanvasPanel).

    The shadow must be completely static- it will not recieve any events, and will be destroyed at the end of the drag operation.

    Parameters

    • child: DashboardLayoutRegion<any>

      The region that is being dragged

    • clientX: number

      The X coordinate that the drag will start from

    • clientY: number

      The Y coordinate that the drag will start from

    Returns HTMLElement

    A valid HTML node that will follow the mouse during the drag.

dispose

  • dispose(): void

getAttachedPropertyForChild

Protected getDefault

  • getDefault(propertyName: string): unknown

Private handleCurrentChanged

  • handleCurrentChanged(_sender: TabPanel, __namedParameters: object): void

Private handleTabDetached

  • handleTabDetached(_sender: TabBar<Widget>, __namedParameters: object): void

Private handleTabMoved

  • handleTabMoved(_sender: TabBar<Widget>, __namedParameters: object): void

insertChild

  • Insert a new child into this container at a particular index.

    Notes

    If the widget is already in this region's children, then the widget is moved instead. This matches the behavior of Phosphor panels.

    This function also sets the parentRegion of the widget to this region.

    Parameters

    Returns void

Protected installContentTap

  • installContentTap(): void
  • Installs a message tap on the content to listen for child-removed.

    This tap is necessary for regions that use a custom layout algorithm, since the parent won't necessarily be notified when a Panel child is removed.

    Returns void

layoutChildren

  • layoutChildren(): void

Protected onChildRegionAdded

Protected onChildRegionRemoved

Protected onCloseRequest

  • onCloseRequest(): void

processMessage

  • processMessage(msg: Message): void

pruneSubtree

  • pruneSubtree(): void
  • Clean up this subtree by removing auto-generated empty regions.

    Notes

    This is a framework function and not meant to be called by user code. The MavenWorks framework will automatically manage the health of the layout, pruning when useful.

    Whether a region is "prunable" or not is specified by the <a href="../interfaces/regionwithchildren.iprops.html#prunable">prunable</a> layout property. For regions created with SurroundWith, this property is true.

    see

    IRegionWithChildrenProps.prunable

    see

    DashboardActions.SurroundWith

    Returns void

setFresh

  • setFresh(): void

sizeContentToFit

  • sizeContentToFit(bounds: object): void

subtree

updateFromProperties

  • updateFromProperties(): void

Static GetMetadata

Generated using TypeDoc