Package bibliothek.gui.dock.common.group

Class TopMostGroupBehavior

java.lang.Object
bibliothek.gui.dock.common.group.TopMostGroupBehavior
All Implemented Interfaces:
CGroupBehavior
public class TopMostGroupBehavior extends Object implements CGroupBehavior
This most simple CGroupBehavior just set the mode of the one Dockable whose mode should change anyway.
Author:
Benjamin Sigg

  • Constructor Details

    • TopMostGroupBehavior

      public TopMostGroupBehavior()

  • Method Details

    • prepare

      public CGroupMovement prepare(LocationModeManager<? extends LocationMode> manager, Dockable dockable, ExtendedMode target)
      Description copied from interface: CGroupBehavior
      Calculates how the mode of dockable has to be changed such that it matches target. Please note that some modules use directly CGroupBehavior.getGroupElement(LocationModeManager, Dockable, ExtendedMode) and do never call this method.
      Specified by:
      prepare in interface CGroupBehavior
      Parameters:
      manager - a manager which may be asked for additional information
      dockable - the element that was clicked by the user
      target - the extended mode intended for dockable
      Returns:
      the operation to execute, may be null

    • getGroupElement

      public Dockable getGroupElement(LocationModeManager<? extends LocationMode> manager, Dockable dockable, ExtendedMode mode)
      Description copied from interface: CGroupBehavior
      Gets the element whose location or mode must be changed in order to apply mode to dockable. Normally dockable itself is returned, or a parent DockStation of dockable.
      Specified by:
      getGroupElement in interface CGroupBehavior
      Parameters:
      manager - a manager which may be asked for additional information
      dockable - some element, not null
      mode - the target mode
      Returns:
      the element that must be repositioned, might be dockable itself, not null

    • getReplaceElement

      public Dockable getReplaceElement(LocationModeManager<? extends LocationMode> manager, Dockable old, Dockable dockable, ExtendedMode mode)
      Description copied from interface: CGroupBehavior
      Gets the element which would replace old if old is currently in mode, and dockable is or will not be in mode.
      Specified by:
      getReplaceElement in interface CGroupBehavior
      Parameters:
      manager - a manager which may be asked for additional information
      old - some element
      dockable - some element, might be old
      mode - the mode in which old is
      Returns:
      the element which would be maximized if dockable is no longer in mode, can be null

    • shouldForwardActions

      public boolean shouldForwardActions(LocationModeManager<? extends LocationMode> manager, DockStation station, Dockable dockable, ExtendedMode mode)
      Description copied from interface: CGroupBehavior
      Tells whether the actions of dockable for mode mode should be shown on station too.
      Specified by:
      shouldForwardActions in interface CGroupBehavior
      Parameters:
      manager - a manager which may be asked for additional information
      station - the parent of dockable
      dockable - the element whose actions will be shown
      mode - the mode for which the actions are requested
      Returns:
      true if the actions should be forwarded