Package bibliothek.gui.dock.common.location

Class CStackLocation

java.lang.Object
bibliothek.gui.dock.common.CLocation
bibliothek.gui.dock.common.location.AbstractStackholdingLocation
bibliothek.gui.dock.common.location.CStackLocation
public class CStackLocation extends AbstractStackholdingLocation
A location describing an element in a stack (also known as tabbed-pane).
Author:
Benjamin Sigg

  • Constructor Details

    • CStackLocation

      public CStackLocation(CLocation parent)
      Creates a new location
      Parameters:
      parent - the location of the stack

    • CStackLocation

      public CStackLocation(CLocation parent, int index)
      Creates a new location
      Parameters:
      parent - the location of the stack onto which this location builds
      index - the location of the tab represented by this location

  • Method Details

    • getParent

      public CLocation getParent()
      Gets the parent location of this CStackLocation.
      Specified by:
      getParent in class CLocation
      Returns:
      the parent location, not null

    • getIndex

      public int getIndex()
      Gets the index to which this location points on a stack.
      Returns:
      the index, may be Integer.MAX_VALUE

    • findRoot

      public String findRoot()
      Description copied from class: CLocation
      Gets the name of the station this location belongs to. This can be the id of any CStation.
      Specified by:
      findRoot in class CLocation
      Returns:
      the name of the station or null if this location does not have enough information to find the root

    • findMode

      public ExtendedMode findMode()
      Description copied from class: CLocation
      Gets the mode this location represents.
      Specified by:
      findMode in class CLocation
      Returns:
      the mode or null

    • findProperty

      public DockableProperty findProperty(DockableProperty successor)
      Description copied from class: CLocation
      Gets a path describing this location in terms of the DockingFrames.
      Specified by:
      findProperty in class CLocation
      Parameters:
      successor - the path of the elements above this location or null
      Returns:
      the path to this location or null, can also be successor

    • aside

      @Deprecated public CLocation aside()
      Deprecated.
      see CLocation.aside() for an explanation.
      Description copied from class: CLocation
      Returns a CLocation that describes the location of an element that should be inserted next to this location.
      Specified by:
      aside in class CLocation
      Returns:
      the new location

    • toString

      public String toString()
      Overrides:
      toString in class Object