Class MarginInfo

Constructor Detail

• MarginInfo

  public MarginInfo​(boolean enabled)

  Creates a MarginInfo object with all edges set to either enabled or disabled.

  Parameters:

  enabled - the value to set for all edges

• MarginInfo

  @Deprecated
  public MarginInfo​(int bitMask)

  Deprecated.

  use other constructors instead of this one

  Creates a MarginInfo object from a bit mask.

  Parameters:

  bitMask - bits to set

• MarginInfo

  public MarginInfo​(boolean top,
                    boolean right,
                    boolean bottom,
                    boolean left)

  Creates a MarginInfo object by having each edge specified in clockwise order (analogous to CSS).

  Parameters:

  top - enable or disable top margin

  right - enable or disable right margin

  bottom - enable or disable bottom margin

  left - enable or disable left margin

• MarginInfo

  public MarginInfo​(boolean vertical,
                    boolean horizontal)

  Creates a MarginInfo object by having horizontal and vertical margins specified (analogous to CSS).

  Parameters:

  vertical - enable or disable top and bottom margins

  horizontal - enable or disable left and right margins

  Since:

  7.6.5

• MarginInfo

  public MarginInfo​(MarginInfo other)

  Creates a MarginInfo with the same values as another MarginInfo object.

  Parameters:

  other - another MarginInfo object

Method Detail

• setMargins

  public void setMargins​(boolean enabled)

  Enables or disables margins on all edges simultaneously.

  Parameters:

  enabled - if true, enables margins on all edges. If false, disables margins on all edges.

• setMargins

  public void setMargins​(boolean top,
                         boolean right,
                         boolean bottom,
                         boolean left)

  Sets margins on all edges individually.

  Parameters:

  top - enable or disable top margin

  right - enable or disable right margin

  bottom - enable or disable bottom margin

  left - enable or disable left margin

• setMargins

  public void setMargins​(MarginInfo marginInfo)

  Copies margin values from another MarginInfo object.

  Parameters:

  marginInfo - another marginInfo object

• hasAll

  public boolean hasAll()

  Checks if this MarginInfo object has margins on all edges enabled.

  Returns:

  true if all edges have margins enabled

  Since:

  7.5.0

• hasNone

  public boolean hasNone()

  Checks if this MarginInfo object has no margins enabled.

  Returns:

  true if all edges have margins disabled

  Since:

  8.0

• hasLeft

  public boolean hasLeft()

  Checks if this MarginInfo object has the left edge margin enabled.

  Returns:

  true if left edge margin is enabled

• hasRight

  public boolean hasRight()

  Checks if this MarginInfo object has the right edge margin enabled.

  Returns:

  true if right edge margin is enabled

• hasTop

  public boolean hasTop()

  Checks if this MarginInfo object has the top edge margin enabled.

  Returns:

  true if top edge margin is enabled

• hasBottom

  public boolean hasBottom()

  Checks if this MarginInfo object has the bottom edge margin enabled.

  Returns:

  true if bottom edge margin is enabled

• getBitMask

  @Deprecated
  public int getBitMask()

  Deprecated.

  Returns the current bit mask that make up the margin settings.

  This method is for internal use by the framework.

  Returns:

  an integer bit mask

• equals

  public boolean equals​(Object obj)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• toString

  public String toString()

  Overrides:

  toString in class Object