/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.print;
import android.content.pm.PackageManager;
import android.content.pm.PackageManager.NameNotFoundException;
import android.content.res.Resources.NotFoundException;
import android.os.Parcel;
import android.os.Parcelable;
import android.text.TextUtils;
import android.util.ArrayMap;
import android.util.Log;
import com.android.internal.R;
import java.util.Map;
/**
* This class represents the attributes of a print job. These attributes
* describe how the printed content should be laid out. For example, the
* print attributes may state that the content should be laid out on a
* letter size with 300 DPI (dots per inch) resolution, have a margin of
* 10 mills (thousand of an inch) on all sides, and be black and white.
*/
public final class PrintAttributes implements Parcelable {
/** Color mode: Monochrome color scheme, for example one color is used. */
public static final int COLOR_MODE_MONOCHROME = 1 << 0;
/** Color mode: Color color scheme, for example many colors are used. */
public static final int COLOR_MODE_COLOR = 1 << 1;
private static final int VALID_COLOR_MODES =
COLOR_MODE_MONOCHROME | COLOR_MODE_COLOR;
private MediaSize mMediaSize;
private Resolution mResolution;
private Margins mMinMargins;
private int mColorMode;
PrintAttributes() {
/* hide constructor */
}
private PrintAttributes(Parcel parcel) {
mMediaSize = (parcel.readInt() == 1) ? MediaSize.createFromParcel(parcel) : null;
mResolution = (parcel.readInt() == 1) ? Resolution.createFromParcel(parcel) : null;
mMinMargins = (parcel.readInt() == 1) ? Margins.createFromParcel(parcel) : null;
mColorMode = parcel.readInt();
}
/**
* Gets the media size.
*
* @return The media size or <code>null</code> if not set.
*/
public MediaSize getMediaSize() {
return mMediaSize;
}
/**
* Sets the media size.
*
* @param The media size.
*
* @hide
*/
public void setMediaSize(MediaSize mediaSize) {
mMediaSize = mediaSize;
}
/**
* Gets the resolution.
*
* @return The resolution or <code>null</code> if not set.
*/
public Resolution getResolution() {
return mResolution;
}
/**
* Sets the resolution.
*
* @param The resolution.
*
* @hide
*/
public void setResolution(Resolution resolution) {
mResolution = resolution;
}
/**
* Gets the minimal margins. If the content does not fit
* these margins it will be clipped.
* <p>
* <strong>These margins are physically imposed by the printer and they
* are <em>not</em> rotated, i.e. they are the same for both portrait and
* landscape. For example, a printer may not be able to print in a stripe
* on both left and right sides of the page.
* </strong>
* </p>
*
* @return The margins or <code>null</code> if not set.
*/
public Margins getMinMargins() {
return mMinMargins;
}
/**
* Sets the minimal margins. If the content does not fit
* these margins it will be clipped.
* <p>
* <strong>These margins are physically imposed by the printer and they
* are <em>not</em> rotated, i.e. they are the same for both portrait and
* landscape. For example, a printer may not be able to print in a stripe
* on both left and right sides of the page.
* </strong>
* </p>
*
* @param The margins.
*
* @hide
*/
public void setMinMargins(Margins margins) {
mMinMargins = margins;
}
/**
* Gets the color mode.
*
* @return The color mode or zero if not set.
*
* @see #COLOR_MODE_COLOR
* @see #COLOR_MODE_MONOCHROME
*/
public int getColorMode() {
return mColorMode;
}
/**
* Sets the color mode.
*
* @param The color mode.
*
* @see #COLOR_MODE_MONOCHROME
* @see #COLOR_MODE_COLOR
*
* @hide
*/
public void setColorMode(int colorMode) {
enforceValidColorMode(colorMode);
mColorMode = colorMode;
}
/**
* Gets whether this print attributes are in portrait orientation,
* which is the media size is in portrait and all orientation dependent
* attributes such as resolution and margins are properly adjusted.
*
* @return Whether this print attributes are in portrait.
*
* @hide
*/
public boolean isPortrait() {
return mMediaSize.isPortrait();
}
/**
* Gets a new print attributes instance which is in portrait orientation,
* which is the media size is in portrait and all orientation dependent
* attributes such as resolution and margins are properly adjusted.
*
* @return New instance in portrait orientation if this one is in
* landscape, otherwise this instance.
*
* @hide
*/
public PrintAttributes asPortrait() {
if (isPortrait()) {
return this;
}
PrintAttributes attributes = new PrintAttributes();
// Rotate the media size.
attributes.setMediaSize(getMediaSize().asPortrait());
// Rotate the resolution.
Resolution oldResolution = getResolution();
Resolution newResolution = new Resolution(
oldResolution.getId(),
oldResolution.getLabel(),
oldResolution.getVerticalDpi(),
oldResolution.getHorizontalDpi());
attributes.setResolution(newResolution);
// Do not rotate the physical margins.
attributes.setMinMargins(getMinMargins());
attributes.setColorMode(getColorMode());
return attributes;
}
/**
* Gets a new print attributes instance which is in landscape orientation,
* which is the media size is in landscape and all orientation dependent
* attributes such as resolution and margins are properly adjusted.
*
* @return New instance in landscape orientation if this one is in
* portrait, otherwise this instance.
*
* @hide
*/
public PrintAttributes asLandscape() {
if (!isPortrait()) {
return this;
}
PrintAttributes attributes = new PrintAttributes();
// Rotate the media size.
attributes.setMediaSize(getMediaSize().asLandscape());
// Rotate the resolution.
Resolution oldResolution = getResolution();
Resolution newResolution = new Resolution(
oldResolution.getId(),
oldResolution.getLabel(),
oldResolution.getVerticalDpi(),
oldResolution.getHorizontalDpi());
attributes.setResolution(newResolution);
// Do not rotate the physical margins.
attributes.setMinMargins(getMinMargins());
attributes.setColorMode(getColorMode());
return attributes;
}
@Override
public void writeToParcel(Parcel parcel, int flags) {
if (mMediaSize != null) {
parcel.writeInt(1);
mMediaSize.writeToParcel(parcel);
} else {
parcel.writeInt(0);
}
if (mResolution != null) {
parcel.writeInt(1);
mResolution.writeToParcel(parcel);
} else {
parcel.writeInt(0);
}
if (mMinMargins != null) {
parcel.writeInt(1);
mMinMargins.writeToParcel(parcel);
} else {
parcel.writeInt(0);
}
parcel.writeInt(mColorMode);
}
@Override
public int describeContents() {
return 0;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + mColorMode;
result = prime * result + ((mMinMargins == null) ? 0 : mMinMargins.hashCode());
result = prime * result + ((mMediaSize == null) ? 0 : mMediaSize.hashCode());
result = prime * result + ((mResolution == null) ? 0 : mResolution.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
PrintAttributes other = (PrintAttributes) obj;
if (mColorMode != other.mColorMode) {
return false;
}
if (mMinMargins == null) {
if (other.mMinMargins != null) {
return false;
}
} else if (!mMinMargins.equals(other.mMinMargins)) {
return false;
}
if (mMediaSize == null) {
if (other.mMediaSize != null) {
return false;
}
} else if (!mMediaSize.equals(other.mMediaSize)) {
return false;
}
if (mResolution == null) {
if (other.mResolution != null) {
return false;
}
} else if (!mResolution.equals(other.mResolution)) {
return false;
}
return true;
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("PrintAttributes{");
builder.append("mediaSize: ").append(mMediaSize);
if (mMediaSize != null) {
builder.append(", orientation: ").append(mMediaSize.isPortrait()
? "portrait" : "landscape");
} else {
builder.append(", orientation: ").append("null");
}
builder.append(", resolution: ").append(mResolution);
builder.append(", minMargins: ").append(mMinMargins);
builder.append(", colorMode: ").append(colorModeToString(mColorMode));
builder.append("}");
return builder.toString();
}
/** @hide */
public void clear() {
mMediaSize = null;
mResolution = null;
mMinMargins = null;
mColorMode = 0;
}
/**
* @hide
*/
public void copyFrom(PrintAttributes other) {
mMediaSize = other.mMediaSize;
mResolution = other.mResolution;
mMinMargins = other.mMinMargins;
mColorMode = other.mColorMode;
}
/**
* This class specifies a supported media size. Media size is the
* dimension of the media on which the content is printed. For
* example, the {@link #NA_LETTER} media size designates a page
* with size 8.5" x 11".
*/
public static final class MediaSize {
private static final String LOG_TAG = "MediaSize";
private static final Map<String, MediaSize> sIdToMediaSizeMap =
new ArrayMap<String, MediaSize>();
/**
* Unknown media size in portrait mode.
* <p>
* <strong>Note: </strong>This is for specifying orientation without media
* size. You should not use the dimensions reported by this instance.
* </p>
*/
public static final MediaSize UNKNOWN_PORTRAIT =
new MediaSize("UNKNOWN_PORTRAIT", "android",
R.string.mediasize_unknown_portrait, 1, Integer.MAX_VALUE);
/**
* Unknown media size in landscape mode.
* <p>
* <strong>Note: </strong>This is for specifying orientation without media
* size. You should not use the dimensions reported by this instance.
* </p>
*/
public static final MediaSize UNKNOWN_LANDSCAPE =
new MediaSize("UNKNOWN_LANDSCAPE", "android",
R.string.mediasize_unknown_landscape, Integer.MAX_VALUE, 1);
// ISO sizes
/** ISO A0 media size: 841mm x 1189mm (33.11" x 46.81") */
public static final MediaSize ISO_A0 =
new MediaSize("ISO_A0", "android", R.string.mediasize_iso_a0, 33110, 46810);
/** ISO A1 media size: 594mm x 841mm (23.39" x 33.11") */
public static final MediaSize ISO_A1 =
new MediaSize("ISO_A1", "android", R.string.mediasize_iso_a1, 23390, 33110);
/** ISO A2 media size: 420mm x 594mm (16.54" x 23.39") */
public static final MediaSize ISO_A2 =
new MediaSize("ISO_A2", "android", R.string.mediasize_iso_a2, 16540, 23390);
/** ISO A3 media size: 297mm x 420mm (11.69" x 16.54") */
public static final MediaSize ISO_A3 =
new MediaSize("ISO_A3", "android", R.string.mediasize_iso_a3, 11690, 16540);
/** ISO A4 media size: 210mm x 297mm (8.27" x 11.69") */
public static final MediaSize ISO_A4 =
new MediaSize("ISO_A4", "android", R.string.mediasize_iso_a4, 8270, 11690);
/** ISO A5 media size: 148mm x 210mm (5.83" x 8.27") */
public static final MediaSize ISO_A5 =
new MediaSize("ISO_A5", "android", R.string.mediasize_iso_a5, 5830, 8270);
/** ISO A6 media size: 105mm x 148mm (4.13" x 5.83") */
public static final MediaSize ISO_A6 =
new MediaSize("ISO_A6", "android", R.string.mediasize_iso_a6, 4130, 5830);
/** ISO A7 media size: 74mm x 105mm (2.91" x 4.13") */
public static final MediaSize ISO_A7 =
new MediaSize("ISO_A7", "android", R.string.mediasize_iso_a7, 2910, 4130);
/** ISO A8 media size: 52mm x 74mm (2.05" x 2.91") */
public static final MediaSize ISO_A8 =
new MediaSize("ISO_A8", "android", R.string.mediasize_iso_a8, 2050, 2910);
/** ISO A9 media size: 37mm x 52mm (1.46" x 2.05") */
public static final MediaSize ISO_A9 =
new MediaSize("ISO_A9", "android", R.string.mediasize_iso_a9, 1460, 2050);
/** ISO A10 media size: 26mm x 37mm (1.02" x 1.46") */
public static final MediaSize ISO_A10 =
new MediaSize("ISO_A10", "android", R.string.mediasize_iso_a10, 1020, 1460);
/** ISO B0 media size: 1000mm x 1414mm (39.37" x 55.67") */
public static final MediaSize ISO_B0 =
new MediaSize("ISO_B0", "android", R.string.mediasize_iso_b0, 39370, 55670);
/** ISO B1 media size: 707mm x 1000mm (27.83" x 39.37") */
public static final MediaSize ISO_B1 =
new MediaSize("ISO_B1", "android", R.string.mediasize_iso_b1, 27830, 39370);
/** ISO B2 media size: 500mm x 707mm (19.69" x 27.83") */
public static final MediaSize ISO_B2 =
new MediaSize("ISO_B2", "android", R.string.mediasize_iso_b2, 19690, 27830);
/** ISO B3 media size: 353mm x 500mm (13.90" x 19.69") */
public static final MediaSize ISO_B3 =
new MediaSize("ISO_B3", "android", R.string.mediasize_iso_b3, 13900, 19690);
/** ISO B4 media size: 250mm x 353mm (9.84" x 13.90") */
public static final MediaSize ISO_B4 =
new MediaSize("ISO_B4", "android", R.string.mediasize_iso_b4, 9840, 13900);
/** ISO B5 media size: 176mm x 250mm (6.93" x 9.84") */
public static final MediaSize ISO_B5 =
new MediaSize("ISO_B5", "android", R.string.mediasize_iso_b5, 6930, 9840);
/** ISO B6 media size: 125mm x 176mm (4.92" x 6.93") */
public static final MediaSize ISO_B6 =
new MediaSize("ISO_B6", "android", R.string.mediasize_iso_b6, 4920, 6930);
/** ISO B7 media size: 88mm x 125mm (3.46" x 4.92") */
public static final MediaSize ISO_B7 =
new MediaSize("ISO_B7", "android", R.string.mediasize_iso_b7, 3460, 4920);
/** ISO B8 media size: 62mm x 88mm (2.44" x 3.46") */
public static final MediaSize ISO_B8 =
new MediaSize("ISO_B8", "android", R.string.mediasize_iso_b8, 2440, 3460);
/** ISO B9 media size: 44mm x 62mm (1.73" x 2.44") */
public static final MediaSize ISO_B9 =
new MediaSize("ISO_B9", "android", R.string.mediasize_iso_b9, 1730, 2440);
/** ISO B10 media size: 31mm x 44mm (1.22" x 1.73") */
public static final MediaSize ISO_B10 =
new MediaSize("ISO_B10", "android", R.string.mediasize_iso_b10, 1220, 1730);
/** ISO C0 media size: 917mm x 1297mm (36.10" x 51.06") */
public static final MediaSize ISO_C0 =
new MediaSize("ISO_C0", "android", R.string.mediasize_iso_c0, 36100, 51060);
/** ISO C1 media size: 648mm x 917mm (25.51" x 36.10") */
public static final MediaSize ISO_C1 =
new MediaSize("ISO_C1", "android", R.string.mediasize_iso_c1, 25510, 36100);
/** ISO C2 media size: 458mm x 648mm (18.03" x 25.51") */
public static final MediaSize ISO_C2 =
new MediaSize("ISO_C2", "android", R.string.mediasize_iso_c2, 18030, 25510);
/** ISO C3 media size: 324mm x 458mm (12.76" x 18.03") */
public static final MediaSize ISO_C3 =
new MediaSize("ISO_C3", "android", R.string.mediasize_iso_c3, 12760, 18030);
/** ISO C4 media size: 229mm x 324mm (9.02" x 12.76") */
public static final MediaSize ISO_C4 =
new MediaSize("ISO_C4", "android", R.string.mediasize_iso_c4, 9020, 12760);
/** ISO C5 media size: 162mm x 229mm (6.38" x 9.02") */
public static final MediaSize ISO_C5 =
new MediaSize("ISO_C5", "android", R.string.mediasize_iso_c5, 6380, 9020);
/** ISO C6 media size: 114mm x 162mm (4.49" x 6.38") */
public static final MediaSize ISO_C6 =
new MediaSize("ISO_C6", "android", R.string.mediasize_iso_c6, 4490, 6380);
/** ISO C7 media size: 81mm x 114mm (3.19" x 4.49") */
public static final MediaSize ISO_C7 =
new MediaSize("ISO_C7", "android", R.string.mediasize_iso_c7, 3190, 4490);
/** ISO C8 media size: 57mm x 81mm (2.24" x 3.19") */
public static final MediaSize ISO_C8 =
new MediaSize("ISO_C8", "android", R.string.mediasize_iso_c8, 2240, 3190);
/** ISO C9 media size: 40mm x 57mm (1.57" x 2.24") */
public static final MediaSize ISO_C9 =
new MediaSize("ISO_C9", "android", R.string.mediasize_iso_c9, 1570, 2240);
/** ISO C10 media size: 28mm x 40mm (1.10" x 1.57") */
public static final MediaSize ISO_C10 =
new MediaSize("ISO_C10", "android", R.string.mediasize_iso_c10, 1100, 1570);
// North America
/** North America Letter media size: 8.5" x 11" (279mm x 216mm) */
public static final MediaSize NA_LETTER =
new MediaSize("NA_LETTER", "android", R.string.mediasize_na_letter, 8500, 11000);
/** North America Government-Letter media size: 8.0" x 10.5" (203mm x 267mm) */
public static final MediaSize NA_GOVT_LETTER =
new MediaSize("NA_GOVT_LETTER", "android",
R.string.mediasize_na_gvrnmt_letter, 8000, 10500);
/** North America Legal media size: 8.5" x 14" (216mm x 356mm) */
public static final MediaSize NA_LEGAL =
new MediaSize("NA_LEGAL", "android", R.string.mediasize_na_legal, 8500, 14000);
/** North America Junior Legal media size: 8.0" x 5.0" (203mm à |
