Added in API level 19

Margins


class Margins
kotlin.Any
   ↳ android.print.PrintAttributes.Margins

This class specifies content margins. Margins define the white space around the content where the left margin defines the amount of white space on the left of the content and so on.

Summary

Public constructors
Margins(leftMils: Int, topMils: Int, rightMils: Int, bottomMils: Int)

Creates a new instance.

Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Int

Gets the bottom margin in mils (thousandths of an inch).

Int

Gets the left margin in mils (thousandths of an inch).

Int

Gets the right margin in mils (thousandths of an inch).

Int

Gets the top margin in mils (thousandths of an inch).

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Properties
static PrintAttributes.Margins!

Public constructors

Margins

Added in API level 19
Margins(
    leftMils: Int,
    topMils: Int,
    rightMils: Int,
    bottomMils: Int)

Creates a new instance.

Parameters
leftMils Int: The left margin in mils (thousandths of an inch).
topMils Int: The top margin in mils (thousandths of an inch).
rightMils Int: The right margin in mils (thousandths of an inch).
bottomMils Int: The bottom margin in mils (thousandths of an inch).

Public methods

equals

Added in API level 19
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getBottomMils

Added in API level 19
fun getBottomMils(): Int

Gets the bottom margin in mils (thousandths of an inch).

Return
Int The bottom margin.

getLeftMils

Added in API level 19
fun getLeftMils(): Int

Gets the left margin in mils (thousandths of an inch).

Return
Int The left margin.

getRightMils

Added in API level 19
fun getRightMils(): Int

Gets the right margin in mils (thousandths of an inch).

Return
Int The right margin.

getTopMils

Added in API level 19
fun getTopMils(): Int

Gets the top margin in mils (thousandths of an inch).

Return
Int The top margin.

hashCode

Added in API level 19
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 19
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

Properties

NO_MARGINS

Added in API level 19
static val NO_MARGINS: PrintAttributes.Margins!