Padding (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.Padding

```
@Equality
public class Padding
extends java.lang.Object
```
Defines user preferences for padding a rectangular area. This resembles Insets, except that each member may be null, to indicate that the user has no preference. And it's immutable.

Since:

9 Dec 2016

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor	Description
`Padding()`	Constructs an empty padding object (no preferences).
`Padding(java.lang.Integer top, java.lang.Integer left, java.lang.Integer bottom, java.lang.Integer right)`	Constructs a padding object with preferences for all dimensions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.Integer`	`getBottom()`	Returns the required bottom margin.
`java.lang.Integer`	`getLeft()`	Returns the required left margin.
`java.lang.Integer`	`getRight()`	Returns the required right margin.
`java.lang.Integer`	`getTop()`	Returns the required top margin.
`int`	`hashCode()`
`boolean`	`isDefinite()`	Returns true if all the members of this padding object are non-null.
`java.awt.Insets`	`overrideInsets(java.awt.Insets insets)`	Applies the requirements specified by this object to an existing Insets object.
`java.awt.Insets`	`toDefiniteInsets()`	Returns the insets object corresponding to this padding object if all the members are non-null, and null otherwise.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Padding
```
public Padding()
```
    Constructs an empty padding object (no preferences).
  - Padding
```
public Padding(java.lang.Integer top,
               java.lang.Integer left,
               java.lang.Integer bottom,
               java.lang.Integer right)
```
    Constructs a padding object with preferences for all dimensions. Any of the arguments may be null.
    
    Parameters:
    
    top - required top margin in pixels, or null
    
    left - required left margin in pixels, or null
    
    bottom - required bottom margin in pixels, or null
    
    right - required right margin in pixels, or null
- Method Detail
  - getTop
```
public java.lang.Integer getTop()
```
    Returns the required top margin.
    
    Returns:
    
    top margin in pixels, or null for no preference
  - getLeft
```
public java.lang.Integer getLeft()
```
    Returns the required left margin.
    
    Returns:
    
    left margin in pixels, or null for no preference
  - getBottom
```
public java.lang.Integer getBottom()
```
    Returns the required bottom margin.
    
    Returns:
    
    bottom margin in pixels, or null for no preference
  - getRight
```
public java.lang.Integer getRight()
```
    Returns the required right margin.
    
    Returns:
    
    right margin in pixels, or null for no preference
  - overrideInsets
```
public java.awt.Insets overrideInsets(java.awt.Insets insets)
```
    Applies the requirements specified by this object to an existing Insets object. The members of the returned insets object are those of this object where they are non-null, and those of the supplied insets otherwise.
    
    Parameters:
    
    insets - input insets object
    
    Returns:
    
    new insets object with values taken from this padding where available
  - isDefinite
```
public boolean isDefinite()
```
    Returns true if all the members of this padding object are non-null.
    
    Returns:
    
    true iff all margins have definite values
  - toDefiniteInsets
```
public java.awt.Insets toDefiniteInsets()
```
    Returns the insets object corresponding to this padding object if all the members are non-null, and null otherwise.
    
    Returns:
    
    insets if isDefinite(), otherwise null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class Padding

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Padding

Padding

Method Detail

getTop

getLeft

getBottom

getRight

overrideInsets

isDefinite

toDefiniteInsets

hashCode

equals