Describes a Dock Manager component.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrDockManager

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get activePane(): IgrContentPane
  • Gets/sets the active pane of the Dock Manager.

    Returns IgrContentPane

  • set activePane(v): void
  • Parameters

    Returns void

  • get allowFloatingPanesResize(): boolean
  • Determines whether the end user is allowed to resize floating panes. Defaults to true.

    Returns boolean

  • set allowFloatingPanesResize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowInnerDock(): boolean
  • Determines whether the end user is allowed to inner dock panes. Defaults to true.

    Returns boolean

  • set allowInnerDock(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowMaximize(): boolean
  • Determines whether the end user is allowed to maximize panes. Defaults to true.

    Returns boolean

  • set allowMaximize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disableKeyboardNavigation(): boolean
  • Disables the built-in keyboard shortcuts for pane navigation. Defaults to false.

    Returns boolean

  • set disableKeyboardNavigation(v): void
  • Parameters

    • v: boolean

    Returns void

  • get dropPosition(): IgrDockManagerPoint
  • Gets/sets the current drop position when performing custom drag/drop.

    Returns IgrDockManagerPoint

  • set dropPosition(v): void
  • Parameters

    Returns void

  • get layout(): IgrDockManagerLayout
  • Gets/sets the layout configuration of the Dock Manager.

    Returns IgrDockManagerLayout

  • set layout(v): void
  • Parameters

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Focuses a pane from the layout.

    Parameters

    • contentId: string

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Returns DOMElement<{
        children: any[];
        className: P["className"];
        ref: ((ref) => void);
        style: P["style"];
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean