Package org.praxislive.ide.pxr.spi

Interface RootEditor.Context

Enclosing interface:
RootEditor
public static interface RootEditor.Context
A context for the root editor, providing additional data and a connection back to the containing editor top component.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.openide.windows.TopComponent
    container()
    Access the editor top component that the editor is installed in.
    org.openide.explorer.ExplorerManager
    explorerManager()
    The context explorer manager.
    Optional<org.openide.filesystems.FileObject>
    file()
    Access the file that backs the root, if available.
    Optional<org.praxislive.ide.project.api.PraxisProject>
    project()
    Access the project that the root is part of, if available.
    Optional<Action>
    sharedCodeAction()
    Access the optional shared code viewer action.

  • Method Details

    • container

      org.openide.windows.TopComponent container()
      Access the editor top component that the editor is installed in.
      Returns:
      top component container

    • explorerManager

      org.openide.explorer.ExplorerManager explorerManager()
      The context explorer manager. The editor should usually update and respond to updates in the main explorer manager.
      Returns:
      context explorer manager

    • file

      Optional<org.openide.filesystems.FileObject> file()
      Access the file that backs the root, if available.
      Returns:
      file or empty optional

    • project

      Optional<org.praxislive.ide.project.api.PraxisProject> project()
      Access the project that the root is part of, if available.
      Returns:
      project or empty optional

    • sharedCodeAction

      Optional<Action> sharedCodeAction()
      Access the optional shared code viewer action.

      This action will be provided if the root proxy has SharedCodeInfo in its lookup and the context provides a way to view.

      Returns:
      action or empty optional