Resolution
class Resolution
kotlin.Any | |
↳ | android.print.PrintAttributes.Resolution |
This class specifies a supported resolution in DPI (dots per inch). Resolution defines how many points with different color can be placed on one inch in horizontal or vertical direction of the target media. For example, a printer with 600 DPI can produce higher quality images the one with 300 DPI resolution.
Summary
Public constructors | |
---|---|
Resolution(id: String, label: String, horizontalDpi: Int, verticalDpi: Int) Creates a new instance. |
Public methods | |
---|---|
Boolean |
Indicates whether some other object is "equal to" this one. |
Int |
Gets the horizontal resolution in DPI (dots per inch). |
String |
getId() Gets the unique resolution id. |
String |
getLabel() Gets the resolution human readable label. |
Int |
Gets the vertical resolution in DPI (dots per inch). |
Int |
hashCode() |
String |
toString() |
Public constructors
Resolution
Resolution(
id: String,
label: String,
horizontalDpi: Int,
verticalDpi: Int)
Creates a new instance.
Parameters | |
---|---|
id |
String: The unique resolution id. It is unique amongst other resolutions supported by the printer. This value cannot be null . |
label |
String: The localized human readable label. This value cannot be null . |
horizontalDpi |
Int: The horizontal resolution in DPI (dots per inch). Value is 1 or greater |
verticalDpi |
Int: The vertical resolution in DPI (dots per inch). Value is 1 or greater |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If the id is empty or the label is empty or the horizontalDpi is less than or equal to zero or the verticalDpi is less than or equal to zero. |
Public methods
equals
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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. |
getHorizontalDpi
fun getHorizontalDpi(): Int
Gets the horizontal resolution in DPI (dots per inch).
Return | |
---|---|
Int |
The horizontal resolution. Value is 1 or greater |
getId
fun getId(): String
Gets the unique resolution id. It is unique amongst other resolutions supported by the printer.
This id is defined by the client that generated the resolution instance and should not be interpreted by other parties.
Return | |
---|---|
String |
The unique resolution id. This value cannot be null . |
getLabel
fun getLabel(): String
Gets the resolution human readable label.
Return | |
---|---|
String |
The human readable label. This value cannot be null . |
getVerticalDpi
fun getVerticalDpi(): Int
Gets the vertical resolution in DPI (dots per inch).
Return | |
---|---|
Int |
The vertical resolution. Value is 1 or greater |
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |