Most visited

Recently visited

Added in API level 19

PrintDocumentInfo

public final class PrintDocumentInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.print.PrintDocumentInfo


该类为了打印目的封装了关于文档的信息。 此元数据由平台和打印服务,与打印机交互的组件使用。 例如,这个类包含了它描述的文档中包含的页面数量,并且这个页面显示给用户,允许他/她选择要打印的范围。 另外,打印服务可以根据内容类型优化打印过程,例如文档或照片。

此类的实例由打印应用程序创建,并在成功布置在 PrintDocumentAdapter.onLayout(PrintAttributes, PrintAttributes, android.os.CancellationSignal, PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle)执行的内容后传递给 PrintDocumentAdapter.LayoutResultCallback.onLayoutFinished( PrintDocumentInfo, boolean)回调。

一个示例用法如下所示:


 . . .

 public void onLayout(PrintAttributes oldAttributes, PrintAttributes newAttributes,
         CancellationSignal cancellationSignal, LayoutResultCallback callback,
         Bundle metadata) {

        // Assume the app defined a LayoutResult class which contains
        // the layout result data and that the content is a document.
        LayoutResult result = doSomeLayoutWork();

        PrintDocumentInfo info = new PrintDocumentInfo
                .Builder("printed_file.pdf")
                .setContentType(PrintDocumentInfo.CONTENT_TYPE_DOCUMENT)
                .setPageCount(result.getPageCount())
                .build();

       callback.onLayoutFinished(info, result.getContentChanged());
   }

   . . .

 

Summary

Nested classes

class PrintDocumentInfo.Builder

用于创建PrintDocumentInfo生成器。

Constants

int CONTENT_TYPE_DOCUMENT

内容类型:文档。

int CONTENT_TYPE_PHOTO

内容类型:照片。

int CONTENT_TYPE_UNKNOWN

内容类型:未知。

int PAGE_COUNT_UNKNOWN

对于未知页数而言为常量。

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<PrintDocumentInfo> CREATOR

Public methods

int describeContents()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。

boolean equals(Object obj)

指示其他某个对象是否“等于”这一个。

int getContentType()

获取内容类型。

long getDataSize()

获取以字节为单位的文档数据大小。

String getName()

获取文档名称。

int getPageCount()

获取总页数。

int hashCode()

返回对象的哈希码值。

String toString()

返回对象的字符串表示形式。

void writeToParcel(Parcel parcel, int flags)

将此对象平铺到一个包裹中。

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

CONTENT_TYPE_DOCUMENT

Added in API level 19
int CONTENT_TYPE_DOCUMENT

内容类型:文档。

打印服务可以使用普通纸张打印内容而不是专用照片纸。 也可能使用较低质量的打印过程,因为内容对照片的打印质量变化不敏感。

常量值:0(0x00000000)

CONTENT_TYPE_PHOTO

Added in API level 19
int CONTENT_TYPE_PHOTO

内容类型:照片。

打印服务可能会使用专用照片纸打印内容而不是普通纸张。 此外,它可能使用更高质量的打印过程,因为内容对打印质量变化比文档更敏感。

常数值:1(0x00000001)

CONTENT_TYPE_UNKNOWN

Added in API level 19
int CONTENT_TYPE_UNKNOWN

内容类型:未知。

常量值:-1(0xffffffff)

PAGE_COUNT_UNKNOWN

Added in API level 19
int PAGE_COUNT_UNKNOWN

对于未知页数而言为常量。

常量值:-1(0xffffffff)

Fields

CREATOR

Added in API level 19
Creator<PrintDocumentInfo> CREATOR

Public methods

describeContents

Added in API level 19
int describeContents ()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如,如果对象将在writeToParcel(Parcel, int)的输出中包含writeToParcel(Parcel, int) ,则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR位。

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

Added in API level 19
boolean equals (Object obj)

指示其他某个对象是否“等于”这一个。

equals方法在非空对象引用上实现等价关系:

  • 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.

equals方法Object实现了对象上最可能的等价关系; 也就是说,对于任何非空参考值xy ,当且仅当xy引用同一对象( x == y的值为true )时,此方法返回true

请注意,无论何时覆盖此方法,通常都需要覆盖 hashCode方法,以便维护 hashCode方法的一般合同,该方法声明等同对象必须具有相同的哈希代码。

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getContentType

Added in API level 19
int getContentType ()

获取内容类型。

Returns
int The content type.

也可以看看:

getDataSize

Added in API level 19
long getDataSize ()

获取以字节为单位的文档数据大小。

Returns
long The data size.

getName

Added in API level 19
String getName ()

获取文档名称。 该名称可能会显示给用户。

Returns
String The document name.

getPageCount

Added in API level 19
int getPageCount ()

获取总页数。

Returns
int The number of pages.

也可以看看:

hashCode

Added in API level 19
int hashCode ()

返回对象的哈希码值。 为了散列表的好处而支持该方法,例如由HashMap提供的HashMap

hashCode的总合同是:

  • 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(Object) 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(java.lang.Object) 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.

尽可能合理实用,由类Object定义的hashCode方法确实为不同的对象返回不同的整数。 (这通常通过将对象的内部地址转换为整数来实现,但Java TM编程语言不需要此实现技术。)

Returns
int a hash code value for this object.

toString

Added in API level 19
String toString ()

返回对象的字符串表示形式。 通常, toString方法返回一个“文本表示”此对象的字符串。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。

ObjecttoString方法返回一个字符串,其中包含对象为实例的类的名称,符号字符“ @ ”以及对象的哈希代码的无符号十六进制表示形式。 换句话说,这个方法返回一个字符串,其值等于:

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

Returns
String a string representation of the object.

writeToParcel

Added in API level 19
void writeToParcel (Parcel parcel, 
                int flags)

将此对象平铺到一个包裹中。

Parameters
parcel Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!