archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-19 02:24:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

8138838: docs cleanup for java.desktop

Browse source 
Docs cleanup for java.desktop

Reviewed-by: serb
This commit is contained in:
Alexander Stepanov 2016-01-11 17:51:54 +03:00
parent aeccbee0e7
commit 73fb68a80d
609 changed files with 19168 additions and 19160 deletions
Download patch file Download diff file Expand all files Collapse all files

126
jdk/src/java.desktop/share/classes/java/awt/JobAttributes.java
View file

@ -72,19 +72,19 @@ public final class JobAttributes implements Cloneable {
};
/**
* The <code>DefaultSelectionType</code> instance to use for
* The {@code DefaultSelectionType} instance to use for
* specifying that all pages of the job should be printed.
*/
public static final DefaultSelectionType ALL =
new DefaultSelectionType(I_ALL);
/**
* The <code>DefaultSelectionType</code> instance to use for
* The {@code DefaultSelectionType} instance to use for
* specifying that a range of pages of the job should be printed.
*/
public static final DefaultSelectionType RANGE =
new DefaultSelectionType(I_RANGE);
/**
* The <code>DefaultSelectionType</code> instance to use for
* The {@code DefaultSelectionType} instance to use for
* specifying that the current selection should be printed.
*/
public static final DefaultSelectionType SELECTION =
@ -108,13 +108,13 @@ public final class JobAttributes implements Cloneable {
};
/**
* The <code>DestinationType</code> instance to use for
* The {@code DestinationType} instance to use for
* specifying print to file.
*/
public static final DestinationType FILE =
new DestinationType(I_FILE);
/**
* The <code>DestinationType</code> instance to use for
* The {@code DestinationType} instance to use for
* specifying print to printer.
*/
public static final DestinationType PRINTER =
@ -139,17 +139,17 @@ public final class JobAttributes implements Cloneable {
};
/**
* The <code>DialogType</code> instance to use for
* The {@code DialogType} instance to use for
* specifying the cross-platform, pure Java print dialog.
*/
public static final DialogType COMMON = new DialogType(I_COMMON);
/**
* The <code>DialogType</code> instance to use for
* The {@code DialogType} instance to use for
* specifying the platform's native print dialog.
*/
public static final DialogType NATIVE = new DialogType(I_NATIVE);
/**
* The <code>DialogType</code> instance to use for
* The {@code DialogType} instance to use for
* specifying no print dialog.
*/
public static final DialogType NONE = new DialogType(I_NONE);
@ -176,7 +176,7 @@ public final class JobAttributes implements Cloneable {
};
/**
* The <code>MultipleDocumentHandlingType</code> instance to use for specifying
* The {@code MultipleDocumentHandlingType} instance to use for specifying
* that the job should be divided into separate, collated copies.
*/
public static final MultipleDocumentHandlingType
@ -184,7 +184,7 @@ public final class JobAttributes implements Cloneable {
new MultipleDocumentHandlingType(
I_SEPARATE_DOCUMENTS_COLLATED_COPIES);
/**
* The <code>MultipleDocumentHandlingType</code> instance to use for specifying
* The {@code MultipleDocumentHandlingType} instance to use for specifying
* that the job should be divided into separate, uncollated copies.
*/
public static final MultipleDocumentHandlingType
@ -212,13 +212,13 @@ public final class JobAttributes implements Cloneable {
};
/**
* The <code>SidesType</code> instance to use for specifying that
* The {@code SidesType} instance to use for specifying that
* consecutive job pages should be printed upon the same side of
* consecutive media sheets.
*/
public static final SidesType ONE_SIDED = new SidesType(I_ONE_SIDED);
/**
* The <code>SidesType</code> instance to use for specifying that
* The {@code SidesType} instance to use for specifying that
* consecutive job pages should be printed upon front and back sides
* of consecutive media sheets, such that the orientation of each pair
* of pages on the medium would be correct for the reader as if for
@ -227,7 +227,7 @@ public final class JobAttributes implements Cloneable {
public static final SidesType TWO_SIDED_LONG_EDGE =
new SidesType(I_TWO_SIDED_LONG_EDGE);
/**
* The <code>SidesType</code> instance to use for specifying that
* The {@code SidesType} instance to use for specifying that
* consecutive job pages should be printed upon front and back sides
* of consecutive media sheets, such that the orientation of each pair
* of pages on the medium would be correct for the reader as if for
@ -258,16 +258,16 @@ public final class JobAttributes implements Cloneable {
private int toPage;
/**
* Constructs a <code>JobAttributes</code> instance with default
* Constructs a {@code JobAttributes} instance with default
* values for every attribute. The dialog defaults to
* <code>DialogType.NATIVE</code>. Min page defaults to
* <code>1</code>. Max page defaults to <code>Integer.MAX_VALUE</code>.
* Destination defaults to <code>DestinationType.PRINTER</code>.
* Selection defaults to <code>DefaultSelectionType.ALL</code>.
* Number of copies defaults to <code>1</code>. Multiple document handling defaults
* to <code>MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES</code>.
* Sides defaults to <code>SidesType.ONE_SIDED</code>. File name defaults
* to <code>null</code>.
* {@code DialogType.NATIVE}. Min page defaults to
* {@code 1}. Max page defaults to {@code Integer.MAX_VALUE}.
* Destination defaults to {@code DestinationType.PRINTER}.
* Selection defaults to {@code DefaultSelectionType.ALL}.
* Number of copies defaults to {@code 1}. Multiple document handling defaults
* to {@code MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES}.
* Sides defaults to {@code SidesType.ONE_SIDED}. File name defaults
* to {@code null}.
*/
public JobAttributes() {
setCopiesToDefault();
@ -281,36 +281,36 @@ public final class JobAttributes implements Cloneable {
}
/**
* Constructs a <code>JobAttributes</code> instance which is a copy
* of the supplied <code>JobAttributes</code>.
* Constructs a {@code JobAttributes} instance which is a copy
* of the supplied {@code JobAttributes}.
*
* @param obj the <code>JobAttributes</code> to copy
* @param obj the {@code JobAttributes} to copy
*/
public JobAttributes(JobAttributes obj) {
set(obj);
}
/**
* Constructs a <code>JobAttributes</code> instance with the
* Constructs a {@code JobAttributes} instance with the
* specified values for every attribute.
*
* @param copies an integer greater than 0
* @param defaultSelection <code>DefaultSelectionType.ALL</code>,
* <code>DefaultSelectionType.RANGE</code>, or
* <code>DefaultSelectionType.SELECTION</code>
* @param destination <code>DestinationType.FILE</code> or
* <code>DestinationType.PRINTER</code>
* @param dialog <code>DialogType.COMMON</code>,
* <code>DialogType.NATIVE</code>, or
* <code>DialogType.NONE</code>
* @param fileName the possibly <code>null</code> file name
* @param defaultSelection {@code DefaultSelectionType.ALL},
* {@code DefaultSelectionType.RANGE}, or
* {@code DefaultSelectionType.SELECTION}
* @param destination {@code DestinationType.FILE} or
* {@code DestinationType.PRINTER}
* @param dialog {@code DialogType.COMMON},
* {@code DialogType.NATIVE}, or
* {@code DialogType.NONE}
* @param fileName the possibly {@code null} file name
* @param maxPage an integer greater than zero and greater than or equal
* to <i>minPage</i>
* @param minPage an integer greater than zero and less than or equal
* to <i>maxPage</i>
* @param multipleDocumentHandling
* <code>MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES</code> or
* <code>MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES</code>
* {@code MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES} or
* {@code MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES}
* @param pageRanges an array of integer arrays of two elements; an array
* is interpreted as a range spanning all pages including and
* between the specified pages; ranges must be in ascending
@ -322,13 +322,13 @@ public final class JobAttributes implements Cloneable {
* new int[] { 15, 19 } }),
* </pre>
* specifies pages 1, 2, 3, 5, 15, 16, 17, 18, and 19. Note that
* (<code>new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }</code>),
* ({@code new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }}),
* is an invalid set of page ranges because the two ranges
* overlap
* @param printer the possibly <code>null</code> printer name
* @param sides <code>SidesType.ONE_SIDED</code>,
* <code>SidesType.TWO_SIDED_LONG_EDGE</code>, or
* <code>SidesType.TWO_SIDED_SHORT_EDGE</code>
* @param printer the possibly {@code null} printer name
* @param sides {@code SidesType.ONE_SIDED},
* {@code SidesType.TWO_SIDED_LONG_EDGE}, or
* {@code SidesType.TWO_SIDED_SHORT_EDGE}
* @throws IllegalArgumentException if one or more of the above
* conditions is violated
*/
@ -351,10 +351,10 @@ public final class JobAttributes implements Cloneable {
}
/**
* Creates and returns a copy of this <code>JobAttributes</code>.
* Creates and returns a copy of this {@code JobAttributes}.
*
* @return the newly created copy; it is safe to cast this Object into
* a <code>JobAttributes</code>
* a {@code JobAttributes}
*/
public Object clone() {
try {
@ -366,10 +366,10 @@ public final class JobAttributes implements Cloneable {
}
/**
* Sets all of the attributes of this <code>JobAttributes</code> to
* Sets all of the attributes of this {@code JobAttributes} to
* the same values as the attributes of obj.
*
* @param obj the <code>JobAttributes</code> to copy
* @param obj the {@code JobAttributes} to copy
*/
public void set(JobAttributes obj) {
copies = obj.copies;
@ -404,10 +404,10 @@ public final class JobAttributes implements Cloneable {
/**
* Specifies the number of copies the application should render for jobs
* using these attributes. Not specifying this attribute is equivalent to
* specifying <code>1</code>.
* specifying {@code 1}.
*
* @param copies an integer greater than 0
* @throws IllegalArgumentException if <code>copies</code> is less than
* @throws IllegalArgumentException if {@code copies} is less than
* or equal to 0
*/
public void setCopies(int copies) {
@ -429,7 +429,7 @@ public final class JobAttributes implements Cloneable {
/**
* Specifies whether, for jobs using these attributes, the application
* should print all pages, the range specified by the return value of
* <code>getPageRanges</code>, or the current selection. This attribute
* {@code getPageRanges}, or the current selection. This attribute
* is updated to the value chosen by the user.
*
* @return DefaultSelectionType.ALL, DefaultSelectionType.RANGE, or
@ -442,12 +442,12 @@ public final class JobAttributes implements Cloneable {
/**
* Specifies whether, for jobs using these attributes, the application
* should print all pages, the range specified by the return value of
* <code>getPageRanges</code>, or the current selection. Not specifying
* {@code getPageRanges}, or the current selection. Not specifying
* this attribute is equivalent to specifying DefaultSelectionType.ALL.
*
* @param defaultSelection DefaultSelectionType.ALL,
* DefaultSelectionType.RANGE, or DefaultSelectionType.SELECTION.
* @throws IllegalArgumentException if defaultSelection is <code>null</code>
* @throws IllegalArgumentException if defaultSelection is {@code null}
*/
public void setDefaultSelection(DefaultSelectionType defaultSelection) {
if (defaultSelection == null) {
@ -495,8 +495,8 @@ public final class JobAttributes implements Cloneable {
* This attribute cannot be modified by, and is not subject to any
* limitations of, the implementation or the target printer.
*
* @return <code>DialogType.COMMON</code>, <code>DialogType.NATIVE</code>, or
* <code>DialogType.NONE</code>
* @return {@code DialogType.COMMON}, {@code DialogType.NATIVE}, or
* {@code DialogType.NONE}
*/
public DialogType getDialog() {
return dialog;
@ -529,7 +529,7 @@ public final class JobAttributes implements Cloneable {
* Specifies the file name for the output file for jobs using these
* attributes. This attribute is updated to the value chosen by the user.
*
* @return the possibly <code>null</code> file name
* @return the possibly {@code null} file name
*/
public String getFileName() {
return fileName;
@ -549,9 +549,9 @@ public final class JobAttributes implements Cloneable {
* Returns, for jobs using these attributes, the first page to be
* printed, if a range of pages is to be printed. This attribute is
* updated to the value chosen by the user. An application should ignore
* this attribute on output, unless the return value of the <code>
* getDefaultSelection</code> method is DefaultSelectionType.RANGE. An
* application should honor the return value of <code>getPageRanges</code>
* this attribute on output, unless the return value of the
* {@code getDefaultSelection} method is DefaultSelectionType.RANGE. An
* application should honor the return value of {@code getPageRanges}
* over the return value of this method, if possible.
*
* @return an integer greater than zero and less than or equal to
@ -612,7 +612,7 @@ public final class JobAttributes implements Cloneable {
/**
* Specifies the maximum value the user can specify as the last page to
* be printed for jobs using these attributes. Not specifying this
* attribute is equivalent to specifying <code>Integer.MAX_VALUE</code>.
* attribute is equivalent to specifying {@code Integer.MAX_VALUE}.
*
* @param maxPage an integer greater than zero and greater than or equal
* to <i>minPage</i>
@ -643,7 +643,7 @@ public final class JobAttributes implements Cloneable {
/**
* Specifies the minimum value the user can specify as the first page to
* be printed for jobs using these attributes. Not specifying this
* attribute is equivalent to specifying <code>1</code>.
* attribute is equivalent to specifying {@code 1}.
*
* @param minPage an integer greater than zero and less than or equal
* to <i>maxPage</i>.
@ -706,7 +706,7 @@ public final class JobAttributes implements Cloneable {
* printed, if a range of pages is to be printed. All range numbers are
* inclusive. This attribute is updated to the value chosen by the user.
* An application should ignore this attribute on output, unless the
* return value of the <code>getDefaultSelection</code> method is
* return value of the {@code getDefaultSelection} method is
* DefaultSelectionType.RANGE.
*
* @return an array of integer arrays of 2 elements. An array
@ -888,9 +888,9 @@ public final class JobAttributes implements Cloneable {
* Returns, for jobs using these attributes, the last page (inclusive)
* to be printed, if a range of pages is to be printed. This attribute is
* updated to the value chosen by the user. An application should ignore
* this attribute on output, unless the return value of the <code>
* getDefaultSelection</code> method is DefaultSelectionType.RANGE. An
* application should honor the return value of <code>getPageRanges</code>
* this attribute on output, unless the return value of the
* {@code getDefaultSelection} method is DefaultSelectionType.RANGE. An
* application should honor the return value of {@code getPageRanges}
* over the return value of this method, if possible.
*
* @return an integer greater than zero and greater than or equal