Package se.conciliate.extensions.ui

Interface Sidebar

public interface Sidebar
A sidebar is a docked panel in 2c8 Modeling Tool.
Author:
Per-Erik

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Called when this sidebar needs to clean up.
    default void
    focusLost()
    Called when the sidebar loses "focus", i.e.
    JComponent
    getContent()
    Returns the component that makes up this sidebar.
    Icon
    getIcon()
    Returns an icon that is rendered next to the title of this sidebar.
    String
    getID()
    Returns a unique id for this sidebar.
    Icon
    getMediumIcon()
    Returns an icon that is rendered in the header of this sidebar.
    SidebarSettings
    getSettings()
    Returns the settings for this sidebar, or null if no settings are available.
    Icon
    getSmallIcon()
    Returns an icon that is rendered next to the title of this sidebar.
    String
    getTitle()
    Returns the displayable name of this sidebar.

  • Method Details

    • getID

      String getID()
      Returns a unique id for this sidebar. The id must not change between JVMs or JVM-instances.
      Returns:
      A unique persistent id representing this sidebar now and in the future.

    • getTitle

      String getTitle()
      Returns the displayable name of this sidebar.
      Returns:
      The displayable title of this sidebar

    • getIcon

      Icon getIcon()
      Returns an icon that is rendered next to the title of this sidebar. Note that if this icon is not 32x32 pixels or smaller, it may get scaled. If both dimensions are 32 pixels or less, it will never get scaled. May be null.
      Returns:
      The displayable icon of this sidebar

    • getMediumIcon

      Icon getMediumIcon()
      Returns an icon that is rendered in the header of this sidebar. Note that if this icon is not 24x24 pixels or smaller, it may get scaled. If both dimensions are 24 pixels or less, it will never get scaled. May be null.
      Returns:
      The displayable icon of this sidebar

    • getSmallIcon

      Icon getSmallIcon()
      Returns an icon that is rendered next to the title of this sidebar. Note that if this icon is not 16x16 pixels or smaller, it may get scaled. If both dimensions are 16 pixels or less, it will never get scaled. May be null.
      Returns:
      The displayable icon of this sidebar

    • getContent

      JComponent getContent()
      Returns the component that makes up this sidebar. This is the component that will get added/docked in 2c8 Modeling Tool.
      Returns:
      The contents of this sidebar

    • getSettings

      SidebarSettings getSettings()
      Returns the settings for this sidebar, or null if no settings are available.
      Returns:
      The sidebar settings or null.

    • dispose

      void dispose()
      Called when this sidebar needs to clean up. Possibly due to the sidebar being closed by the user. Most implementations will not need to implement anything for this method (since you should already do clean ups when the bundle stops). However, this method will be called when the bundle stops.

    • focusLost

      default void focusLost()
      Called when the sidebar loses "focus", i.e. user clicks somewhere else in the user interface.