Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static final class

PrintAttributes.Margins

extends Object
java.lang.Object
   ↳ android.print.PrintAttributes.Margins

Class Overview

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

Fields
public static final PrintAttributes.Margins NO_MARGINS
Public Constructors
PrintAttributes.Margins (int leftMils, int topMils, int rightMils, int bottomMils)
Creates a new instance.
Public Methods
boolean equals ( Object obj)
Compares this instance with the specified object and indicates if they are equal.
int getBottomMils ()
Gets the bottom margin in mils (thousands of an inch).
int getLeftMils ()
Gets the left margin in mils (thousands of an inch).
int getRightMils ()
Gets the right margin in mils (thousands of an inch).
int getTopMils ()
Gets the top margin in mils (thousands of an inch).
int hashCode ()
Returns an integer hash code for this object.
String toString ()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final PrintAttributes.Margins NO_MARGINS

Added in API level 19

Public Constructors

public PrintAttributes.Margins (int leftMils, int topMils, int rightMils, int bottomMils)

Creates a new instance.

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

Public Methods

public boolean equals ( Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o . See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object ; false otherwise.

public int getBottomMils ()

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

Returns
  • The bottom margin.

public int getLeftMils ()

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

Returns
  • The left margin.

public int getRightMils ()

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

Returns
  • The right margin.

public int getTopMils ()

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

Returns
  • The top margin.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

          getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.