Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
Help
Prev Class
Next Class
Java Native Rendering
Class org.violetlib.jnr.FloatingInsetter1
Inherited members: ShowHide
Deprecated: ShowHide
org.violetlib.jnr

Class FloatingInsetter1

  • Object
    • FloatingInsetter1
  • All Implemented Interfaces:
    Insetter1
    public class FloatingInsetter1 extends Object implements Insetter1
    A floating insetter defines a region of fixed size, with either one or both insets being variable.
    • Static Methods 
      Modifier and Type Static Method and Description
      Ordinary member indicator createCentered Reveal DetailHide Detail
      static FloatingInsetter1 createCentered(float regionSize, float d1, float d2)
      Create a single dimension insets for a fixed size region that is centered between two minimum insets.
      @NotNull public static FloatingInsetter1 createCentered(float regionSize, float d1, float d2)
      Create a single dimension insets for a fixed size region that is centered between two minimum insets. Any extra space is divided equally and added to the two insets.
      Parameters:
      regionSize - The fixed region size.
      d1 - The minimum offset of the region from the left or bottom edge of the component.
      d2 - The minimum offset of the region from the right or bottom edge of the component.
      Throws:
      IllegalArgumentException - if regionSize, d1, or d2 is negative.
      Ordinary member indicator createLeftTopAligned Reveal DetailHide Detail
      static FloatingInsetter1 createLeftTopAligned(float regionSize, float d1)
      Create a single dimension insets for a fixed size region that is positioned at a fixed offset from the left or top edge of the component.
      @NotNull public static FloatingInsetter1 createLeftTopAligned(float regionSize, float d1)
      Create a single dimension insets for a fixed size region that is positioned at a fixed offset from the left or top edge of the component.
      Parameters:
      regionSize - The fixed region size.
      d1 - The offset of the region from the left or top edge of the component.
      Throws:
      IllegalArgumentException - if regionSize or d1 is negative.
      Ordinary member indicator createRightBottomAligned Reveal DetailHide Detail
      static FloatingInsetter1 createRightBottomAligned(float regionSize, float d2)
      Create a single dimension insets for a fixed size region that is positioned at a fixed offset from the right or bottom edge of the component.
      @NotNull public static FloatingInsetter1 createRightBottomAligned(float regionSize, float d2)
      Create a single dimension insets for a fixed size region that is positioned at a fixed offset from the right or bottom edge of the component.
      Parameters:
      regionSize - The fixed region size.
      d2 - The offset of the region from the right or bottom edge of the component.
      Throws:
      IllegalArgumentException - if regionSize or d2 is negative.
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator getComponentSize Reveal DetailHide Detail
      float getComponentSize(float regionSize)
      Map the region size to the size of the component.
      public float getComponentSize(float regionSize) throws InsetterNotInvertibleException
      Description copied from interface: Insetter1
      Map the region size to the size of the component. This operation is valid only if the insetter is invertible.
      Specified by:
      getComponentSize in interface Insetter1
      Parameters:
      regionSize - The region size along the relevant axis.
      Returns:
      the component size along the axis.
      Throws:
      InsetterNotInvertibleException - if this insetter is not invertible.
      Ordinary member indicator getFixedInset1 Reveal DetailHide Detail
      float getFixedInset1()
      Return the left or top inset, if it is fixed.
      public float getFixedInset1()
      Description copied from interface: Insetter1
      Return the left or top inset, if it is fixed.
      Specified by:
      getFixedInset1 in interface Insetter1
      Returns:
      the inset, or -1 if not fixed.
      Ordinary member indicator getFixedInset2 Reveal DetailHide Detail
      float getFixedInset2()
      Return the right or bottom inset, if it is fixed.
      public float getFixedInset2()
      Description copied from interface: Insetter1
      Return the right or bottom inset, if it is fixed.
      Specified by:
      getFixedInset2 in interface Insetter1
      Returns:
      the inset, or -1 if not fixed.
      Ordinary member indicator getRegionOrigin Reveal DetailHide Detail
      float getRegionOrigin(float componentSize)
      Map the component size to the origin of the region, relative to the left or top edge of the component.
      public float getRegionOrigin(float componentSize)
      Description copied from interface: Insetter1
      Map the component size to the origin of the region, relative to the left or top edge of the component.
      Specified by:
      getRegionOrigin in interface Insetter1
      Parameters:
      componentSize - The component size along the relevant axis.
      Returns:
      The origin of the region along the axis relative to the component.
      Ordinary member indicator getRegionSize Reveal DetailHide Detail
      float getRegionSize(float componentSize)
      Map the component size to the size of the region.
      public float getRegionSize(float componentSize)
      Description copied from interface: Insetter1
      Map the component size to the size of the region.
      Specified by:
      getRegionSize in interface Insetter1
      Parameters:
      componentSize - The component size along the relevant axis.
      Returns:
      the region size along the relevant axis.
      Ordinary member indicator isInvertible Reveal DetailHide Detail
      boolean isInvertible()
      Indicate whether this insetter is invertible.
      public boolean isInvertible()
      Description copied from interface: Insetter1
      Indicate whether this insetter is invertible. An invertible insetter can map a region size to the component size.
      Specified by:
      isInvertible in interface Insetter1
      • Methods inherited from class Object

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