Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PdfOrganizerDialog<SS>

PDF Organizer dialog.

Type parameters

  • SS

Hierarchy

  • Component<PdfOrganizerDialogProps, PdfOrganizerModel>
    • PdfOrganizerDialog

Index

Constructors

constructor

  • new PdfOrganizerDialog(props: PdfOrganizerDialogProps, context?: any): PdfOrganizerDialog

Properties

context

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>
see

https://reactjs.org/docs/context.html

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

Static Readonly ROOT_ID_PREFIX

ROOT_ID_PREFIX: string = "gc-pdf-organizer-root"

The root DOM element identifier prefix. The resulting DOM element ID will be #${ROOT_ID_PREFIX}_${viewer.instanceId}.

Static Optional contextType

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}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<PdfOrganizerDialogProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<PdfOrganizerDialogProps>, nextState: Readonly<PdfOrganizerModel>, nextContext: any): void

applyChanges

  • applyChanges(closeDialog?: boolean): Promise<boolean>
  • Apply changes, reload document and close dialog.

    Parameters

    • Default value closeDialog: boolean = true

    Returns Promise<boolean>

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<PdfOrganizerDialogProps>, prevState: Readonly<PdfOrganizerModel>, snapshot?: SS): 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<PdfOrganizerDialogProps>
    • prevState: Readonly<PdfOrganizerModel>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<PdfOrganizerDialogProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): 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

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<PdfOrganizerDialogProps>, nextState: Readonly<PdfOrganizerModel>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<PdfOrganizerDialogProps>, prevState: Readonly<PdfOrganizerModel>): SS | null
  • 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<PdfOrganizerDialogProps>
    • prevState: Readonly<PdfOrganizerModel>

    Returns SS | null

hide

  • hide(): void
  • Hides the dialog

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<PdfOrganizerDialogProps>, nextState: Readonly<PdfOrganizerModel>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<PdfOrganizerDialogProps>
    • nextState: Readonly<PdfOrganizerModel>
    • nextContext: any

    Returns boolean

show

  • Shows the 'PDF Organizer' dialog box.

    Parameters

    Returns Promise<void>