Package de.cau.cs.kieler.klighd.ui.internal.options

Class DiagramSideBar

java.lang.Object
de.cau.cs.kieler.klighd.ui.internal.options.DiagramSideBar
public final class DiagramSideBar extends Object
Builds up the diagram side bar containing the controls for configuring diagram synthesis and layout options.
Author:
chsch

  • Method Summary

    Modifier and Type
    Method
    Description
    static DiagramSideBar
    createSideBar(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Composite diagramContainer, ViewContext viewContext)
    Creates and attaches a side bar to the given parent Composite.
    The given diagramContainer is thereby integrated in the tree of widgets.
    void
    dispose()
    Disposes the Resources.
    org.eclipse.elk.core.LayoutConfigurator
    getLayoutConfig()
    Provides the LayoutConfigurator with layout settings from this side bar.
    void
    resetLayoutOptionsToDefaults(boolean doLayout)
    Resets the layout option settings configured via the sidebar's controls.
    void
    updateOptions(org.eclipse.swt.widgets.Composite diagramComposite, ViewContext theViewContext, boolean fitSpace)
    Update the options to be displayed in the options pane.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getLayoutConfig

      public org.eclipse.elk.core.LayoutConfigurator getLayoutConfig()
      Provides the LayoutConfigurator with layout settings from this side bar.
      Returns:
      the employed LayoutConfigurator

    • createSideBar

      public static DiagramSideBar createSideBar(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Composite diagramContainer, ViewContext viewContext)
      Creates and attaches a side bar to the given parent Composite.
      The given diagramContainer is thereby integrated in the tree of widgets.
      Parameters:
      parent - the parent Composite to attach the side bar to
      diagramContainer - the Composite accommodating the diagram (later on)
      viewContext - the ViewContext to get the configured option entries from
      Returns:
      an instance of DiagramSideBar allowing to access the employed LayoutConfigurator

    • updateOptions

      public void updateOptions(org.eclipse.swt.widgets.Composite diagramComposite, ViewContext theViewContext, boolean fitSpace)
      Update the options to be displayed in the options pane.
      Parameters:
      diagramComposite - the Composite the diagram canvas is contained in
      theViewContext - the current ViewContext
      fitSpace - true if the diagram shall fit the available space

    • resetLayoutOptionsToDefaults

      public void resetLayoutOptionsToDefaults(boolean doLayout)
      Resets the layout option settings configured via the sidebar's controls.
      Parameters:
      doLayout - if true a subsequent layout run will be triggered

    • dispose

      public void dispose()
      Disposes the Resources.