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

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

34
jdk/src/java.desktop/macosx/classes/com/apple/eawt/Application.java
View file

@ -39,7 +39,7 @@ import sun.lwawt.LWWindowPeer;
import sun.lwawt.macosx.CPlatformWindow;
/**
* The <code>Application</code> class allows you to integrate your Java application with the native Mac OS X environment.
* The {@code Application} class allows you to integrate your Java application with the native Mac OS X environment.
* You can provide your Mac OS X users a greatly enhanced experience by implementing a few basic handlers for standard system events.
*
* For example:
@ -142,7 +142,7 @@ public class Application {
/**
* Installs a handler to show a custom About window for your application.
*
* Setting the {@link AboutHandler} to <code>null</code> reverts it to the default Cocoa About window.
* Setting the {@link AboutHandler} to {@code null} reverts it to the default Cocoa About window.
*
* @param aboutHandler the handler to respond to the {@link AboutHandler#handleAbout()} message
* @since Java for Mac OS X 10.6 Update 3
@ -155,7 +155,7 @@ public class Application {
/**
* Installs a handler to create the Preferences menu item in your application's app menu.
*
* Setting the {@link PreferencesHandler} to <code>null</code> will remove the Preferences item from the app menu.
* Setting the {@link PreferencesHandler} to {@code null} will remove the Preferences item from the app menu.
*
* @param preferencesHandler
* @since Java for Mac OS X 10.6 Update 3
@ -167,8 +167,8 @@ public class Application {
/**
* Installs the handler which is notified when the application is asked to open a list of files.
* The {@link OpenFilesHandler#openFiles(AppEvent.OpenFilesEvent)} notifications are only sent if the Java app is a bundled application, with a <code>CFBundleDocumentTypes</code> array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a <code>CFBundleDocumentTypes</code> key to your app's Info.plist.
* The {@link OpenFilesHandler#openFiles(AppEvent.OpenFilesEvent)} notifications are only sent if the Java app is a bundled application, with a {@code CFBundleDocumentTypes} array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a {@code CFBundleDocumentTypes} key to your app's Info.plist.
*
* @param openFileHandler
* @since Java for Mac OS X 10.6 Update 3
@ -180,8 +180,8 @@ public class Application {
/**
* Installs the handler which is notified when the application is asked to print a list of files.
* The {@link PrintFilesHandler#printFiles(AppEvent.PrintFilesEvent)} notifications are only sent if the Java app is a bundled application, with a <code>CFBundleDocumentTypes</code> array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a <code>CFBundleDocumentTypes</code> key to your app's Info.plist.
* The {@link PrintFilesHandler#printFiles(AppEvent.PrintFilesEvent)} notifications are only sent if the Java app is a bundled application, with a {@code CFBundleDocumentTypes} array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a {@code CFBundleDocumentTypes} key to your app's Info.plist.
*
* @param printFileHandler
* @since Java for Mac OS X 10.6 Update 3
@ -193,10 +193,10 @@ public class Application {
/**
* Installs the handler which is notified when the application is asked to open a URL.
* The {@link OpenURIHandler#openURI(AppEvent.OpenURIEvent)} notifications are only sent if the Java app is a bundled application, with a <code>CFBundleURLTypes</code> array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a <code>CFBundleURLTypes</code> key to your app's Info.plist.
* The {@link OpenURIHandler#openURI(AppEvent.OpenURIEvent)} notifications are only sent if the Java app is a bundled application, with a {@code CFBundleURLTypes} array present in it's Info.plist.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a {@code CFBundleURLTypes} key to your app's Info.plist.
*
* Setting the handler to <code>null</code> causes all {@link OpenURIHandler#openURI(AppEvent.OpenURIEvent)} requests to be enqueued until another handler is set.
* Setting the handler to {@code null} causes all {@link OpenURIHandler#openURI(AppEvent.OpenURIEvent)} requests to be enqueued until another handler is set.
*
* @param openURIHandler
* @since Java for Mac OS X 10.6 Update 3
@ -209,7 +209,7 @@ public class Application {
/**
* Installs the handler which determines if the application should quit.
* The handler is passed a one-shot {@link QuitResponse} which can cancel or proceed with the quit.
* Setting the handler to <code>null</code> causes all quit requests to directly perform the default {@link QuitStrategy}.
* Setting the handler to {@code null} causes all quit requests to directly perform the default {@link QuitStrategy}.
*
* @param quitHandler the handler that is called when the application is asked to quit
* @since Java for Mac OS X 10.6 Update 3
@ -432,11 +432,11 @@ public class Application {
/**
* Enables the Preferences item in the application menu. The ApplicationListener receives a callback for
* selection of the Preferences item in the application menu only if this is set to <code>true</code>.
* selection of the Preferences item in the application menu only if this is set to {@code true}.
*
* If a Preferences item isn't present, this method adds and enables it.
*
* @param enable specifies whether the Preferences item in the application menu should be enabled (<code>true</code>) or not (<code>false</code>)
* @param enable specifies whether the Preferences item in the application menu should be enabled ({@code true}) or not ({@code false})
*
* @deprecated no replacement
* @since 1.4
@ -449,12 +449,12 @@ public class Application {
/**
* Enables the About item in the application menu. The ApplicationListener receives a callback for
* selection of the About item in the application menu only if this is set to <code>true</code>. Because AWT supplies
* a standard About window when an application may not, by default this is set to <code>true</code>.
* selection of the About item in the application menu only if this is set to {@code true}. Because AWT supplies
* a standard About window when an application may not, by default this is set to {@code true}.
*
* If the About item isn't present, this method adds and enables it.
*
* @param enable specifies whether the About item in the application menu should be enabled (<code>true</code>) or not (<code>false</code>)
* @param enable specifies whether the About item in the application menu should be enabled ({@code true}) or not ({@code false})
*
* @deprecated no replacement
* @since 1.4
@ -553,7 +553,7 @@ public class Application {
}
/**
* @deprecated Use <code>java.awt.MouseInfo.getPointerInfo().getLocation()</code>.
* @deprecated Use {@code java.awt.MouseInfo.getPointerInfo().getLocation()}.
*
* @since 1.4
*/

2
jdk/src/java.desktop/macosx/classes/com/apple/eawt/ApplicationAdapter.java
View file

@ -26,7 +26,7 @@
package com.apple.eawt;
/**
* An abstract adapter class for receiving <code>ApplicationEvents</code>.
* An abstract adapter class for receiving {@code ApplicationEvents}.
*
* ApplicationEvents are deprecated. Use individual app event listeners or handlers instead.
*

12
jdk/src/java.desktop/macosx/classes/com/apple/eawt/ApplicationEvent.java
View file

@ -50,9 +50,9 @@ public class ApplicationEvent extends EventObject {
/**
* Determines whether an ApplicationListener has acted on a particular event.
* An event is marked as having been handled with <code>setHandled(true)</code>.
* An event is marked as having been handled with {@code setHandled(true)}.
*
* @return <code>true</code> if the event has been handled, otherwise <code>false</code>
* @return {@code true} if the event has been handled, otherwise {@code false}
*
* @since 1.4
* @deprecated
@ -65,10 +65,10 @@ public class ApplicationEvent extends EventObject {
/**
* Marks the event as handled.
* After this method handles an ApplicationEvent, it may be useful to specify that it has been handled.
* This is usually used in conjunction with <code>getHandled()</code>.
* Set to <code>true</code> to designate that this event has been handled. By default it is <code>false</code>.
* This is usually used in conjunction with {@code getHandled()}.
* Set to {@code true} to designate that this event has been handled. By default it is {@code false}.
*
* @param state <code>true</code> if the event has been handled, otherwise <code>false</code>.
* @param state {@code true} if the event has been handled, otherwise {@code false}.
*
* @since 1.4
* @deprecated
@ -84,7 +84,7 @@ public class ApplicationEvent extends EventObject {
* For example, the Print and Open events refer to specific files.
* For these cases, this returns the appropriate file name.
*
* @return the full path to the file associated with the event, if applicable, otherwise <code>null</code>
* @return the full path to the file associated with the event, if applicable, otherwise {@code null}
*
* @since 1.4
* @deprecated use {@link OpenFilesHandler} or {@link PrintFilesHandler} instead

12
jdk/src/java.desktop/macosx/classes/com/apple/eawt/ApplicationListener.java
View file

@ -53,9 +53,9 @@ import java.util.EventListener;
@Deprecated
public interface ApplicationListener extends EventListener {
/**
* Called when the user selects the About item in the application menu. If <code>event</code> is not handled by
* setting <code>isHandled(true)</code>, a default About window consisting of the application's name and icon is
* displayed. To display a custom About window, designate the <code>event</code> as being handled and display the
* Called when the user selects the About item in the application menu. If {@code event} is not handled by
* setting {@code isHandled(true)}, a default About window consisting of the application's name and icon is
* displayed. To display a custom About window, designate the {@code event} as being handled and display the
* appropriate About window.
*
* @param event an ApplicationEvent initiated by the user choosing About in the application menu
@ -99,7 +99,7 @@ public interface ApplicationListener extends EventListener {
* Called when the Preference item in the application menu is selected. Native Mac OS X applications make their
* Preferences window available through the application menu. Java applications are automatically given an application
* menu in Mac OS X. By default, the Preferences item is disabled in that menu. If you are deploying an application
* on Mac OS X, you should enable the preferences item with <code>setEnabledPreferencesMenu(true)</code> in the
* on Mac OS X, you should enable the preferences item with {@code setEnabledPreferencesMenu(true)} in the
* Application object and then display your Preferences window in this handler.
*
* @param event triggered when the user selects Preferences from the application menu
@ -130,8 +130,8 @@ public interface ApplicationListener extends EventListener {
* application menu, when the user types Command-Q, or when the user control clicks on your application icon in the
* Dock and chooses Quit. You can either accept or reject the request to quit. You might want to reject the request
* to quit if the user has unsaved work. Reject the request, move into your code to save changes, then quit your
* application. To accept the request to quit, and terminate the application, set <code>isHandled(true)</code> for the
* <code>event</code>. To reject the quit, set <code>isHandled(false)</code>.
* application. To accept the request to quit, and terminate the application, set {@code isHandled(true)} for the
* {@code event}. To reject the quit, set {@code isHandled(false)}.
*
* @param event a Quit Application event
* @deprecated use {@link QuitHandler} and {@link QuitResponse}

4
jdk/src/java.desktop/macosx/classes/com/apple/eawt/OpenURIHandler.java
View file

@ -29,8 +29,8 @@ import com.apple.eawt.AppEvent.OpenURIEvent;
/**
* An implementor is notified when the application is asked to open a URI.
* The application only sends {@link com.apple.eawt.EAWTEvent.OpenURIEvent}s when it has been launched as a bundled Mac application, and it's Info.plist claims URL schemes in it's <code>CFBundleURLTypes</code> entry.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a <code>CFBundleURLTypes</code> key to your app's Info.plist.
* The application only sends {@link com.apple.eawt.EAWTEvent.OpenURIEvent}s when it has been launched as a bundled Mac application, and it's Info.plist claims URL schemes in it's {@code CFBundleURLTypes} entry.
* See the <a href="http://developer.apple.com/mac/library/documentation/General/Reference/InfoPlistKeyReference">Info.plist Key Reference</a> for more information about adding a {@code CFBundleURLTypes} key to your app's Info.plist.
*
* @see Application#setOpenURIHandler(OpenURIHandler)
*

2
jdk/src/java.desktop/macosx/classes/com/apple/eawt/QuitStrategy.java
View file

@ -38,7 +38,7 @@ package com.apple.eawt;
*/
public enum QuitStrategy {
/**
* Shuts down the application by calling <code>System.exit(0)</code>. This is the default strategy.
* Shuts down the application by calling {@code System.exit(0)}. This is the default strategy.
*/
SYSTEM_EXIT_0,

60
jdk/src/java.desktop/macosx/classes/com/apple/eio/FileManager.java
View file

@ -32,19 +32,19 @@ import java.io.*;
* attributes. These attributes in turn are dependent on HFS and HFS+ file systems. As such, it is important to recognize
* their limitation when writing code that must function well across multiple platforms.<p>
*
* In addition to file name suffixes, Mac OS X can use Finder attributes like file <code>type</code> and <code>creator</code> codes to
* identify and handle files. These codes are unique 4-byte identifiers. The file <code>type</code> is a string that describes the
* contents of a file. For example, the file type <code>APPL</code> identifies the file as an application and therefore
* executable. A file type of <code>TEXT</code> means that the file contains raw text. Any application that can read raw
* text can open a file of type <code>TEXT</code>. Applications that use proprietary file types might assign their files a proprietary
* file <code>type</code> code.
* In addition to file name suffixes, Mac OS X can use Finder attributes like file {@code type} and {@code creator} codes to
* identify and handle files. These codes are unique 4-byte identifiers. The file {@code type} is a string that describes the
* contents of a file. For example, the file type {@code APPL} identifies the file as an application and therefore
* executable. A file type of {@code TEXT} means that the file contains raw text. Any application that can read raw
* text can open a file of type {@code TEXT}. Applications that use proprietary file types might assign their files a proprietary
* file {@code type} code.
* <p>
* To identify the application that can handle a document, the Finder can look at the <code>creator</code>. For example, if a user
* double-clicks on a document with the <code>ttxt</code> <code>creator</code>, it opens up in Text Edit, the application registered
* with the <code>ttxt</code> <code>creator</code> code. Note that the <code>creator</code>
* To identify the application that can handle a document, the Finder can look at the {@code creator}. For example, if a user
* double-clicks on a document with the {@code ttxt creator}, it opens up in Text Edit, the application registered
* with the {@code ttxt creator} code. Note that the {@code creator}
* code can be set to any application, not necessarily the application that created it. For example, if you
* use an editor to create an HTML document, you might want to assign a browser's <code>creator</code> code for the file rather than
* the HTML editor's <code>creator</code> code. Double-clicking on the document then opens the appropriate browser rather than the
* use an editor to create an HTML document, you might want to assign a browser's {@code creator} code for the file rather than
* the HTML editor's {@code creator} code. Double-clicking on the document then opens the appropriate browser rather than the
*HTML editor.
*<p>
* If you plan to publicly distribute your application, you must register its creator and any proprietary file types with the Apple
@ -126,7 +126,7 @@ public class FileManager {
}
/**
* Sets the file <code>type</code> and <code>creator</code> codes for a file or folder.
* Sets the file {@code type} and {@code creator} codes for a file or folder.
*
* @since 1.4
*/
@ -140,7 +140,7 @@ public class FileManager {
private static native void _setFileTypeAndCreator(String filename, int type, int creator) throws IOException;
/**
* Sets the file <code>type</code> code for a file or folder.
* Sets the file {@code type} code for a file or folder.
*
* @since 1.4
*/
@ -154,7 +154,7 @@ public class FileManager {
private static native void _setFileType(String filename, int type) throws IOException;
/**
* Sets the file <code>creator</code> code for a file or folder.
* Sets the file {@code creator} code for a file or folder.
*
* @since 1.4
*/
@ -168,7 +168,7 @@ public class FileManager {
private static native void _setFileCreator(String filename, int creator) throws IOException;
/**
* Obtains the file <code>type</code> code for a file or folder.
* Obtains the file {@code type} code for a file or folder.
*
* @since 1.4
*/
@ -182,7 +182,7 @@ public class FileManager {
private static native int _getFileType(String filename) throws IOException;
/**
* Obtains the file <code>creator</code> code for a file or folder.
* Obtains the file {@code creator} code for a file or folder.
*
* @since 1.4
*/
@ -200,11 +200,11 @@ public class FileManager {
* Locates a folder of a particular type. Mac OS X recognizes certain specific folders that have distinct purposes.
* For example, the user's desktop or temporary folder. These folders have corresponding codes. Given one of these codes,
* this method returns the path to that particular folder. Certain folders of a given type may appear in more than
* one domain. For example, although there is only one <code>root</code> folder, there are multiple <code>pref</code>
* folders. If this method is called to find the <code>pref</code> folder, it will return the first one it finds,
* the user's preferences folder in <code>~/Library/Preferences</code>. To explicitly locate a folder in a certain
* domain use <code>findFolder(short domain, int folderType)</code> or <code>findFolder(short domain, int folderType,
* boolean createIfNeeded)</code>.
* one domain. For example, although there is only one {@code root} folder, there are multiple {@code pref}
* folders. If this method is called to find the {@code pref} folder, it will return the first one it finds,
* the user's preferences folder in {@code ~/Library/Preferences}. To explicitly locate a folder in a certain
* domain use {@code findFolder(short domain, int folderType)} or
* {@code findFolder(short domain, int folderType, boolean createIfNeeded)}.
*
* @return the path to the folder searched for
*
@ -215,8 +215,8 @@ public class FileManager {
}
/**
* Locates a folder of a particular type, within a given domain. Similar to <code>findFolder(int folderType)</code>
* except that the domain to look in can be specified. Valid values for <code>domain</code>include:
* Locates a folder of a particular type, within a given domain. Similar to {@code findFolder(int folderType)}
* except that the domain to look in can be specified. Valid values for {@code domain} include:
* <dl>
* <dt>user</dt>
* <dd>The User domain contains resources specific to the user who is currently logged in</dd>
@ -239,12 +239,12 @@ public class FileManager {
/**
* Locates a folder of a particular type within a given domain and optionally creating the folder if it does
* not exist. The behavior is similar to <code>findFolder(int folderType)</code> and
* <code>findFolder(short domain, int folderType)</code> except that it can create the folder if it does not already exist.
* not exist. The behavior is similar to {@code findFolder(int folderType)} and
* {@code findFolder(short domain, int folderType)} except that it can create the folder if it does not already exist.
*
* @param createIfNeeded
* set to <code>true</code>, by setting to <code>false</code> the behavior will be the
* same as <code>findFolder(short domain, int folderType, boolean createIfNeeded)</code>
* set to {@code true}, by setting to {@code false} the behavior will be the
* same as {@code findFolder(short domain, int folderType, boolean createIfNeeded)}
* @return the path to the folder searched for
*
* @since 1.4
@ -263,9 +263,9 @@ public class FileManager {
/**
* Opens the path specified by a URL in the appropriate application for that URL. HTTP URL's (<code>http://</code>)
* open in the default browser as set in the Internet pane of System Preferences. File (<code>file://</code>) and
* FTP URL's (<code>ftp://</code>) open in the Finder. Note that opening an FTP URL will prompt the user for where
* Opens the path specified by a URL in the appropriate application for that URL. HTTP URL's ({@code http://})
* open in the default browser as set in the Internet pane of System Preferences. File ({@code file://}) and
* FTP URL's ({@code ftp://}) open in the Finder. Note that opening an FTP URL will prompt the user for where
* they want to save the downloaded file(s).
*
* @param url

4
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaInternalFrameUI.java
View file

@ -295,9 +295,9 @@ public class AquaInternalFrameUI extends BasicInternalFrameUI implements SwingCo
}
/**
* Installs necessary mouse handlers on <code>newPane</code>
* Installs necessary mouse handlers on {@code newPane}
* and adds it to the frame.
* Reverse process for the <code>currentPane</code>.
* Reverse process for the {@code currentPane}.
*/
@Override
protected void replacePane(final JComponent currentPane, final JComponent newPane) {

20
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaLookAndFeel.java
View file

@ -82,9 +82,9 @@ public class AquaLookAndFeel extends BasicLookAndFeel {
}
/**
* Returns true if the <code>LookAndFeel</code> returned
* <code>RootPaneUI</code> instances support providing Window decorations
* in a <code>JRootPane</code>.
* Returns true if the {@code LookAndFeel} returned
* {@code RootPaneUI} instances support providing Window decorations
* in a {@code JRootPane}.
* <p>
* The default implementation returns false, subclasses that support
* Window decorations should override this and return true.
@ -174,20 +174,20 @@ public class AquaLookAndFeel extends BasicLookAndFeel {
}
/**
* Returns an <code>ActionMap</code>.
* Returns an {@code ActionMap}.
* <P>
* This <code>ActionMap</code> contains <code>Actions</code> that
* This {@code ActionMap} contains {@code Actions} that
* embody the ability to render an auditory cue. These auditory
* cues map onto user and system activities that may be useful
* for an end user to know about (such as a dialog box appearing).
* <P>
* At the appropriate time in a <code>JComponent</code> UI's lifecycle,
* At the appropriate time in a {@code JComponent} UI's lifecycle,
* the ComponentUI is responsible for getting the appropriate
* <code>Action</code> out of the <code>ActionMap</code> and passing
* it on to <code>playSound</code>.
* {@code Action} out of the {@code ActionMap} and passing
* it on to {@code playSound}.
* <P>
* The <code>Actions</code> in this <code>ActionMap</code> are
* created by the <code>createAudioAction</code> method.
* The {@code Actions} in this {@code ActionMap} are
* created by the {@code createAudioAction} method.
*
* @return an ActionMap containing Actions
* responsible for rendering auditory cues

2
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaOptionPaneUI.java
View file

@ -47,7 +47,7 @@ public class AquaOptionPaneUI extends BasicOptionPaneUI {
/**
* Creates and returns a Container containin the buttons. The buttons
* are created by calling <code>getButtons</code>.
* are created by calling {@code getButtons}.
*/
protected Container createButtonArea() {
final Container bottom = super.createButtonArea();

2
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaRootPaneUI.java
View file

@ -164,7 +164,7 @@ public class AquaRootPaneUI extends BasicRootPaneUI implements AncestorListener,
/**
* Invoked when a property changes on the root pane. If the event
* indicates the <code>defaultButton</code> has changed, this will
* indicates the {@code defaultButton} has changed, this will
* update the animation.
* If the enabled state changed, it will start or stop the animation
*/

28
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaTabbedPaneCopyFromBasicUI.java
View file

@ -235,9 +235,9 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
}
/**
* Invoked by <code>installUI</code> to create
* Invoked by {@code installUI} to create
* a layout manager object to manage
* the <code>JTabbedPane</code>.
* the {@code JTabbedPane}.
*
* @return a layout manager object
*
@ -536,7 +536,7 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
/**
* Sets the tab the mouse is over by location. This is a cover method
* for <code>setRolloverTab(tabForCoordinate(x, y, false))</code>.
* for {@code setRolloverTab(tabForCoordinate(x, y, false))}.
*/
private void setRolloverTab(final int x, final int y) {
// NOTE:
@ -547,8 +547,8 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
}
/**
* Sets the tab the mouse is currently over to <code>index</code>.
* <code>index</code> will be -1 if the mouse is no longer over any
* Sets the tab the mouse is currently over to {@code index}.
* {@code index} will be -1 if the mouse is no longer over any
* tab. No checking is done to ensure the passed in index identifies a
* valid tab.
*
@ -676,7 +676,7 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
/**
* Returns the amount the baseline is offset by. This is typically
* the same as <code>getTabLabelShiftY</code>.
* the same as {@code getTabLabelShiftY}.
*
* @return amount to offset the baseline by
* @since 1.6
@ -765,10 +765,10 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
/**
* Paints the tabs in the tab area.
* Invoked by paint().
* The graphics parameter must be a valid <code>Graphics</code>
* The graphics parameter must be a valid {@code Graphics}
* object. Tab placement may be either:
* <code>JTabbedPane.TOP</code>, <code>JTabbedPane.BOTTOM</code>,
* <code>JTabbedPane.LEFT</code>, or <code>JTabbedPane.RIGHT</code>.
* {@code JTabbedPane.TOP}, {@code JTabbedPane.BOTTOM},
* {@code JTabbedPane.LEFT}, or {@code JTabbedPane.RIGHT}.
* The selected index must be a valid tabbed pane tab index (0 to
* tab count - 1, inclusive) or -1 if no tab is currently selected.
* The handling of invalid parameters is unspecified.
@ -1406,7 +1406,7 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
* designated Rectangle object (rather than instantiating and returning
* a new Rectangle each time). The tab index parameter must be a valid
* tabbed pane tab index (0 to tab count - 1, inclusive). The destination
* rectangle parameter must be a valid <code>Rectangle</code> instance.
* rectangle parameter must be a valid {@code Rectangle} instance.
* The handling of invalid parameters is unspecified.
*
* @param tabIndex the index of the tab
@ -3717,7 +3717,7 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
/**
* An ActionMap that populates its contents as necessary. The
* contents are populated by invoking the <code>loadActionMap</code>
* contents are populated by invoking the {@code loadActionMap}
* method on the passed in Object.
*
* @version 1.6, 11/17/05
@ -3726,14 +3726,14 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
@SuppressWarnings("serial") // Superclass is not serializable across versions
static class LazyActionMap extends ActionMapUIResource {
/**
* Object to invoke <code>loadActionMap</code> on. This may be
* Object to invoke {@code loadActionMap} on. This may be
* a Class object.
*/
private transient Object _loader;
/**
* Installs an ActionMap that will be populated by invoking the
* <code>loadActionMap</code> method on the specified Class
* {@code loadActionMap} method on the specified Class
* when necessary.
* <p>
* This should be used if the ActionMap can be shared.
@ -3755,7 +3755,7 @@ public class AquaTabbedPaneCopyFromBasicUI extends TabbedPaneUI implements Swing
/**
* Returns an ActionMap that will be populated by invoking the
* <code>loadActionMap</code> method on the specified Class
* {@code loadActionMap} method on the specified Class
* when necessary.
* <p>
* This should be used if the ActionMap can be shared.

4
jdk/src/java.desktop/macosx/classes/com/apple/laf/AquaTreeUI.java
View file

@ -179,8 +179,8 @@ public class AquaTreeUI extends BasicTreeUI {
}
/**
* Paints the expand (toggle) part of a row. The receiver should NOT modify <code>clipBounds</code>, or
* <code>insets</code>.
* Paints the expand (toggle) part of a row. The receiver should NOT modify {@code clipBounds}, or
* {@code insets}.
*/
protected void paintExpandControl(final Graphics g, final Rectangle clipBounds, final Insets insets, final Rectangle bounds, final TreePath path, final int row, final boolean isExpanded, final boolean hasBeenExpanded, final boolean isLeaf) {
final Object value = path.getLastPathComponent();

2
jdk/src/java.desktop/macosx/classes/sun/font/NativeFont.java
View file

@ -41,7 +41,7 @@ public class NativeFont extends PhysicalFont {
/**
* Verifies native font is accessible.
* @throws FontFormatException - if the font can't be located.
* @throws FontFormatException if the font can't be located.
*/
public NativeFont(String platName, boolean isBitmapDelegate)
throws FontFormatException {

10
jdk/src/java.desktop/macosx/classes/sun/java2d/DataBufferNIOInt.java
View file

@ -37,10 +37,10 @@ public final class DataBufferNIOInt extends DataBuffer {
IntBuffer bankdata[];
/**
* Constructs an integer-based <CODE>DataBuffer</CODE> with a single bank
* Constructs an integer-based {@code DataBuffer} with a single bank
* and the specified size.
*
* @param size The size of the <CODE>DataBuffer</CODE>.
* @param size The size of the {@code DataBuffer}.
*/
public DataBufferNIOInt(int size) {
super(TYPE_INT,size);
@ -51,7 +51,7 @@ public final class DataBufferNIOInt extends DataBuffer {
}
/**
* Returns the default (first) IntBuffer in <CODE>DataBuffer</CODE>.
* Returns the default (first) IntBuffer in {@code DataBuffer}.
*
* @return The first IntBuffer.
*/
@ -70,7 +70,7 @@ public final class DataBufferNIOInt extends DataBuffer {
}
/**
* Returns the default (first) int data array in <CODE>DataBuffer</CODE>.
* Returns the default (first) int data array in {@code DataBuffer}.
*
* @return The first integer data array.
*/
@ -137,7 +137,7 @@ public final class DataBufferNIOInt extends DataBuffer {
/**
* Sets the requested data array element in the specified bank
* to the integer value <CODE>i</CODE>.
* to the integer value {@code i}.
* @param bank The bank in which you want to set the data array element.
* @param i The data array element you want to set.
* @param val The integer value to which you want to set the specified data array element.

2
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CDesktopPeer.java
View file

@ -33,7 +33,7 @@ import java.net.URI;
/**
* Concrete implementation of the interface <code>DesktopPeer</code> for MacOS X
* Concrete implementation of the interface {@code DesktopPeer} for MacOS X
*
* @see DesktopPeer
*/

8
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CInputMethod.java
View file

@ -101,7 +101,7 @@ public class CInputMethod extends InputMethodAdapter {
* method.
*
* @param context the input method context for this input method
* @exception NullPointerException if <code>context</code> is null
* @exception NullPointerException if {@code context} is null
*/
public void setInputMethodContext(InputMethodContext context) {
fIMContext = context;
@ -124,7 +124,7 @@ public class CInputMethod extends InputMethodAdapter {
*
* @param lang locale to input
* @return whether the specified locale is supported
* @exception NullPointerException if <code>locale</code> is null
* @exception NullPointerException if {@code locale} is null
*/
public boolean setLocale(Locale lang) {
return setLocale(lang, false);
@ -205,7 +205,7 @@ public class CInputMethod extends InputMethodAdapter {
* are dispatched to the current input method for this component before
* they are dispatched to the component's methods or event listeners.
* The input method decides whether it needs to handle the event. If it
* does, it also calls the event's <code>consume</code> method; this
* does, it also calls the event's {@code consume} method; this
* causes the event to not get dispatched to the component's event
* processing methods or event listeners.
* <p>
@ -216,7 +216,7 @@ public class CInputMethod extends InputMethodAdapter {
* This method is called by {@link java.awt.im.InputContext#dispatchEvent InputContext.dispatchEvent}.
*
* @param event the event being dispatched to the input method
* @exception NullPointerException if <code>event</code> is null
* @exception NullPointerException if {@code event} is null
*/
public void dispatchEvent(final AWTEvent event) {
// No-op for Mac OS X.

26
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterDevice.java
View file

@ -35,8 +35,8 @@ public class CPrinterDevice extends GraphicsDevice {
}
/**
* Returns the type of this <code>GraphicsDevice</code>.
* @return the type of this <code>GraphicsDevice</code>, which can
* Returns the type of this {@code GraphicsDevice}.
* @return the type of this {@code GraphicsDevice}, which can
* either be TYPE_RASTER_SCREEN, TYPE_PRINTER or TYPE_IMAGE_BUFFER.
* @see #TYPE_RASTER_SCREEN
* @see #TYPE_PRINTER
@ -48,30 +48,30 @@ public class CPrinterDevice extends GraphicsDevice {
/**
* Returns the identification string associated with this
* <code>GraphicsDevice</code>.
* @return a <code>String</code> that is the identification
* of this <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
* @return a {@code String} that is the identification
* of this {@code GraphicsDevice}.
*/
public String getIDstring() {
return ("Printer");
}
/**
* Returns all of the <code>GraphicsConfiguration</code>
* objects associated with this <code>GraphicsDevice</code>.
* @return an array of <code>GraphicsConfiguration</code>
* Returns all of the {@code GraphicsConfiguration}
* objects associated with this {@code GraphicsDevice}.
* @return an array of {@code GraphicsConfiguration}
* objects that are associated with this
* <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
*/
public GraphicsConfiguration[] getConfigurations() {
return new GraphicsConfiguration[] { gc };
}
/**
* Returns the default <code>GraphicsConfiguration</code>
* associated with this <code>GraphicsDevice</code>.
* @return the default <code>GraphicsConfiguration</code>
* of this <code>GraphicsDevice</code>.
* Returns the default {@code GraphicsConfiguration}
* associated with this {@code GraphicsDevice}.
* @return the default {@code GraphicsConfiguration}
* of this {@code GraphicsDevice}.
*/
public GraphicsConfiguration getDefaultConfiguration() {
return gc;

98
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterGraphicsConfig.java
View file

@ -49,9 +49,9 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
* Returns the {@link GraphicsDevice} associated with this
* <code>GraphicsConfiguration</code>.
* @return a <code>GraphicsDevice</code> object that is
* associated with this <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return a {@code GraphicsDevice} object that is
* associated with this {@code GraphicsConfiguration}.
*/
public GraphicsDevice getDevice() {
return gd;
@ -59,16 +59,16 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
* Returns a {@link BufferedImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>. This
* compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
* a device. The returned <code>BufferedImage</code> has
* a device. The returned {@code BufferedImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
* @param width the width of the returned <code>BufferedImage</code>
* @param height the height of the returned <code>BufferedImage</code>
* @return a <code>BufferedImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned {@code BufferedImage}
* @param height the height of the returned {@code BufferedImage}
* @return a {@code BufferedImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
*/
public BufferedImage createCompatibleImage(int width, int height) {
return createCompatibleImage(width, height, Transparency.OPAQUE);
@ -76,15 +76,15 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
* Returns a {@link VolatileImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>.
* The returned <code>VolatileImage</code>
* compatible with this {@code GraphicsConfiguration}.
* The returned {@code VolatileImage}
* may have data that is stored optimally for the underlying graphics
* device and may therefore benefit from platform-specific rendering
* acceleration.
* @param width the width of the returned <code>VolatileImage</code>
* @param height the height of the returned <code>VolatileImage</code>
* @return a <code>VolatileImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned {@code VolatileImage}
* @param height the height of the returned {@code VolatileImage}
* @return a {@code VolatileImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
* @see Component#createVolatileImage(int, int)
*/
public VolatileImage createCompatibleVolatileImage(int width, int height) {
@ -97,18 +97,18 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
}
/**
* Returns a <code>BufferedImage</code> that supports the specified
* Returns a {@code BufferedImage} that supports the specified
* transparency and has a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>. This
* compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
* a device. The returned <code>BufferedImage</code> has a layout and
* a device. The returned {@code BufferedImage} has a layout and
* color model that can be optimally blitted to a device
* with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned <code>BufferedImage</code>
* @param height the height of the returned <code>BufferedImage</code>
* with this {@code GraphicsConfiguration}.
* @param width the width of the returned {@code BufferedImage}
* @param height the height of the returned {@code BufferedImage}
* @param transparency the specified transparency mode
* @return a <code>BufferedImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>
* @return a {@code BufferedImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}
* and also supports the specified transparency.
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
@ -121,21 +121,21 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
* Returns the {@link ColorModel} associated with this
* <code>GraphicsConfiguration</code>.
* @return a <code>ColorModel</code> object that is associated with
* this <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return a {@code ColorModel} object that is associated with
* this {@code GraphicsConfiguration}.
*/
public ColorModel getColorModel() {
return getColorModel(Transparency.OPAQUE);
}
/**
* Returns the <code>ColorModel</code> associated with this
* <code>GraphicsConfiguration</code> that supports the specified
* Returns the {@code ColorModel} associated with this
* {@code GraphicsConfiguration} that supports the specified
* transparency.
* @param transparency the specified transparency mode
* @return a <code>ColorModel</code> object that is associated with
* this <code>GraphicsConfiguration</code> and supports the
* @return a {@code ColorModel} object that is associated with
* this {@code GraphicsConfiguration} and supports the
* specified transparency.
*/
public ColorModel getColorModel(int transparency) {
@ -144,22 +144,22 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
* Returns the default {@link AffineTransform} for this
* <code>GraphicsConfiguration</code>. This
* <code>AffineTransform</code> is typically the Identity transform
* for most normal screens. The default <code>AffineTransform</code>
* {@code GraphicsConfiguration}. This
* {@code AffineTransform} is typically the Identity transform
* for most normal screens. The default {@code AffineTransform}
* maps coordinates onto the device such that 72 user space
* coordinate units measure approximately 1 inch in device
* space. The normalizing transform can be used to make
* this mapping more exact. Coordinates in the coordinate space
* defined by the default <code>AffineTransform</code> for screen and
* defined by the default {@code AffineTransform} for screen and
* printer devices have the origin in the upper left-hand corner of
* the target region of the device, with X coordinates
* increasing to the right and Y coordinates increasing downwards.
* For image buffers not associated with a device, such as those not
* created by <code>createCompatibleImage</code>,
* this <code>AffineTransform</code> is the Identity transform.
* @return the default <code>AffineTransform</code> for this
* <code>GraphicsConfiguration</code>.
* created by {@code createCompatibleImage},
* this {@code AffineTransform} is the Identity transform.
* @return the default {@code AffineTransform} for this
* {@code GraphicsConfiguration}.
*/
public AffineTransform getDefaultTransform() {
return new AffineTransform();
@ -167,9 +167,9 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
/**
*
* Returns a <code>AffineTransform</code> that can be concatenated
* with the default <code>AffineTransform</code>
* of a <code>GraphicsConfiguration</code> so that 72 units in user
* Returns a {@code AffineTransform} that can be concatenated
* with the default {@code AffineTransform}
* of a {@code GraphicsConfiguration} so that 72 units in user
* space equals 1 inch in device space.
* <p>
* For a particular {@link Graphics2D}, g, one
@ -181,16 +181,16 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
* g.setTransform(gc.getDefaultTransform());
* g.transform(gc.getNormalizingTransform());
* </pre>
* Note that sometimes this <code>AffineTransform</code> is identity,
* Note that sometimes this {@code AffineTransform} is identity,
* such as for printers or metafile output, and that this
* <code>AffineTransform</code> is only as accurate as the information
* {@code AffineTransform} is only as accurate as the information
* supplied by the underlying system. For image buffers not
* associated with a device, such as those not created by
* <code>createCompatibleImage</code>, this
* <code>AffineTransform</code> is the Identity transform
* {@code createCompatibleImage}, this
* {@code AffineTransform} is the Identity transform
* since there is no valid distance measurement.
* @return an <code>AffineTransform</code> to concatenate to the
* default <code>AffineTransform</code> so that 72 units in user
* @return an {@code AffineTransform} to concatenate to the
* default {@code AffineTransform} so that 72 units in user
* space is mapped to 1 inch in device space.
*/
public AffineTransform getNormalizingTransform() {
@ -198,12 +198,12 @@ public class CPrinterGraphicsConfig extends GraphicsConfiguration {
}
/**
* Returns the bounds of the <code>GraphicsConfiguration</code>
* Returns the bounds of the {@code GraphicsConfiguration}
* in the device coordinates. In a multi-screen environment
* with a virtual device, the bounds can have negative X
* or Y origins.
* @return the bounds of the area covered by this
* <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @since 1.3
*/
public Rectangle getBounds() {

30
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CPrinterJob.java
View file

@ -83,13 +83,13 @@ public final class CPrinterJob extends RasterPrinterJob {
* to these native print services.
* To present the cross platform print dialog for all services,
* including native ones instead use
* <code>printDialog(PrintRequestAttributeSet)</code>.
* {@code printDialog(PrintRequestAttributeSet)}.
* <p>
* PrinterJob implementations which can use PrintService's will update
* the PrintService for this PrinterJob to reflect the new service
* selected by the user.
* @return <code>true</code> if the user does not cancel the dialog;
* <code>false</code> otherwise.
* @return {@code true} if the user does not cancel the dialog;
* {@code false} otherwise.
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
* @see java.awt.GraphicsEnvironment#isHeadless
@ -117,19 +117,19 @@ public final class CPrinterJob extends RasterPrinterJob {
/**
* Displays a dialog that allows modification of a
* <code>PageFormat</code> instance.
* The <code>page</code> argument is used to initialize controls
* {@code PageFormat} instance.
* The {@code page} argument is used to initialize controls
* in the page setup dialog.
* If the user cancels the dialog then this method returns the
* original <code>page</code> object unmodified.
* original {@code page} object unmodified.
* If the user okays the dialog then this method returns a new
* <code>PageFormat</code> object with the indicated changes.
* In either case, the original <code>page</code> object is
* {@code PageFormat} object with the indicated changes.
* In either case, the original {@code page} object is
* not modified.
* @param page the default <code>PageFormat</code> presented to the
* @param page the default {@code PageFormat} presented to the
* user for modification
* @return the original <code>page</code> object if the dialog
* is cancelled; a new <code>PageFormat</code> object
* @return the original {@code page} object if the dialog
* is cancelled; a new {@code PageFormat} object
* containing the format indicated by the user if the
* dialog is acknowledged.
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
@ -157,11 +157,11 @@ public final class CPrinterJob extends RasterPrinterJob {
}
/**
* Clones the <code>PageFormat</code> argument and alters the
* Clones the {@code PageFormat} argument and alters the
* clone to describe a default page size and orientation.
* @param page the <code>PageFormat</code> to be cloned and altered
* @return clone of <code>page</code>, altered to describe a default
* <code>PageFormat</code>.
* @param page the {@code PageFormat} to be cloned and altered
* @return clone of {@code page}, altered to describe a default
* {@code PageFormat}.
*/
@Override
public PageFormat defaultPage(PageFormat page) {

12
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/CRobot.java
View file

@ -73,7 +73,7 @@ class CRobot implements RobotPeer {
* Presses one or more mouse buttons.
*
* @param buttons the button mask (combination of
* <code>InputEvent.BUTTON1/2/3_MASK</code>)
* {@code InputEvent.BUTTON1/2/3_MASK})
*/
@Override
public void mousePress(int buttons) {
@ -87,7 +87,7 @@ class CRobot implements RobotPeer {
* Releases one or more mouse buttons.
*
* @param buttons the button mask (combination of
* <code>InputEvent.BUTTON1/2/3_MASK</code>)
* {@code InputEvent.BUTTON1/2/3_MASK})
*/
@Override
public void mouseRelease(int buttons) {
@ -133,14 +133,14 @@ class CRobot implements RobotPeer {
* Presses a given key.
* <p>
* Key codes that have more than one physical key associated with them
* (e.g. <code>KeyEvent.VK_SHIFT</code> could mean either the
* (e.g. {@code KeyEvent.VK_SHIFT} could mean either the
* left or right shift key) will map to the left key.
* <p>
* Assumes that the
* peer implementations will throw an exception for other bogus
* values e.g. -1, 999999
*
* @param keycode the key to press (e.g. <code>KeyEvent.VK_A</code>)
* @param keycode the key to press (e.g. {@code KeyEvent.VK_A})
*/
@Override
public void keyPress(final int keycode) {
@ -151,14 +151,14 @@ class CRobot implements RobotPeer {
* Releases a given key.
* <p>
* Key codes that have more than one physical key associated with them
* (e.g. <code>KeyEvent.VK_SHIFT</code> could mean either the
* (e.g. {@code KeyEvent.VK_SHIFT} could mean either the
* left or right shift key) will map to the left key.
* <p>
* Assumes that the
* peer implementations will throw an exception for other bogus
* values e.g. -1, 999999
*
* @param keycode the key to release (e.g. <code>KeyEvent.VK_A</code>)
* @param keycode the key to release (e.g. {@code KeyEvent.VK_A})
*/
@Override
public void keyRelease(final int keycode) {

8
jdk/src/java.desktop/macosx/classes/sun/lwawt/macosx/LWCToolkit.java
View file

@ -515,13 +515,13 @@ public final class LWCToolkit extends LWToolkit {
* key for menu shortcuts.
* <p>
* Menu shortcuts, which are embodied in the
* <code>MenuShortcut</code> class, are handled by the
* <code>MenuBar</code> class.
* {@code MenuShortcut} class, are handled by the
* {@code MenuBar} class.
* <p>
* By default, this method returns <code>Event.CTRL_MASK</code>.
* By default, this method returns {@code Event.CTRL_MASK}.
* Toolkit implementations should override this method if the
* <b>Control</b> key isn't the correct key for accelerators.
* @return the modifier mask on the <code>Event</code> class
* @return the modifier mask on the {@code Event} class
* that is used for menu shortcuts on this toolkit.
* @see java.awt.MenuBar
* @see java.awt.MenuShortcut

10
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/bmp/BMPImageReader.java
View file

@ -74,7 +74,7 @@ import com.sun.imageio.plugins.common.I18N;
/** This class is the Java Image IO plugin reader for BMP images.
* It may subsample the image, clip the image, select sub-bands,
* and shift the decoded image origin if the proper decoding parameter
* are set in the provided <code>ImageReadParam</code>.
* are set in the provided {@code ImageReadParam}.
*
* This class supports Microsoft Windows Bitmap Version 3-5,
* as well as OS/2 Bitmap Version 2.x (for single-image BMP file).
@ -159,8 +159,8 @@ public class BMPImageReader extends ImageReader implements BMPConstants {
/** source and destination bands. */
private int[] sourceBands, destBands;
/** Constructs <code>BMPImageReader</code> from the provided
* <code>ImageReaderSpi</code>.
/** Constructs {@code BMPImageReader} from the provided
* {@code ImageReaderSpi}.
*/
public BMPImageReader(ImageReaderSpi originator) {
super(originator);
@ -1681,8 +1681,8 @@ public class BMPImageReader extends ImageReader implements BMPConstants {
/** Decodes the jpeg/png image embedded in the bitmap using any jpeg
* ImageIO-style plugin.
*
* @param bi The destination <code>BufferedImage</code>.
* @param bmpParam The <code>ImageReadParam</code> for decoding this
* @param bi The destination {@code BufferedImage}.
* @param bmpParam The {@code ImageReadParam} for decoding this
* BMP image. The parameters for subregion, band selection and
* subsampling are used in decoding the jpeg image.
*/

6
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/bmp/BMPImageWriter.java
View file

@ -69,7 +69,7 @@ import com.sun.imageio.plugins.common.I18N;
* a BMP format.
*
* The encoding process may clip, subsample using the parameters
* specified in the <code>ImageWriteParam</code>.
* specified in the {@code ImageWriteParam}.
*
* @see javax.imageio.plugins.bmp.BMPImageWriteParam
*/
@ -88,8 +88,8 @@ public class BMPImageWriter extends ImageWriter implements BMPConstants {
private short[] spixels;
private int[] ipixels;
/** Constructs <code>BMPImageWriter</code> based on the provided
* <code>ImageWriterSpi</code>.
/** Constructs {@code BMPImageWriter} based on the provided
* {@code ImageWriterSpi}.
*/
public BMPImageWriter(ImageWriterSpi originator) {
super(originator);

12
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/BogusColorSpace.java
View file

@ -28,7 +28,7 @@ package com.sun.imageio.plugins.common;
import java.awt.color.ColorSpace;
/**
* A dummy <code>ColorSpace</code> to enable <code>ColorModel</code>
* A dummy {@code ColorSpace} to enable {@code ColorModel}
* for image data which do not have an innate color representation.
*/
@SuppressWarnings("serial") // JDK-implementation class
@ -37,8 +37,8 @@ public class BogusColorSpace extends ColorSpace {
* Return the type given the number of components.
*
* @param numComponents The number of components in the
* <code>ColorSpace</code>.
* @exception IllegalArgumentException if <code>numComponents</code>
* {@code ColorSpace}.
* @exception IllegalArgumentException if {@code numComponents}
* is less than 1.
*/
private static int getType(int numComponents) {
@ -62,11 +62,11 @@ public class BogusColorSpace extends ColorSpace {
}
/**
* Constructs a bogus <code>ColorSpace</code>.
* Constructs a bogus {@code ColorSpace}.
*
* @param numComponents The number of components in the
* <code>ColorSpace</code>.
* @exception IllegalArgumentException if <code>numComponents</code>
* {@code ColorSpace}.
* @exception IllegalArgumentException if {@code numComponents}
* is less than 1.
*/
public BogusColorSpace(int numComponents) {

4
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/I18NImpl.java
View file

@ -37,9 +37,9 @@ import java.net.URL;
* the file from the jar as the package name is included automatically.
*
* <p>Extenders need only provide a static method
* <code>getString(String)</code> which calls the static method in this
* {@code getString(String)} which calls the static method in this
* class with the name of the invoking class and returns a
* <code>String</code>.
* {@code String}.
*/
public class I18NImpl {
/**

110
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/ImageUtil.java
View file

@ -58,35 +58,35 @@ import javax.imageio.spi.ImageWriterSpi;
public class ImageUtil {
/**
* Creates a <code>ColorModel</code> that may be used with the
* specified <code>SampleModel</code>. If a suitable
* <code>ColorModel</code> cannot be found, this method returns
* <code>null</code>.
* Creates a {@code ColorModel} that may be used with the
* specified {@code SampleModel}. If a suitable
* {@code ColorModel} cannot be found, this method returns
* {@code null}.
*
* <p> Suitable <code>ColorModel</code>s are guaranteed to exist
* for all instances of <code>ComponentSampleModel</code>.
* For 1- and 3- banded <code>SampleModel</code>s, the returned
* <code>ColorModel</code> will be opaque. For 2- and 4-banded
* <code>SampleModel</code>s, the output will use alpha transparency
* <p> Suitable {@code ColorModel}s are guaranteed to exist
* for all instances of {@code ComponentSampleModel}.
* For 1- and 3- banded {@code SampleModel}s, the returned
* {@code ColorModel} will be opaque. For 2- and 4-banded
* {@code SampleModel}s, the output will use alpha transparency
* which is not premultiplied. 1- and 2-banded data will use a
* grayscale <code>ColorSpace</code>, and 3- and 4-banded data a sRGB
* <code>ColorSpace</code>. Data with 5 or more bands will have a
* <code>BogusColorSpace</code>.</p>
* grayscale {@code ColorSpace}, and 3- and 4-banded data a sRGB
* {@code ColorSpace}. Data with 5 or more bands will have a
* {@code BogusColorSpace}.</p>
*
* <p>An instance of <code>DirectColorModel</code> will be created for
* instances of <code>SinglePixelPackedSampleModel</code> with no more
* <p>An instance of {@code DirectColorModel} will be created for
* instances of {@code SinglePixelPackedSampleModel} with no more
* than 4 bands.</p>
*
* <p>An instance of <code>IndexColorModel</code> will be created for
* instances of <code>MultiPixelPackedSampleModel</code>. The colormap
* will be a grayscale ramp with <code>1&nbsp;<<&nbsp;numberOfBits</code>
* <p>An instance of {@code IndexColorModel} will be created for
* instances of {@code MultiPixelPackedSampleModel}. The colormap
* will be a grayscale ramp with <code>1&nbsp;&lt;&lt;&nbsp;numberOfBits</code>
* entries ranging from zero to at most 255.</p>
*
* @return An instance of <code>ColorModel</code> that is suitable for
* the supplied <code>SampleModel</code>, or <code>null</code>.
* @return An instance of {@code ColorModel} that is suitable for
* the supplied {@code SampleModel}, or {@code null}.
*
* @throws IllegalArgumentException If <code>sampleModel</code> is
* <code>null</code>.
* @throws IllegalArgumentException If {@code sampleModel} is
* {@code null}.
*/
public static final ColorModel createColorModel(SampleModel sampleModel) {
// Check the parameter.
@ -194,19 +194,19 @@ public class ImageUtil {
}
/**
* For the case of binary data (<code>isBinary()</code> returns
* <code>true</code>), return the binary data as a packed byte array.
* For the case of binary data ({@code isBinary()} returns
* {@code true}), return the binary data as a packed byte array.
* The data will be packed as eight bits per byte with no bit offset,
* i.e., the first bit in each image line will be the left-most of the
* first byte of the line. The line stride in bytes will be
* <code>(int)((getWidth()+7)/8)</code>. The length of the returned
* array will be the line stride multiplied by <code>getHeight()</code>
* {@code (int)((getWidth()+7)/8)}. The length of the returned
* array will be the line stride multiplied by {@code getHeight()}
*
* @return the binary data as a packed array of bytes with zero offset
* of <code>null</code> if the data are not binary.
* @throws IllegalArgumentException if <code>isBinary()</code> returns
* <code>false</code> with the <code>SampleModel</code> of the
* supplied <code>Raster</code> as argument.
* of {@code null} if the data are not binary.
* @throws IllegalArgumentException if {@code isBinary()} returns
* {@code false} with the {@code SampleModel} of the
* supplied {@code Raster} as argument.
*/
public static byte[] getPackedBinaryData(Raster raster,
Rectangle rect) {
@ -387,11 +387,11 @@ public class ImageUtil {
/**
* Returns the binary data unpacked into an array of bytes.
* The line stride will be the width of the <code>Raster</code>.
* The line stride will be the width of the {@code Raster}.
*
* @throws IllegalArgumentException if <code>isBinary()</code> returns
* <code>false</code> with the <code>SampleModel</code> of the
* supplied <code>Raster</code> as argument.
* @throws IllegalArgumentException if {@code isBinary()} returns
* {@code false} with the {@code SampleModel} of the
* supplied {@code Raster} as argument.
*/
public static byte[] getUnpackedBinaryData(Raster raster,
Rectangle rect) {
@ -467,13 +467,13 @@ public class ImageUtil {
}
/**
* Sets the supplied <code>Raster</code>'s data from an array
* Sets the supplied {@code Raster}'s data from an array
* of packed binary data of the form returned by
* <code>getPackedBinaryData()</code>.
* {@code getPackedBinaryData()}.
*
* @throws IllegalArgumentException if <code>isBinary()</code> returns
* <code>false</code> with the <code>SampleModel</code> of the
* supplied <code>Raster</code> as argument.
* @throws IllegalArgumentException if {@code isBinary()} returns
* {@code false} with the {@code SampleModel} of the
* supplied {@code Raster} as argument.
*/
public static void setPackedBinaryData(byte[] binaryDataArray,
WritableRaster raster,
@ -713,16 +713,16 @@ public class ImageUtil {
}
/**
* Copies data into the packed array of the <code>Raster</code>
* Copies data into the packed array of the {@code Raster}
* from an array of unpacked data of the form returned by
* <code>getUnpackedBinaryData()</code>.
* {@code getUnpackedBinaryData()}.
*
* <p> If the data are binary, then the target bit will be set if
* and only if the corresponding byte is non-zero.
*
* @throws IllegalArgumentException if <code>isBinary()</code> returns
* <code>false</code> with the <code>SampleModel</code> of the
* supplied <code>Raster</code> as argument.
* @throws IllegalArgumentException if {@code isBinary()} returns
* {@code false} with the {@code SampleModel} of the
* supplied {@code Raster} as argument.
*/
public static void setUnpackedBinaryData(byte[] bdata,
WritableRaster raster,
@ -983,7 +983,7 @@ public class ImageUtil {
* @param g The green channel color indices.
* @param b The blue channel color indices.
* @return If all the indices have 256 entries, and are identical mappings,
* return <code>true</code>; otherwise, return <code>false</code>.
* return {@code true}; otherwise, return {@code false}.
*/
public static boolean isIndicesForGrayscale(byte[] r, byte[] g, byte[] b) {
if (r.length != g.length || r.length != b.length)
@ -1004,7 +1004,7 @@ public class ImageUtil {
return true;
}
/** Converts the provided object to <code>String</code> */
/** Converts the provided object to {@code String} */
public static String convertObjectToString(Object obj) {
if (obj == null)
return "";
@ -1035,10 +1035,10 @@ public class ImageUtil {
}
/** Checks that the provided <code>ImageWriter</code> can encode
* the provided <code>ImageTypeSpecifier</code> or not. If not, an
* <code>IIOException</code> will be thrown.
* @param writer The provided <code>ImageWriter</code>.
/** Checks that the provided {@code ImageWriter} can encode
* the provided {@code ImageTypeSpecifier} or not. If not, an
* {@code IIOException} will be thrown.
* @param writer The provided {@code ImageWriter}.
* @param type The image to be tested.
* @throws IIOException If the writer cannot encoded the provided image.
*/
@ -1053,12 +1053,12 @@ public class ImageUtil {
}
}
/** Checks that the provided <code>ImageWriter</code> can encode
* the provided <code>ColorModel</code> and <code>SampleModel</code>.
* If not, an <code>IIOException</code> will be thrown.
* @param writer The provided <code>ImageWriter</code>.
* @param colorModel The provided <code>ColorModel</code>.
* @param sampleModel The provided <code>SampleModel</code>.
/** Checks that the provided {@code ImageWriter} can encode
* the provided {@code ColorModel} and {@code SampleModel}.
* If not, an {@code IIOException} will be thrown.
* @param writer The provided {@code ImageWriter}.
* @param colorModel The provided {@code ColorModel}.
* @param sampleModel The provided {@code SampleModel}.
* @throws IIOException If the writer cannot encoded the provided image.
*/
public static final void canEncodeImage(ImageWriter writer,

4
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/LZWStringTable.java
View file

@ -31,9 +31,9 @@ import java.io.PrintStream;
* General purpose LZW String Table.
* Extracted from GIFEncoder by Adam Doppelt
* Comments added by Robin Luiten
* <code>expandCode</code> added by Robin Luiten
* {@code expandCode} added by Robin Luiten
* The strLen table to give quick access to the lenght of an expanded
* code for use by the <code>expandCode</code> method added by Robin.
* code for use by the {@code expandCode} method added by Robin.
**/
public class LZWStringTable {
/** codesize + Reserved Codes */

40
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/PaletteBuilder.java
View file

@ -70,19 +70,19 @@ public class PaletteBuilder {
/**
* Creates an image representing given image
* <code>src</code> using <code>IndexColorModel</code>.
* {@code src} using {@code IndexColorModel}.
*
* Lossless conversion is not always possible (e.g. if number
* of colors in the given image exceeds maximum palette size).
* Result image then is an approximation constructed by octree
* quantization method.
*
* @exception IllegalArgumentException if <code>src</code> is
* <code>null</code>.
* @exception IllegalArgumentException if {@code src} is
* {@code null}.
*
* @exception UnsupportedOperationException if implemented method
* is unable to create approximation of <code>src</code>
* and <code>canCreatePalette</code> returns <code>false</code>.
* is unable to create approximation of {@code src}
* and {@code canCreatePalette} returns {@code false}.
*
* @see createIndexColorModel
*
@ -97,15 +97,15 @@ public class PaletteBuilder {
/**
* Creates an palette representing colors from given image
* <code>img</code>. If number of colors in the given image exceeds
* {@code img}. If number of colors in the given image exceeds
* maximum palette size closest colors would be merged.
*
* @exception IllegalArgumentException if <code>img</code> is
* <code>null</code>.
* @exception IllegalArgumentException if {@code img} is
* {@code null}.
*
* @exception UnsupportedOperationException if implemented method
* is unable to create approximation of <code>img</code>
* and <code>canCreatePalette</code> returns <code>false</code>.
* is unable to create approximation of {@code img}
* and {@code canCreatePalette} returns {@code false}.
*
* @see createIndexedImage
*
@ -119,17 +119,17 @@ public class PaletteBuilder {
}
/**
* Returns <code>true</code> if PaletteBuilder is able to create
* Returns {@code true} if PaletteBuilder is able to create
* palette for given image type.
*
* @param type an instance of <code>ImageTypeSpecifier</code> to be
* @param type an instance of {@code ImageTypeSpecifier} to be
* indexed.
*
* @return <code>true</code> if the <code>PaletteBuilder</code>
* @return {@code true} if the {@code PaletteBuilder}
* is likely to be able to create palette for this image type.
*
* @exception IllegalArgumentException if <code>type</code>
* is <code>null</code>.
* @exception IllegalArgumentException if {@code type}
* is {@code null}.
*/
public static boolean canCreatePalette(ImageTypeSpecifier type) {
if (type == null) {
@ -139,17 +139,17 @@ public class PaletteBuilder {
}
/**
* Returns <code>true</code> if PaletteBuilder is able to create
* Returns {@code true} if PaletteBuilder is able to create
* palette for given rendered image.
*
* @param image an instance of <code>RenderedImage</code> to be
* @param image an instance of {@code RenderedImage} to be
* indexed.
*
* @return <code>true</code> if the <code>PaletteBuilder</code>
* @return {@code true} if the {@code PaletteBuilder}
* is likely to be able to create palette for this image type.
*
* @exception IllegalArgumentException if <code>image</code>
* is <code>null</code>.
* @exception IllegalArgumentException if {@code image}
* is {@code null}.
*/
public static boolean canCreatePalette(RenderedImage image) {
if (image == null) {

18
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/common/ReaderUtil.java
View file

@ -134,25 +134,25 @@ public class ReaderUtil {
* pixels that will be written during a particular decoding pass.
* The intent is to simplify the work done by readers in combining
* the source region, source subsampling, and destination offset
* information obtained from the <code>ImageReadParam</code> with
* information obtained from the {@code ImageReadParam} with
* the offsets and periods of a progressive or interlaced decoding
* pass.
*
* @param sourceRegion a <code>Rectangle</code> containing the
* @param sourceRegion a {@code Rectangle} containing the
* source region being read, offset by the source subsampling
* offsets, and clipped against the source bounds, as returned by
* the <code>getSourceRegion</code> method.
* @param destinationOffset a <code>Point</code> containing the
* the {@code getSourceRegion} method.
* @param destinationOffset a {@code Point} containing the
* coordinates of the upper-left pixel to be written in the
* destination.
* @param dstMinX the smallest X coordinate (inclusive) of the
* destination <code>Raster</code>.
* destination {@code Raster}.
* @param dstMinY the smallest Y coordinate (inclusive) of the
* destination <code>Raster</code>.
* destination {@code Raster}.
* @param dstMaxX the largest X coordinate (inclusive) of the destination
* <code>Raster</code>.
* {@code Raster}.
* @param dstMaxY the largest Y coordinate (inclusive) of the destination
* <code>Raster</code>.
* {@code Raster}.
* @param sourceXSubsampling the X subsampling factor.
* @param sourceYSubsampling the Y subsampling factor.
* @param passXStart the smallest source X coordinate (inclusive)
@ -168,7 +168,7 @@ public class ReaderUtil {
* @param passPeriodY the Y period (vertical spacing between
* pixels) of the current progressive pass.
*
* @return an array of 6 <code>int</code>s containing the
* @return an array of 6 {@code int}s containing the
* destination min X, min Y, width, height, X period and Y period
* of the region that will be updated.
*/

2
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/gif/GIFImageReader.java
View file

@ -1017,7 +1017,7 @@ public class GIFImageReader extends ImageReader {
/**
* Remove all settings including global settings such as
* <code>Locale</code>s and listeners, as well as stream settings.
* {@code Locale}s and listeners, as well as stream settings.
*/
public void reset() {
super.reset();

16
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/gif/GIFImageWriter.java
View file

@ -70,7 +70,7 @@ public class GIFImageWriter extends ImageWriter {
GIFWritableImageMetadata.NATIVE_FORMAT_NAME;
/**
* The <code>output</code> case to an <code>ImageOutputStream</code>.
* The {@code output} case to an {@code ImageOutputStream}.
*/
private ImageOutputStream stream = null;
@ -272,7 +272,7 @@ public class GIFImageWriter extends ImageWriter {
}
/**
* Merges <code>inData</code> into <code>outData</code>. The supplied
* Merges {@code inData} into {@code outData}. The supplied
* metadata format name is attempted first and failing that the standard
* metadata format name is attempted.
*/
@ -554,8 +554,8 @@ public class GIFImageWriter extends ImageWriter {
*
* @param writeHeader Whether to write the header.
* @param writeTrailer Whether to write the trailer.
* @param sm The stream metadata or <code>null</code> if
* <code>writeHeader</code> is <code>false</code>.
* @param sm The stream metadata or {@code null} if
* {@code writeHeader} is {@code false}.
* @param iioimage The image and image metadata.
* @param p The write parameters.
*
@ -564,10 +564,10 @@ public class GIFImageWriter extends ImageWriter {
* greater than 8.
* @throws IllegalArgumentException if the color component size is
* greater than 8.
* @throws IllegalArgumentException if <code>writeHeader</code> is
* <code>true</code> and <code>sm</code> is <code>null</code>.
* @throws IllegalArgumentException if <code>writeHeader</code> is
* <code>false</code> and a sequence is not being written.
* @throws IllegalArgumentException if {@code writeHeader} is
* {@code true} and {@code sm} is {@code null}.
* @throws IllegalArgumentException if {@code writeHeader} is
* {@code false} and a sequence is not being written.
*/
private void write(boolean writeHeader,
boolean writeTrailer,

2
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/gif/GIFMetadata.java
View file

@ -32,7 +32,7 @@ import org.w3c.dom.Node;
/**
* Class which adds utility DOM element attribute access methods to
* <code>IIOMetadata</code> for subclass use.
* {@code IIOMetadata} for subclass use.
*/
abstract class GIFMetadata extends IIOMetadata {

8
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/COMMarkerSegment.java
View file

@ -39,7 +39,7 @@ import org.w3c.dom.Node;
* comment data as it is read from the stream. If the marker segment is
* constructed from a String, then local default encoding is assumed
* when creating the byte array. If the marker segment is created from
* an <code>IIOMetadataNode</code>, the user object, if present is
* an {@code IIOMetadataNode}, the user object, if present is
* assumed to be a byte array containing the comment data. If there is
* no user object then the comment attribute is used to create the
* byte array, again assuming the default local encoding.
@ -49,7 +49,7 @@ class COMMarkerSegment extends MarkerSegment {
/**
* Constructs a marker segment from the given buffer, which contains
* data from an <code>ImageInputStream</code>. This is used when
* data from an {@code ImageInputStream}. This is used when
* reading metadata from a stream.
*/
COMMarkerSegment(JPEGBuffer buffer) throws IOException {
@ -69,7 +69,7 @@ class COMMarkerSegment extends MarkerSegment {
/**
* Constructs a marker segment from a native tree node. If the node
* is an <code>IIOMetadataNode</code> and contains a user object,
* is an {@code IIOMetadataNode} and contains a user object,
* that object is used rather than the string attribute. If the
* string attribute is used, the default encoding is used.
*/
@ -103,7 +103,7 @@ class COMMarkerSegment extends MarkerSegment {
}
/**
* Returns an <code>IIOMetadataNode</code> containing the data array
* Returns an {@code IIOMetadataNode} containing the data array
* as a user object and a string encoded using ISO-8895-1, as an
* attribute.
*/

6
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JFIFMarkerSegment.java
View file

@ -90,7 +90,7 @@ class JFIFMarkerSegment extends MarkerSegment {
private final boolean debug = false;
/**
* Set to <code>true</code> when reading the chunks of an
* Set to {@code true} when reading the chunks of an
* ICC profile. All chunks are consolidated to create a single
* "segment" containing all the chunks. This flag is a state
* variable identifying whether to construct a new segment or
@ -594,10 +594,10 @@ class JFIFMarkerSegment extends MarkerSegment {
/**
* Writes out a default JFIF marker segment to the given
* output stream. If <code>thumbnails</code> is not <code>null</code>,
* output stream. If {@code thumbnails} is not {@code null},
* writes out the set of thumbnail images as JFXX marker segments, or
* incorporated into the JFIF segment if appropriate.
* If <code>iccProfile</code> is not <code>null</code>,
* If {@code iccProfile} is not {@code null},
* writes out the profile after the JFIF segment using as many APP2
* marker segments as necessary.
*/

14
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEG.java
View file

@ -36,7 +36,7 @@ import java.awt.color.ICC_ColorSpace;
/**
* A class containing JPEG-related constants, definitions, and
* static methods. This class and its constants must be public so that
* <code>JPEGImageWriteParam</code> can see it.
* {@code JPEGImageWriteParam} can see it.
*/
public class JPEG {
@ -234,10 +234,10 @@ public class JPEG {
public static final float DEFAULT_QUALITY = 0.75F;
/**
* Returns <code>true</code> if the given <code>ColorSpace</code>
* Returns {@code true} if the given {@code ColorSpace}
* object is an instance of ICC_ColorSpace but is not one of the
* standard <code>ColorSpaces</code> returned by
* <code>ColorSpace.getInstance()</code>.
* standard {@code ColorSpaces} returned by
* {@code ColorSpace.getInstance()}.
*/
static boolean isNonStandardICC(ColorSpace cs) {
boolean retval = false;
@ -255,8 +255,8 @@ public class JPEG {
/**
* Returns <code>true</code> if the given imageType can be used
* in a JFIF file. If <code>input</code> is true, then the
* Returns {@code true} if the given imageType can be used
* in a JFIF file. If {@code input} is true, then the
* image type is considered before colorspace conversion.
*/
static boolean isJFIFcompliant(ImageTypeSpecifier imageType,
@ -295,7 +295,7 @@ public class JPEG {
/**
* Given an image type, return the Adobe transform corresponding to
* that type, or ADOBE_IMPOSSIBLE if the image type is incompatible
* with an Adobe marker segment. If <code>input</code> is true, then
* with an Adobe marker segment. If {@code input} is true, then
* the image type is considered before colorspace conversion.
*/
static int transformForType(ImageTypeSpecifier imageType, boolean input) {

14
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEGBuffer.java
View file

@ -75,12 +75,12 @@ class JPEGBuffer {
}
/**
* Ensures that there are at least <code>count</code> bytes available
* Ensures that there are at least {@code count} bytes available
* in the buffer, loading more data and moving any remaining
* bytes to the front. A count of 0 means to just fill the buffer.
* If the count is larger than the buffer size, just fills the buffer.
* If the end of the stream is encountered before a non-0 count can
* be satisfied, an <code>IIOException</code> is thrown with the
* be satisfied, an {@code IIOException} is thrown with the
* message "Image Format Error".
*/
void loadBuf(int count) throws IOException {
@ -122,7 +122,7 @@ class JPEGBuffer {
* the buffer and then reading directly from the stream
* if necessary. The buffer is left in an appropriate
* state. If the end of the stream is encountered, an
* <code>IIOException</code> is thrown with the
* {@code IIOException} is thrown with the
* message "Image Format Error".
*/
void readData(byte [] data) throws IOException {
@ -149,9 +149,9 @@ class JPEGBuffer {
}
/**
* Skips <code>count</code> bytes, leaving the buffer
* Skips {@code count} bytes, leaving the buffer
* in an appropriate state. If the end of the stream is
* encountered, an <code>IIOException</code> is thrown with the
* encountered, an {@code IIOException} is thrown with the
* message "Image Format Error".
*/
void skipData(int count) throws IOException {
@ -195,8 +195,8 @@ class JPEGBuffer {
* the buffer as necessary. The buffer position is left
* pointing to the first non-0xff byte after a run of
* 0xff bytes. If the end of the stream is encountered,
* an EOI marker is inserted into the buffer and <code>true</code>
* is returned. Otherwise returns <code>false</code>.
* an EOI marker is inserted into the buffer and {@code true}
* is returned. Otherwise returns {@code false}.
*/
boolean scanForFF(JPEGImageReader reader) throws IOException {
boolean retval = false;

10
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEGImageReader.java
View file

@ -544,7 +544,7 @@ public class JPEGImageReader extends ImageReader {
}
/**
* Returns <code>true</code> if there is an image beyond
* Returns {@code true} if there is an image beyond
* the current stream position. Does not disturb the
* stream position.
*/
@ -614,13 +614,13 @@ public class JPEGImageReader extends ImageReader {
/**
* Read in the header information starting from the current
* stream position, returning <code>true</code> if the
* stream position, returning {@code true} if the
* header was a tables-only image. After this call, the
* native IJG decompression struct will contain the image
* information required by most query calls below
* (e.g. getWidth, getHeight, etc.), if the header was not
* a tables-only image.
* If reset is <code>true</code>, the state of the IJG
* If reset is {@code true}, the state of the IJG
* object is reset so that it can read a header again.
* This happens automatically if the header was a tables-only
* image.
@ -867,7 +867,7 @@ public class JPEGImageReader extends ImageReader {
* Checks the implied color conversion between the stream and
* the target image, altering the IJG output color space if necessary.
* If a java color conversion is required, then this sets up
* <code>convert</code>.
* {@code convert}.
* If bands are being rearranged at all (either source or destination
* bands are specified in the param), then the default color
* conversions are assumed to be correct.
@ -1394,7 +1394,7 @@ public class JPEGImageReader extends ImageReader {
}
/**
* Returns <code>true</code> if the read was aborted.
* Returns {@code true} if the read was aborted.
*/
private native boolean readImage(long structPointer,
byte [] buffer,

6
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEGImageWriter.java
View file

@ -1130,10 +1130,10 @@ public class JPEGImageWriter extends ImageWriter {
/*
* from jpeg_metadata.html:
* If no stream metadata is supplied to
* <code>ImageWriter.prepareWriteSequence</code>, then no
* {@code ImageWriter.prepareWriteSequence}, then no
* tables-only image is written. If stream metadata containing
* no tables is supplied to
* <code>ImageWriter.prepareWriteSequence</code>, then a tables-only
* {@code ImageWriter.prepareWriteSequence}, then a tables-only
* image containing default visually lossless tables is written.
*/
if (streamMetadata != null) {
@ -1699,7 +1699,7 @@ public class JPEGImageWriter extends ImageWriter {
private native void setDest(long structPointer);
/**
* Returns <code>true</code> if the write was aborted.
* Returns {@code true} if the write was aborted.
*/
private native boolean writeImage(long structPointer,
byte [] data,

24
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEGMetadata.java
View file

@ -66,17 +66,17 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
private static final boolean debug = false;
/**
* A copy of <code>markerSequence</code>, created the first time the
* <code>markerSequence</code> is modified. This is used by reset
* A copy of {@code markerSequence}, created the first time the
* {@code markerSequence} is modified. This is used by reset
* to restore the original state.
*/
private List<MarkerSegment> resetSequence = null;
/**
* Set to <code>true</code> when reading a thumbnail stored as
* Set to {@code true} when reading a thumbnail stored as
* JPEG. This is used to enforce the prohibition of JFIF thumbnails
* containing any JFIF marker segments, and to ensure generation of
* a correct native subtree during <code>getAsTree</code>.
* a correct native subtree during {@code getAsTree}.
*/
private boolean inThumb = false;
@ -93,7 +93,7 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
/////// Package-access variables
/**
* All data is a list of <code>MarkerSegment</code> objects.
* All data is a list of {@code MarkerSegment} objects.
* When accessing the list, use the tag to identify the particular
* subclass. Any JFIF marker segment must be the first element
* of the list if it is present, and any JFXX or APP2ICC marker
@ -132,17 +132,17 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
}
/*
* Constructs a <code>JPEGMetadata</code> object by reading the
* contents of an <code>ImageInputStream</code>. Has package-only
* Constructs a {@code JPEGMetadata} object by reading the
* contents of an {@code ImageInputStream}. Has package-only
* access.
*
* @param isStream A boolean indicating whether this object will be
* stream or image metadata.
* @param isThumb A boolean indicating whether this metadata object
* is for an image or for a thumbnail stored as JPEG.
* @param iis An <code>ImageInputStream</code> from which to read
* @param iis An {@code ImageInputStream} from which to read
* the metadata.
* @param reader The <code>JPEGImageReader</code> calling this
* @param reader The {@code JPEGImageReader} calling this
* constructor, to which warnings should be sent.
*/
JPEGMetadata(boolean isStream,
@ -365,7 +365,7 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
}
/**
* Constructs a default stream <code>JPEGMetadata</code> object appropriate
* Constructs a default stream {@code JPEGMetadata} object appropriate
* for the given write parameters.
*/
JPEGMetadata(ImageWriteParam param, JPEGImageWriter writer) {
@ -398,7 +398,7 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
}
/**
* Constructs a default image <code>JPEGMetadata</code> object appropriate
* Constructs a default image {@code JPEGMetadata} object appropriate
* for the given image type and write parameters.
*/
JPEGMetadata(ImageTypeSpecifier imageType,
@ -2248,7 +2248,7 @@ public class JPEGMetadata extends IIOMetadata implements Cloneable {
/**
* Check that this metadata object is in a consistent state and
* return <code>true</code> if it is or <code>false</code>
* return {@code true} if it is or {@code false}
* otherwise. All the constructors and modifiers should call
* this method at the end to guarantee that the data is always
* consistent, as the writer relies on this.

8
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/JPEGMetadataFormat.java
View file

@ -133,12 +133,12 @@ abstract class JPEGMetadataFormat extends IIOMetadataFormatImpl {
}
/**
* Returns <code>true</code> if the named element occurs in the
* Returns {@code true} if the named element occurs in the
* subtree of the format starting with the node named by
* <code>subtreeName</code>, including the node
* itself. <code>subtreeName</code> may be any node in
* {@code subtreeName}, including the node
* itself. {@code subtreeName} may be any node in
* the format. If it is not, an
* <code>IllegalArgumentException</code> is thrown.
* {@code IllegalArgumentException} is thrown.
*/
protected boolean isInSubtree(String elementName,
String subtreeName) {

4
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/jpeg/MarkerSegment.java
View file

@ -51,8 +51,8 @@ class MarkerSegment implements Cloneable {
boolean unknown = false; // Set to true if the tag is not recognized
/**
* Constructor for creating <code>MarkerSegment</code>s by reading
* from an <code>ImageInputStream</code>.
* Constructor for creating {@code MarkerSegment}s by reading
* from an {@code ImageInputStream}.
*/
MarkerSegment(JPEGBuffer buffer) throws IOException {

2
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/png/PNGMetadata.java
View file

@ -254,7 +254,7 @@ public class PNGMetadata extends IIOMetadata implements Cloneable {
/**
* Sets the IHDR_bitDepth and IHDR_colorType variables.
* The <code>numBands</code> parameter is necessary since
* The {@code numBands} parameter is necessary since
* we may only be writing a subset of the image bands.
*/
public void initialize(ImageTypeSpecifier imageType, int numBands) {

6
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/wbmp/WBMPImageReader.java
View file

@ -50,7 +50,7 @@ import com.sun.imageio.plugins.common.ReaderUtil;
/** This class is the Java Image IO plugin reader for WBMP images.
* It may subsample the image, clip the image,
* and shift the decoded image origin if the proper decoding parameter
* are set in the provided <code>WBMPImageReadParam</code>.
* are set in the provided {@code WBMPImageReadParam}.
*/
public class WBMPImageReader extends ImageReader {
/** The input stream where reads from */
@ -69,8 +69,8 @@ public class WBMPImageReader extends ImageReader {
private WBMPMetadata metadata;
/** Constructs <code>WBMPImageReader</code> from the provided
* <code>ImageReaderSpi</code>.
/** Constructs {@code WBMPImageReader} from the provided
* {@code ImageReaderSpi}.
*/
public WBMPImageReader(ImageReaderSpi originator) {
super(originator);

6
jdk/src/java.desktop/share/classes/com/sun/imageio/plugins/wbmp/WBMPImageWriter.java
View file

@ -57,7 +57,7 @@ import com.sun.imageio.plugins.common.I18N;
* a WBMP format.
*
* The encoding process may clip, subsample using the parameters
* specified in the <code>ImageWriteParam</code>.
* specified in the {@code ImageWriteParam}.
*
* @see com.sun.media.imageio.plugins.WBMPImageWriteParam
*/
@ -92,8 +92,8 @@ public class WBMPImageWriter extends ImageWriter {
return multiBytes;
}
/** Constructs <code>WBMPImageWriter</code> based on the provided
* <code>ImageWriterSpi</code>.
/** Constructs {@code WBMPImageWriter} based on the provided
* {@code ImageWriterSpi}.
*/
public WBMPImageWriter(ImageWriterSpi originator) {
super(originator);

32
jdk/src/java.desktop/share/classes/com/sun/media/sound/AudioSynthesizer.java
View file

@ -32,9 +32,9 @@ import javax.sound.sampled.AudioInputStream;
import javax.sound.sampled.SourceDataLine;
/**
* <code>AudioSynthesizer</code> is a <code>Synthesizer</code>
* which renders it's output audio into <code>SourceDataLine</code>
* or <code>AudioInputStream</code>.
* {@code AudioSynthesizer} is a {@code Synthesizer}
* which renders it's output audio into {@code SourceDataLine}
* or {@code AudioInputStream}.
*
* @see MidiSystem#getSynthesizer
* @see Synthesizer
@ -59,7 +59,7 @@ public interface AudioSynthesizer extends Synthesizer {
* Gets information about the possible properties for the synthesizer.
*
* @param info a proposed list of tag/value pairs that will be sent on open.
* @return an array of <code>AudioSynthesizerPropertyInfo</code> objects
* @return an array of {@code AudioSynthesizerPropertyInfo} objects
* describing possible properties. This array may be an empty array if
* no properties are required.
*/
@ -68,7 +68,7 @@ public interface AudioSynthesizer extends Synthesizer {
/**
* Opens the synthesizer and starts rendering audio into
* <code>SourceDataLine</code>.
* {@code SourceDataLine}.
*
* <p>An application opening a synthesizer explicitly with this call
* has to close the synthesizer by calling {@link #close}. This is
@ -77,13 +77,13 @@ public interface AudioSynthesizer extends Synthesizer {
*
* <p>Note that some synthesizers, once closed, cannot be reopened.
* Attempts to reopen such a synthesizer will always result in
* a <code>MidiUnavailableException</code>.
* a {@code MidiUnavailableException}.
*
* @param line which <code>AudioSynthesizer</code> writes output audio into.
* If <code>line</code> is null, then line from system default mixer is used.
* @param info a <code>Map<String,Object></code> object containing
* @param line which {@code AudioSynthesizer} writes output audio into.
* If {@code line} is null, then line from system default mixer is used.
* @param info a {@code Map<String,Object>} object containing
* properties for additional configuration supported by synthesizer.
* If <code>info</code> is null then default settings are used.
* If {@code info} is null then default settings are used.
*
* @throws MidiUnavailableException thrown if the synthesizer cannot be
* opened due to resource restrictions.
@ -98,7 +98,7 @@ public interface AudioSynthesizer extends Synthesizer {
/**
* Opens the synthesizer and renders audio into returned
* <code>AudioInputStream</code>.
* {@code AudioInputStream}.
*
* <p>An application opening a synthesizer explicitly with this call
* has to close the synthesizer by calling {@link #close}. This is
@ -107,13 +107,13 @@ public interface AudioSynthesizer extends Synthesizer {
*
* <p>Note that some synthesizers, once closed, cannot be reopened.
* Attempts to reopen such a synthesizer will always result in
* a <code>MidiUnavailableException<code>.
* a {@code MidiUnavailableException}.
*
* @param targetFormat specifies the <code>AudioFormat</code>
* used in returned <code>AudioInputStream</code>.
* @param info a <code>Map<String,Object></code> object containing
* @param targetFormat specifies the {@code AudioFormat}
* used in returned {@code AudioInputStream}.
* @param info a {@code Map<String,Object>} object containing
* properties for additional configuration supported by synthesizer.
* If <code>info</code> is null then default settings are used.
* If {@code info} is null then default settings are used.
*
* @throws MidiUnavailableException thrown if the synthesizer cannot be
* opened due to resource restrictions.

16
jdk/src/java.desktop/share/classes/com/sun/media/sound/AudioSynthesizerPropertyInfo.java
View file

@ -25,16 +25,16 @@
package com.sun.media.sound;
/**
* Information about property used in opening <code>AudioSynthesizer</code>.
* Information about property used in opening {@code AudioSynthesizer}.
*
* @author Karl Helgason
*/
public final class AudioSynthesizerPropertyInfo {
/**
* Constructs a <code>AudioSynthesizerPropertyInfo</code> object with a given
* name and value. The <code>description</code> and <code>choices</code>
* are initialized by <code>null</code> values.
* Constructs a {@code AudioSynthesizerPropertyInfo} object with a given
* name and value. The {@code description} and {@code choices}
* are initialized by {@code null} values.
*
* @param name the name of the property
* @param value the current value or class used for values.
@ -60,18 +60,18 @@ public final class AudioSynthesizerPropertyInfo {
*/
public String description = null;
/**
* The <code>value</code> field specifies the current value of
* The {@code value} field specifies the current value of
* the property.
*/
public Object value = null;
/**
* The <code>valueClass</code> field specifies class
* used in <code>value</code> field.
* The {@code valueClass} field specifies class
* used in {@code value} field.
*/
public Class<?> valueClass = null;
/**
* An array of possible values if the value for the field
* <code>AudioSynthesizerPropertyInfo.value</code> may be selected
* {@code AudioSynthesizerPropertyInfo.value} may be selected
* from a particular set of values; otherwise null.
*/
public Object[] choices = null;

2
jdk/src/java.desktop/share/classes/com/sun/media/sound/MidiUtils.java
View file

@ -250,7 +250,7 @@ public final class MidiUtils {
/**
* Binary search for the event indexes of the track
*
* @param tick - tick number of index to be found in array
* @param tick tick number of index to be found in array
* @return index in track which is on or after "tick".
* if no entries are found that follow after tick, track.size() is returned
*/

2
jdk/src/java.desktop/share/classes/com/sun/media/sound/SoftControl.java
View file

@ -25,7 +25,7 @@
package com.sun.media.sound;
/**
* <code>SoftControl</code> are the basic controls
* {@code SoftControl} are the basic controls
* used for control-rate processing.
*
* @author Karl Helgason

120
jdk/src/java.desktop/share/classes/java/applet/Applet.java
View file

@ -38,9 +38,9 @@ import javax.accessibility.*;
* An applet is a small program that is intended not to be run on
* its own, but rather to be embedded inside another application.
* <p>
* The <code>Applet</code> class must be the superclass of any
* The {@code Applet} class must be the superclass of any
* applet that is to be embedded in a Web page or viewed by the Java
* Applet Viewer. The <code>Applet</code> class provides a standard
* Applet Viewer. The {@code Applet} class provides a standard
* interface between applets and their environment.
*
* @author Arthur van Hoff
@ -52,10 +52,10 @@ public class Applet extends Panel {
/**
* Constructs a new Applet.
* <p>
* Note: Many methods in <code>java.applet.Applet</code>
* Note: Many methods in {@code java.applet.Applet}
* may be invoked by the applet only after the applet is
* fully constructed; applet should avoid calling methods
* in <code>java.applet.Applet</code> in the constructor.
* in {@code java.applet.Applet} in the constructor.
*
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
@ -88,8 +88,8 @@ public class Applet extends Panel {
* Read an applet from an object input stream.
* @param s an object input stream.
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless()</code> returns
* <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns
* {@code true}
* @serial
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.4
@ -104,9 +104,9 @@ public class Applet extends Panel {
/**
* Sets this applet's stub. This is done automatically by the system.
* <p>If there is a security manager, its <code> checkPermission </code>
* <p>If there is a security manager, its {@code checkPermission}
* method is called with the
* <code>AWTPermission("setAppletStub")</code>
* {@code AWTPermission("setAppletStub")}
* permission if a stub has already been set.
* @param stub the new stub.
* @exception SecurityException if the caller cannot set the stub
@ -123,11 +123,11 @@ public class Applet extends Panel {
/**
* Determines if this applet is active. An applet is marked active
* just before its <code>start</code> method is called. It becomes
* inactive just before its <code>stop</code> method is called.
* just before its {@code start} method is called. It becomes
* inactive just before its {@code stop} method is called.
*
* @return <code>true</code> if the applet is active;
* <code>false</code> otherwise.
* @return {@code true} if the applet is active;
* {@code false} otherwise.
* @see java.applet.Applet#start()
* @see java.applet.Applet#stop()
*/
@ -179,14 +179,14 @@ public class Applet extends Panel {
* &lt;/applet&gt;
* </pre></blockquote>
* <p>
* then a call to <code>getParameter("Color")</code> returns the
* value <code>"blue"</code>.
* then a call to {@code getParameter("Color")} returns the
* value {@code "blue"}.
* <p>
* The <code>name</code> argument is case insensitive.
* The {@code name} argument is case insensitive.
*
* @param name a parameter name.
* @return the value of the named parameter,
* or <code>null</code> if not set.
* or {@code null} if not set.
*/
public String getParameter(String name) {
return stub.getParameter(name);
@ -260,8 +260,8 @@ public class Applet extends Panel {
}
/**
* Returns an <code>Image</code> object that can then be painted on
* the screen. The <code>url</code> that is passed as an argument
* Returns an {@code Image} object that can then be painted on
* the screen. The {@code url} that is passed as an argument
* must specify an absolute URL.
* <p>
* This method always returns immediately, whether or not the image
@ -278,10 +278,10 @@ public class Applet extends Panel {
}
/**
* Returns an <code>Image</code> object that can then be painted on
* the screen. The <code>url</code> argument must specify an absolute
* URL. The <code>name</code> argument is a specifier that is
* relative to the <code>url</code> argument.
* Returns an {@code Image} object that can then be painted on
* the screen. The {@code url} argument must specify an absolute
* URL. The {@code name} argument is a specifier that is
* relative to the {@code url} argument.
* <p>
* This method always returns immediately, whether or not the image
* exists. When this applet attempts to draw the image on the screen,
@ -290,7 +290,7 @@ public class Applet extends Panel {
*
* @param url an absolute URL giving the base location of the image.
* @param name the location of the image, relative to the
* <code>url</code> argument.
* {@code url} argument.
* @return the image at the specified URL.
* @see java.awt.Image
*/
@ -315,8 +315,8 @@ public class Applet extends Panel {
}
/**
* Returns the <code>AudioClip</code> object specified by the
* <code>URL</code> argument.
* Returns the {@code AudioClip} object specified by the
* {@code URL} argument.
* <p>
* This method always returns immediately, whether or not the audio
* clip exists. When this applet attempts to play the audio clip, the
@ -331,8 +331,8 @@ public class Applet extends Panel {
}
/**
* Returns the <code>AudioClip</code> object specified by the
* <code>URL</code> and <code>name</code> arguments.
* Returns the {@code AudioClip} object specified by the
* {@code URL} and {@code name} arguments.
* <p>
* This method always returns immediately, whether or not the audio
* clip exists. When this applet attempts to play the audio clip, the
@ -341,7 +341,7 @@ public class Applet extends Panel {
* @param url an absolute URL giving the base location of the
* audio clip.
* @param name the location of the audio clip, relative to the
* <code>url</code> argument.
* {@code url} argument.
* @return the audio clip at the specified URL.
* @see java.applet.AudioClip
*/
@ -355,11 +355,11 @@ public class Applet extends Panel {
/**
* Returns information about this applet. An applet should override
* this method to return a <code>String</code> containing information
* this method to return a {@code String} containing information
* about the author, version, and copyright of the applet.
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class returns <code>null</code>.
* {@code Applet} class returns {@code null}.
*
* @return a string containing information about the author, version, and
* copyright of the applet.
@ -388,10 +388,10 @@ public class Applet extends Panel {
/**
* Returns information about the parameters that are understood by
* this applet. An applet should override this method to return an
* array of <code>Strings</code> describing these parameters.
* array of {@code Strings} describing these parameters.
* <p>
* Each element of the array should be a set of three
* <code>Strings</code> containing the name, the type, and a
* {@code Strings} containing the name, the type, and a
* description. For example:
* <blockquote><pre>
* String pinfo[][] = {
@ -402,7 +402,7 @@ public class Applet extends Panel {
* </pre></blockquote>
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class returns <code>null</code>.
* {@code Applet} class returns {@code null}.
*
* @return an array describing the parameters this applet looks for.
*/
@ -430,7 +430,7 @@ public class Applet extends Panel {
* @param url an absolute URL giving the base location of the
* audio clip.
* @param name the location of the audio clip, relative to the
* <code>url</code> argument.
* {@code url} argument.
*/
public void play(URL url, String name) {
AudioClip clip = getAudioClip(url, name);
@ -442,16 +442,16 @@ public class Applet extends Panel {
/**
* Called by the browser or applet viewer to inform
* this applet that it has been loaded into the system. It is always
* called before the first time that the <code>start</code> method is
* called before the first time that the {@code start} method is
* called.
* <p>
* A subclass of <code>Applet</code> should override this method if
* A subclass of {@code Applet} should override this method if
* it has initialization to perform. For example, an applet with
* threads would use the <code>init</code> method to create the
* threads and the <code>destroy</code> method to kill them.
* threads would use the {@code init} method to create the
* threads and the {@code destroy} method to kill them.
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class does nothing.
* {@code Applet} class does nothing.
*
* @see java.applet.Applet#destroy()
* @see java.applet.Applet#start()
@ -463,25 +463,25 @@ public class Applet extends Panel {
/**
* Called by the browser or applet viewer to inform
* this applet that it should start its execution. It is called after
* the <code>init</code> method and each time the applet is revisited
* the {@code init} method and each time the applet is revisited
* in a Web page.
* <p>
* A subclass of <code>Applet</code> should override this method if
* A subclass of {@code Applet} should override this method if
* it has any operation that it wants to perform each time the Web
* page containing it is visited. For example, an applet with
* animation might want to use the <code>start</code> method to
* resume animation, and the <code>stop</code> method to suspend the
* animation might want to use the {@code start} method to
* resume animation, and the {@code stop} method to suspend the
* animation.
* <p>
* Note: some methods, such as <code>getLocationOnScreen</code>, can only
* Note: some methods, such as {@code getLocationOnScreen}, can only
* provide meaningful results if the applet is showing. Because
* <code>isShowing</code> returns <code>false</code> when the applet's
* <code>start</code> is first called, methods requiring
* <code>isShowing</code> to return <code>true</code> should be called from
* a <code>ComponentListener</code>.
* {@code isShowing} returns {@code false} when the applet's
* {@code start} is first called, methods requiring
* {@code isShowing} to return {@code true} should be called from
* a {@code ComponentListener}.
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class does nothing.
* {@code Applet} class does nothing.
*
* @see java.applet.Applet#destroy()
* @see java.applet.Applet#init()
@ -498,15 +498,15 @@ public class Applet extends Panel {
* the Web page that contains this applet has been replaced by
* another page, and also just before the applet is to be destroyed.
* <p>
* A subclass of <code>Applet</code> should override this method if
* A subclass of {@code Applet} should override this method if
* it has any operation that it wants to perform each time the Web
* page containing it is no longer visible. For example, an applet
* with animation might want to use the <code>start</code> method to
* resume animation, and the <code>stop</code> method to suspend the
* with animation might want to use the {@code start} method to
* resume animation, and the {@code stop} method to suspend the
* animation.
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class does nothing.
* {@code Applet} class does nothing.
*
* @see java.applet.Applet#destroy()
* @see java.applet.Applet#init()
@ -517,17 +517,17 @@ public class Applet extends Panel {
/**
* Called by the browser or applet viewer to inform
* this applet that it is being reclaimed and that it should destroy
* any resources that it has allocated. The <code>stop</code> method
* will always be called before <code>destroy</code>.
* any resources that it has allocated. The {@code stop} method
* will always be called before {@code destroy}.
* <p>
* A subclass of <code>Applet</code> should override this method if
* A subclass of {@code Applet} should override this method if
* it has any operation that it wants to perform before it is
* destroyed. For example, an applet with threads would use the
* <code>init</code> method to create the threads and the
* <code>destroy</code> method to kill them.
* {@code init} method to create the threads and the
* {@code destroy} method to kill them.
* <p>
* The implementation of this method provided by the
* <code>Applet</code> class does nothing.
* {@code Applet} class does nothing.
*
* @see java.applet.Applet#init()
* @see java.applet.Applet#start()
@ -561,7 +561,7 @@ public class Applet extends Panel {
/**
* This class implements accessibility support for the
* <code>Applet</code> class. It provides an implementation of the
* {@code Applet} class. It provides an implementation of the
* Java Accessibility API appropriate to applet user-interface elements.
* @since 1.3
*/

4
jdk/src/java.desktop/share/classes/java/applet/AudioClip.java
View file

@ -26,8 +26,8 @@
package java.applet;
/**
* The <code>AudioClip</code> interface is a simple abstraction for
* playing a sound clip. Multiple <code>AudioClip</code> items can be
* The {@code AudioClip} interface is a simple abstraction for
* playing a sound clip. Multiple {@code AudioClip} items can be
* playing at the same time, and the resulting sound is mixed
* together to produce a composite.
*

2
jdk/src/java.desktop/share/classes/java/awt/AWTError.java
View file

@ -38,7 +38,7 @@ public class AWTError extends Error {
private static final long serialVersionUID = -1819846354050686206L;
/**
* Constructs an instance of <code>AWTError</code> with the specified
* Constructs an instance of {@code AWTError} with the specified
* detail message.
* @param msg the detail message.
* @since 1.0

4
jdk/src/java.desktop/share/classes/java/awt/AWTEvent.java
View file

@ -410,11 +410,11 @@ public abstract class AWTEvent extends EventObject {
}
/**
* Returns a string representing the state of this <code>Event</code>.
* Returns a string representing the state of this {@code Event}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return a string representation of this event
*/

22
jdk/src/java.desktop/share/classes/java/awt/AWTEventMulticaster.java
View file

@ -122,9 +122,9 @@ public class AWTEventMulticaster implements
/**
* Creates an event multicaster instance which chains listener-a
* with listener-b. Input parameters <code>a</code> and <code>b</code>
* should not be <code>null</code>, though implementations may vary in
* choosing whether or not to throw <code>NullPointerException</code>
* with listener-b. Input parameters {@code a} and {@code b}
* should not be {@code null}, though implementations may vary in
* choosing whether or not to throw {@code NullPointerException}
* in that case.
* @param a listener-a
* @param b listener-b
@ -1078,30 +1078,30 @@ public class AWTEventMulticaster implements
/**
* Returns an array of all the objects chained as
* <code><em>Foo</em>Listener</code>s by the specified
* <code>java.util.EventListener</code>.
* {@code java.util.EventListener}.
* <code><em>Foo</em>Listener</code>s are chained by the
* <code>AWTEventMulticaster</code> using the
* {@code AWTEventMulticaster} using the
* <code>add<em>Foo</em>Listener</code> method.
* If a <code>null</code> listener is specified, this method returns an
* If a {@code null} listener is specified, this method returns an
* empty array. If the specified listener is not an instance of
* <code>AWTEventMulticaster</code>, this method returns an array which
* {@code AWTEventMulticaster}, this method returns an array which
* contains only the specified listener. If no such listeners are chained,
* this method returns an empty array.
*
* @param <T> the listener type
* @param l the specified <code>java.util.EventListener</code>
* @param l the specified {@code java.util.EventListener}
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects chained as
* <code><em>Foo</em>Listener</code>s by the specified multicast
* listener, or an empty array if no such listeners have been
* chained by the specified multicast listener
* @exception NullPointerException if the specified
* {@code listenertype} parameter is {@code null}
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
*
* @since 1.4
*/

4
jdk/src/java.desktop/share/classes/java/awt/AWTException.java
View file

@ -38,9 +38,9 @@ public class AWTException extends Exception {
private static final long serialVersionUID = -1900414231151323879L;
/**
* Constructs an instance of <code>AWTException</code> with the
* Constructs an instance of {@code AWTException} with the
* specified detail message. A detail message is an
* instance of <code>String</code> that describes this particular
* instance of {@code String} that describes this particular
* exception.
* @param msg the detail message
* @since 1.0

150
jdk/src/java.desktop/share/classes/java/awt/AWTKeyStroke.java
View file

@ -37,22 +37,22 @@ import java.lang.reflect.Field;
import sun.swing.SwingAccessor;
/**
* An <code>AWTKeyStroke</code> represents a key action on the
* keyboard, or equivalent input device. <code>AWTKeyStroke</code>s
* An {@code AWTKeyStroke} represents a key action on the
* keyboard, or equivalent input device. {@code AWTKeyStroke}s
* can correspond to only a press or release of a
* particular key, just as <code>KEY_PRESSED</code> and
* <code>KEY_RELEASED</code> <code>KeyEvent</code>s do;
* particular key, just as {@code KEY_PRESSED} and
* {@code KEY_RELEASED KeyEvent}s do;
* alternately, they can correspond to typing a specific Java character, just
* as <code>KEY_TYPED</code> <code>KeyEvent</code>s do.
* In all cases, <code>AWTKeyStroke</code>s can specify modifiers
* as {@code KEY_TYPED KeyEvent}s do.
* In all cases, {@code AWTKeyStroke}s can specify modifiers
* (alt, shift, control, meta, altGraph, or a combination thereof) which must be present
* during the action for an exact match.
* <p>
* <code>AWTKeyStrokes</code> are immutable, and are intended
* {@code AWTKeyStrokes} are immutable, and are intended
* to be unique. Client code should never create an
* <code>AWTKeyStroke</code> on its own, but should instead use
* a variant of <code>getAWTKeyStroke</code>. Client use of these factory
* methods allows the <code>AWTKeyStroke</code> implementation
* {@code AWTKeyStroke} on its own, but should instead use
* a variant of {@code getAWTKeyStroke}. Client use of these factory
* methods allows the {@code AWTKeyStroke} implementation
* to cache and share instances efficiently.
*
* @see #getAWTKeyStroke
@ -88,17 +88,17 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Constructs an <code>AWTKeyStroke</code> with default values.
* Constructs an {@code AWTKeyStroke} with default values.
* The default values used are:
* <table border="1" summary="AWTKeyStroke default values">
* <tr><th>Property</th><th>Default Value</th></tr>
* <tr>
* <td>Key Char</td>
* <td><code>KeyEvent.CHAR_UNDEFINED</code></td>
* <td>{@code KeyEvent.CHAR_UNDEFINED}</td>
* </tr>
* <tr>
* <td>Key Code</td>
* <td><code>KeyEvent.VK_UNDEFINED</code></td>
* <td>{@code KeyEvent.VK_UNDEFINED}</td>
* </tr>
* <tr>
* <td>Modifiers</td>
@ -106,12 +106,12 @@ public class AWTKeyStroke implements Serializable {
* </tr>
* <tr>
* <td>On key release?</td>
* <td><code>false</code></td>
* <td>{@code false}</td>
* </tr>
* </table>
*
* <code>AWTKeyStroke</code>s should not be constructed
* by client code. Use a variant of <code>getAWTKeyStroke</code>
* {@code AWTKeyStroke}s should not be constructed
* by client code. Use a variant of {@code getAWTKeyStroke}
* instead.
*
* @see #getAWTKeyStroke
@ -120,17 +120,17 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Constructs an <code>AWTKeyStroke</code> with the specified
* values. <code>AWTKeyStroke</code>s should not be constructed
* by client code. Use a variant of <code>getAWTKeyStroke</code>
* Constructs an {@code AWTKeyStroke} with the specified
* values. {@code AWTKeyStroke}s should not be constructed
* by client code. Use a variant of {@code getAWTKeyStroke}
* instead.
*
* @param keyChar the character value for a keyboard key
* @param keyCode the key code for this <code>AWTKeyStroke</code>
* @param keyCode the key code for this {@code AWTKeyStroke}
* @param modifiers a bitwise-ored combination of any modifiers
* @param onKeyRelease <code>true</code> if this
* <code>AWTKeyStroke</code> corresponds
* to a key release; <code>false</code> otherwise
* @param onKeyRelease {@code true} if this
* {@code AWTKeyStroke} corresponds
* to a key release; {@code false} otherwise
* @see #getAWTKeyStroke
*/
protected AWTKeyStroke(char keyChar, int keyCode, int modifiers,
@ -185,12 +185,12 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns a shared instance of an <code>AWTKeyStroke</code>
* that represents a <code>KEY_TYPED</code> event for the
* Returns a shared instance of an {@code AWTKeyStroke}
* that represents a {@code KEY_TYPED} event for the
* specified character.
*
* @param keyChar the character value for a keyboard key
* @return an <code>AWTKeyStroke</code> object for that key
* @return an {@code AWTKeyStroke} object for that key
*/
public static AWTKeyStroke getAWTKeyStroke(char keyChar) {
return getCachedStroke(keyChar, KeyEvent.VK_UNDEFINED, 0, false);
@ -202,7 +202,7 @@ public class AWTKeyStroke implements Serializable {
* specified Character object and a set of modifiers. Note
* that the first parameter is of type Character rather than
* char. This is to avoid inadvertent clashes with
* calls to <code>getAWTKeyStroke(int keyCode, int modifiers)</code>.
* calls to {@code getAWTKeyStroke(int keyCode, int modifiers)}.
*
* The modifiers consist of any combination of following:<ul>
* <li>java.awt.event.InputEvent.SHIFT_DOWN_MASK
@ -227,9 +227,9 @@ public class AWTKeyStroke implements Serializable {
*
* @param keyChar the Character object for a keyboard character
* @param modifiers a bitwise-ored combination of any modifiers
* @return an <code>AWTKeyStroke</code> object for that key
* @throws IllegalArgumentException if <code>keyChar</code> is
* <code>null</code>
* @return an {@code AWTKeyStroke} object for that key
* @throws IllegalArgumentException if {@code keyChar} is
* {@code null}
*
* @see java.awt.event.InputEvent
*/
@ -243,19 +243,19 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns a shared instance of an <code>AWTKeyStroke</code>,
* Returns a shared instance of an {@code AWTKeyStroke},
* given a numeric key code and a set of modifiers, specifying
* whether the key is activated when it is pressed or released.
* <p>
* The "virtual key" constants defined in
* <code>java.awt.event.KeyEvent</code> can be
* {@code java.awt.event.KeyEvent} can be
* used to specify the key code. For example:<ul>
* <li><code>java.awt.event.KeyEvent.VK_ENTER</code>
* <li><code>java.awt.event.KeyEvent.VK_TAB</code>
* <li><code>java.awt.event.KeyEvent.VK_SPACE</code>
* <li>{@code java.awt.event.KeyEvent.VK_ENTER}
* <li>{@code java.awt.event.KeyEvent.VK_TAB}
* <li>{@code java.awt.event.KeyEvent.VK_SPACE}
* </ul>
* Alternatively, the key code may be obtained by calling
* <code>java.awt.event.KeyEvent.getExtendedKeyCodeForChar</code>.
* {@code java.awt.event.KeyEvent.getExtendedKeyCodeForChar}.
*
* The modifiers consist of any combination of:<ul>
* <li>java.awt.event.InputEvent.SHIFT_DOWN_MASK
@ -279,8 +279,8 @@ public class AWTKeyStroke implements Serializable {
*
* @param keyCode an int specifying the numeric code for a keyboard key
* @param modifiers a bitwise-ored combination of any modifiers
* @param onKeyRelease <code>true</code> if the <code>AWTKeyStroke</code>
* should represent a key release; <code>false</code> otherwise
* @param onKeyRelease {@code true} if the {@code AWTKeyStroke}
* should represent a key release; {@code false} otherwise
* @return an AWTKeyStroke object for that key
*
* @see java.awt.event.KeyEvent
@ -293,16 +293,16 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns a shared instance of an <code>AWTKeyStroke</code>,
* Returns a shared instance of an {@code AWTKeyStroke},
* given a numeric key code and a set of modifiers. The returned
* <code>AWTKeyStroke</code> will correspond to a key press.
* {@code AWTKeyStroke} will correspond to a key press.
* <p>
* The "virtual key" constants defined in
* <code>java.awt.event.KeyEvent</code> can be
* {@code java.awt.event.KeyEvent} can be
* used to specify the key code. For example:<ul>
* <li><code>java.awt.event.KeyEvent.VK_ENTER</code>
* <li><code>java.awt.event.KeyEvent.VK_TAB</code>
* <li><code>java.awt.event.KeyEvent.VK_SPACE</code>
* <li>{@code java.awt.event.KeyEvent.VK_ENTER}
* <li>{@code java.awt.event.KeyEvent.VK_TAB}
* <li>{@code java.awt.event.KeyEvent.VK_SPACE}
* </ul>
* The modifiers consist of any combination of:<ul>
* <li>java.awt.event.InputEvent.SHIFT_DOWN_MASK
@ -326,7 +326,7 @@ public class AWTKeyStroke implements Serializable {
*
* @param keyCode an int specifying the numeric code for a keyboard key
* @param modifiers a bitwise-ored combination of any modifiers
* @return an <code>AWTKeyStroke</code> object for that key
* @return an {@code AWTKeyStroke} object for that key
*
* @see java.awt.event.KeyEvent
* @see java.awt.event.InputEvent
@ -337,18 +337,18 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns an <code>AWTKeyStroke</code> which represents the
* stroke which generated a given <code>KeyEvent</code>.
* Returns an {@code AWTKeyStroke} which represents the
* stroke which generated a given {@code KeyEvent}.
* <p>
* This method obtains the keyChar from a <code>KeyTyped</code>
* event, and the keyCode from a <code>KeyPressed</code> or
* <code>KeyReleased</code> event. The <code>KeyEvent</code> modifiers are
* obtained for all three types of <code>KeyEvent</code>.
* This method obtains the keyChar from a {@code KeyTyped}
* event, and the keyCode from a {@code KeyPressed} or
* {@code KeyReleased} event. The {@code KeyEvent} modifiers are
* obtained for all three types of {@code KeyEvent}.
*
* @param anEvent the <code>KeyEvent</code> from which to
* obtain the <code>AWTKeyStroke</code>
* @throws NullPointerException if <code>anEvent</code> is null
* @return the <code>AWTKeyStroke</code> that precipitated the event
* @param anEvent the {@code KeyEvent} from which to
* obtain the {@code AWTKeyStroke}
* @throws NullPointerException if {@code anEvent} is null
* @return the {@code AWTKeyStroke} that precipitated the event
*/
public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent) {
int id = anEvent.getID();
@ -371,7 +371,7 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Parses a string and returns an <code>AWTKeyStroke</code>.
* Parses a string and returns an {@code AWTKeyStroke}.
* The string must have the following syntax:
* <pre>
* &lt;modifiers&gt;* (&lt;typedID&gt; | &lt;pressedReleasedID&gt;)
@ -393,8 +393,8 @@ public class AWTKeyStroke implements Serializable {
* </pre>
*
* @param s a String formatted as described above
* @return an <code>AWTKeyStroke</code> object for that String
* @throws IllegalArgumentException if <code>s</code> is <code>null</code>,
* @return an {@code AWTKeyStroke} object for that String
* @throws IllegalArgumentException if {@code s} is {@code null},
* or is formatted incorrectly
*/
public static AWTKeyStroke getAWTKeyStroke(String s) {
@ -500,8 +500,8 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns the integer constant for the KeyEvent.VK field named
* <code>key</code>. This will throw an
* <code>IllegalArgumentException</code> if <code>key</code> is
* {@code key}. This will throw an
* {@code IllegalArgumentException} if {@code key} is
* not a valid constant.
*/
private static int getVKValue(String key) {
@ -527,7 +527,7 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns the character for this <code>AWTKeyStroke</code>.
* Returns the character for this {@code AWTKeyStroke}.
*
* @return a char value
* @see #getAWTKeyStroke(char)
@ -538,7 +538,7 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns the numeric key code for this <code>AWTKeyStroke</code>.
* Returns the numeric key code for this {@code AWTKeyStroke}.
*
* @return an int containing the key code value
* @see #getAWTKeyStroke(int,int)
@ -549,7 +549,7 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns the modifier keys for this <code>AWTKeyStroke</code>.
* Returns the modifier keys for this {@code AWTKeyStroke}.
*
* @return an int containing the modifiers
* @see #getAWTKeyStroke(int,int)
@ -559,10 +559,10 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns whether this <code>AWTKeyStroke</code> represents a key release.
* Returns whether this {@code AWTKeyStroke} represents a key release.
*
* @return <code>true</code> if this <code>AWTKeyStroke</code>
* represents a key release; <code>false</code> otherwise
* @return {@code true} if this {@code AWTKeyStroke}
* represents a key release; {@code false} otherwise
* @see #getAWTKeyStroke(int,int,boolean)
*/
public final boolean isOnKeyRelease() {
@ -570,12 +570,12 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns the type of <code>KeyEvent</code> which corresponds to
* this <code>AWTKeyStroke</code>.
* Returns the type of {@code KeyEvent} which corresponds to
* this {@code AWTKeyStroke}.
*
* @return <code>KeyEvent.KEY_PRESSED</code>,
* <code>KeyEvent.KEY_TYPED</code>,
* or <code>KeyEvent.KEY_RELEASED</code>
* @return {@code KeyEvent.KEY_PRESSED},
* {@code KeyEvent.KEY_TYPED},
* or {@code KeyEvent.KEY_RELEASED}
* @see java.awt.event.KeyEvent
*/
public final int getKeyEventType() {
@ -617,8 +617,8 @@ public class AWTKeyStroke implements Serializable {
/**
* Returns a string that displays and identifies this object's properties.
* The <code>String</code> returned by this method can be passed
* as a parameter to <code>getAWTKeyStroke(String)</code> to produce
* The {@code String} returned by this method can be passed
* as a parameter to {@code getAWTKeyStroke(String)} to produce
* a key stroke equal to this key stroke.
*
* @return a String representation of this object
@ -695,8 +695,8 @@ public class AWTKeyStroke implements Serializable {
}
/**
* Returns a cached instance of <code>AWTKeyStroke</code> (or a subclass of
* <code>AWTKeyStroke</code>) which is equal to this instance.
* Returns a cached instance of {@code AWTKeyStroke} (or a subclass of
* {@code AWTKeyStroke}) which is equal to this instance.
*
* @return a cached instance which is equal to this instance
* @throws java.io.ObjectStreamException if a serialization problem occurs

34
jdk/src/java.desktop/share/classes/java/awt/AWTPermission.java
View file

@ -29,7 +29,7 @@ import java.security.BasicPermission;
/**
* This class is for AWT permissions.
* An <code>AWTPermission</code> contains a target name but
* An {@code AWTPermission} contains a target name but
* no actions list; you either have the named permission
* or you don't.
*
@ -39,7 +39,7 @@ import java.security.BasicPermission;
* Also, an asterisk could be used to represent all AWT permissions.
*
* <P>
* The following table lists all the possible <code>AWTPermission</code>
* The following table lists all the possible {@code AWTPermission}
* target names, and for each provides a description of what the
* permission allows and a discussion of the risks of granting code
* the permission.
@ -125,12 +125,12 @@ import java.security.BasicPermission;
*
* <tr>
* <td>replaceKeyboardFocusManager</td>
* <td>Sets the <code>KeyboardFocusManager</code> for
* <td>Sets the {@code KeyboardFocusManager} for
* a particular thread.
* <td>When <code>SecurityManager</code> is installed, the invoking
* <td>When {@code SecurityManager} is installed, the invoking
* thread must be granted this permission in order to replace
* the current <code>KeyboardFocusManager</code>. If permission
* is not granted, a <code>SecurityException</code> will be thrown.
* the current {@code KeyboardFocusManager}. If permission
* is not granted, a {@code SecurityException} will be thrown.
* </tr>
*
* <tr>
@ -201,15 +201,15 @@ public final class AWTPermission extends BasicPermission {
private static final long serialVersionUID = 8890392402588814465L;
/**
* Creates a new <code>AWTPermission</code> with the specified name.
* The name is the symbolic name of the <code>AWTPermission</code>,
* Creates a new {@code AWTPermission} with the specified name.
* The name is the symbolic name of the {@code AWTPermission},
* such as "topLevelWindow", "systemClipboard", etc. An asterisk
* may be used to indicate all AWT permissions.
*
* @param name the name of the AWTPermission
*
* @throws NullPointerException if <code>name</code> is <code>null</code>.
* @throws IllegalArgumentException if <code>name</code> is empty.
* @throws NullPointerException if {@code name} is {@code null}.
* @throws IllegalArgumentException if {@code name} is empty.
*/
public AWTPermission(String name)
@ -218,15 +218,15 @@ public final class AWTPermission extends BasicPermission {
}
/**
* Creates a new <code>AWTPermission</code> object with the specified name.
* The name is the symbolic name of the <code>AWTPermission</code>, and the
* actions string is currently unused and should be <code>null</code>.
* Creates a new {@code AWTPermission} object with the specified name.
* The name is the symbolic name of the {@code AWTPermission}, and the
* actions string is currently unused and should be {@code null}.
*
* @param name the name of the <code>AWTPermission</code>
* @param actions should be <code>null</code>
* @param name the name of the {@code AWTPermission}
* @param actions should be {@code null}
*
* @throws NullPointerException if <code>name</code> is <code>null</code>.
* @throws IllegalArgumentException if <code>name</code> is empty.
* @throws NullPointerException if {@code name} is {@code null}.
* @throws IllegalArgumentException if {@code name} is empty.
*/
public AWTPermission(String name, String actions)

8
jdk/src/java.desktop/share/classes/java/awt/ActiveEvent.java
View file

@ -28,19 +28,19 @@ package java.awt;
/**
* An interface for events that know how to dispatch themselves.
* By implementing this interface an event can be placed upon the event
* queue and its <code>dispatch()</code> method will be called when the event
* is dispatched, using the <code>EventDispatchThread</code>.
* queue and its {@code dispatch()} method will be called when the event
* is dispatched, using the {@code EventDispatchThread}.
* <p>
* This is a very useful mechanism for avoiding deadlocks. If
* a thread is executing in a critical section (i.e., it has entered
* one or more monitors), calling other synchronized code may
* cause deadlocks. To avoid the potential deadlocks, an
* <code>ActiveEvent</code> can be created to run the second section of
* {@code ActiveEvent} can be created to run the second section of
* code at later time. If there is contention on the monitor,
* the second thread will simply block until the first thread
* has finished its work and exited its monitors.
* <p>
* For security reasons, it is often desirable to use an <code>ActiveEvent</code>
* For security reasons, it is often desirable to use an {@code ActiveEvent}
* to avoid calling untrusted code from a critical thread. For
* instance, peer implementations can use this facility to avoid
* making calls into user code from a system thread. Doing so avoids

20
jdk/src/java.desktop/share/classes/java/awt/Adjustable.java
View file

@ -39,25 +39,25 @@ import java.lang.annotation.Native;
public interface Adjustable {
/**
* Indicates that the <code>Adjustable</code> has horizontal orientation.
* Indicates that the {@code Adjustable} has horizontal orientation.
*/
@Native public static final int HORIZONTAL = 0;
/**
* Indicates that the <code>Adjustable</code> has vertical orientation.
* Indicates that the {@code Adjustable} has vertical orientation.
*/
@Native public static final int VERTICAL = 1;
/**
* Indicates that the <code>Adjustable</code> has no orientation.
* Indicates that the {@code Adjustable} has no orientation.
*/
@Native public static final int NO_ORIENTATION = 2;
/**
* Gets the orientation of the adjustable object.
* @return the orientation of the adjustable object;
* either <code>HORIZONTAL</code>, <code>VERTICAL</code>,
* or <code>NO_ORIENTATION</code>
* either {@code HORIZONTAL}, {@code VERTICAL},
* or {@code NO_ORIENTATION}
*/
int getOrientation();
@ -124,15 +124,15 @@ public interface Adjustable {
/**
* Sets the current value of the adjustable object. If
* the value supplied is less than <code>minimum</code>
* or greater than <code>maximum</code> - <code>visibleAmount</code>,
* the value supplied is less than {@code minimum}
* or greater than {@code maximum} - {@code visibleAmount},
* then one of those values is substituted, as appropriate.
* <p>
* Calling this method does not fire an
* <code>AdjustmentEvent</code>.
* {@code AdjustmentEvent}.
*
* @param v the current value, between <code>minimum</code>
* and <code>maximum</code> - <code>visibleAmount</code>
* @param v the current value, between {@code minimum}
* and {@code maximum} - {@code visibleAmount}
*/
void setValue(int v);

106
jdk/src/java.desktop/share/classes/java/awt/AlphaComposite.java
View file

@ -30,7 +30,7 @@ import java.lang.annotation.Native;
import sun.java2d.SunCompositeContext;
/**
* The <code>AlphaComposite</code> class implements basic alpha
* The {@code AlphaComposite} class implements basic alpha
* compositing rules for combining source and destination colors
* to achieve blending and transparency effects with graphics and
* images.
@ -44,7 +44,7 @@ import sun.java2d.SunCompositeContext;
* <p>
* This class extends the standard equations defined by Porter and
* Duff to include one additional factor.
* An instance of the <code>AlphaComposite</code> class can contain
* An instance of the {@code AlphaComposite} class can contain
* an alpha value that is used to modify the opacity or coverage of
* every source pixel before it is used in the blending equations.
*
@ -52,7 +52,7 @@ import sun.java2d.SunCompositeContext;
* It is important to note that the equations defined by the Porter
* and Duff paper are all defined to operate on color components
* that are premultiplied by their corresponding alpha components.
* Since the <code>ColorModel</code> and <code>Raster</code> classes
* Since the {@code ColorModel} and {@code Raster} classes
* allow the storage of pixel data in either premultiplied or
* non-premultiplied form, all input data must be normalized into
* premultiplied form before applying the equations and all results
@ -96,7 +96,7 @@ import sun.java2d.SunCompositeContext;
* that specify visual effects.
* For example,
* the description for
* <a href="#SRC_OVER"><code>SRC_OVER</code></a>
* <a href="#SRC_OVER">{@code SRC_OVER}</a>
* specifies that <em>F<sub>s</sub></em> = 1 and <em>F<sub>d</sub></em> = (1-<em>A<sub>s</sub></em>).
* Once a set of equations for determining the blending factors is
* known they can then be applied to each pixel to produce a result
@ -128,12 +128,12 @@ import sun.java2d.SunCompositeContext;
* <h3>Preparing Inputs</h3>
*
* <p>
* The <code>AlphaComposite</code> class defines an additional alpha
* The {@code AlphaComposite} class defines an additional alpha
* value that is applied to the source alpha.
* This value is applied as if an implicit SRC_IN rule were first
* applied to the source pixel against a pixel with the indicated
* alpha by multiplying both the raw source alpha and the raw
* source colors by the alpha in the <code>AlphaComposite</code>.
* source colors by the alpha in the {@code AlphaComposite}.
* This leads to the following equation for producing the alpha
* used in the Porter and Duff blending equation:
*
@ -141,7 +141,7 @@ import sun.java2d.SunCompositeContext;
* <em>A<sub>s</sub></em> = <em>A<sub>sr</sub></em> * <em>A<sub>ac</sub></em> </pre>
*
* All of the raw source color components need to be multiplied
* by the alpha in the <code>AlphaComposite</code> instance.
* by the alpha in the {@code AlphaComposite} instance.
* Additionally, if the source was not in premultiplied form
* then the color components also need to be multiplied by the
* source alpha.
@ -196,11 +196,11 @@ import sun.java2d.SunCompositeContext;
*
* <p>
* For performance reasons, it is preferable that
* <code>Raster</code> objects passed to the <code>compose</code>
* {@code Raster} objects passed to the {@code compose}
* method of a {@link CompositeContext} object created by the
* <code>AlphaComposite</code> class have premultiplied data.
* If either the source <code>Raster</code>
* or the destination <code>Raster</code>
* {@code AlphaComposite} class have premultiplied data.
* If either the source {@code Raster}
* or the destination {@code Raster}
* is not premultiplied, however,
* appropriate conversions are performed before and after the compositing
* operation.
@ -210,7 +210,7 @@ import sun.java2d.SunCompositeContext;
* <ul>
* <li>
* Many sources, such as some of the opaque image types listed
* in the <code>BufferedImage</code> class, do not store alpha values
* in the {@code BufferedImage} class, do not store alpha values
* for their pixels. Such sources supply an alpha of 1.0 for
* all of their pixels.
*
@ -237,7 +237,7 @@ import sun.java2d.SunCompositeContext;
* that does not separately store
* color components is not a
* good candidate for any type of translucent blending.
* For example, <code>BufferedImage.TYPE_BYTE_INDEXED</code>
* For example, {@code BufferedImage.TYPE_BYTE_INDEXED}
* should not be used as a destination for a blending operation
* because every operation
* can introduce large errors, due to
@ -277,7 +277,7 @@ import sun.java2d.SunCompositeContext;
* <p>
* If integer math were being used and this value were being
* composited in
* <a href="#SRC"><code>SRC</code></a>
* <a href="#SRC">{@code SRC}</a>
* mode with no extra alpha, then the math would
* indicate that the results were (in integer format):
*
@ -510,21 +510,21 @@ public final class AlphaComposite implements Composite {
@Native public static final int XOR = 12;
/**
* <code>AlphaComposite</code> object that implements the opaque CLEAR rule
* {@code AlphaComposite} object that implements the opaque CLEAR rule
* with an alpha of 1.0f.
* @see #CLEAR
*/
public static final AlphaComposite Clear = new AlphaComposite(CLEAR);
/**
* <code>AlphaComposite</code> object that implements the opaque SRC rule
* {@code AlphaComposite} object that implements the opaque SRC rule
* with an alpha of 1.0f.
* @see #SRC
*/
public static final AlphaComposite Src = new AlphaComposite(SRC);
/**
* <code>AlphaComposite</code> object that implements the opaque DST rule
* {@code AlphaComposite} object that implements the opaque DST rule
* with an alpha of 1.0f.
* @see #DST
* @since 1.4
@ -532,49 +532,49 @@ public final class AlphaComposite implements Composite {
public static final AlphaComposite Dst = new AlphaComposite(DST);
/**
* <code>AlphaComposite</code> object that implements the opaque SRC_OVER rule
* {@code AlphaComposite} object that implements the opaque SRC_OVER rule
* with an alpha of 1.0f.
* @see #SRC_OVER
*/
public static final AlphaComposite SrcOver = new AlphaComposite(SRC_OVER);
/**
* <code>AlphaComposite</code> object that implements the opaque DST_OVER rule
* {@code AlphaComposite} object that implements the opaque DST_OVER rule
* with an alpha of 1.0f.
* @see #DST_OVER
*/
public static final AlphaComposite DstOver = new AlphaComposite(DST_OVER);
/**
* <code>AlphaComposite</code> object that implements the opaque SRC_IN rule
* {@code AlphaComposite} object that implements the opaque SRC_IN rule
* with an alpha of 1.0f.
* @see #SRC_IN
*/
public static final AlphaComposite SrcIn = new AlphaComposite(SRC_IN);
/**
* <code>AlphaComposite</code> object that implements the opaque DST_IN rule
* {@code AlphaComposite} object that implements the opaque DST_IN rule
* with an alpha of 1.0f.
* @see #DST_IN
*/
public static final AlphaComposite DstIn = new AlphaComposite(DST_IN);
/**
* <code>AlphaComposite</code> object that implements the opaque SRC_OUT rule
* {@code AlphaComposite} object that implements the opaque SRC_OUT rule
* with an alpha of 1.0f.
* @see #SRC_OUT
*/
public static final AlphaComposite SrcOut = new AlphaComposite(SRC_OUT);
/**
* <code>AlphaComposite</code> object that implements the opaque DST_OUT rule
* {@code AlphaComposite} object that implements the opaque DST_OUT rule
* with an alpha of 1.0f.
* @see #DST_OUT
*/
public static final AlphaComposite DstOut = new AlphaComposite(DST_OUT);
/**
* <code>AlphaComposite</code> object that implements the opaque SRC_ATOP rule
* {@code AlphaComposite} object that implements the opaque SRC_ATOP rule
* with an alpha of 1.0f.
* @see #SRC_ATOP
* @since 1.4
@ -582,7 +582,7 @@ public final class AlphaComposite implements Composite {
public static final AlphaComposite SrcAtop = new AlphaComposite(SRC_ATOP);
/**
* <code>AlphaComposite</code> object that implements the opaque DST_ATOP rule
* {@code AlphaComposite} object that implements the opaque DST_ATOP rule
* with an alpha of 1.0f.
* @see #DST_ATOP
* @since 1.4
@ -590,7 +590,7 @@ public final class AlphaComposite implements Composite {
public static final AlphaComposite DstAtop = new AlphaComposite(DST_ATOP);
/**
* <code>AlphaComposite</code> object that implements the opaque XOR rule
* {@code AlphaComposite} object that implements the opaque XOR rule
* with an alpha of 1.0f.
* @see #XOR
* @since 1.4
@ -620,11 +620,11 @@ public final class AlphaComposite implements Composite {
}
/**
* Creates an <code>AlphaComposite</code> object with the specified rule.
* Creates an {@code AlphaComposite} object with the specified rule.
*
* @param rule the compositing rule
* @return the {@code AlphaComposite} object created
* @throws IllegalArgumentException if <code>rule</code> is not one of
* @throws IllegalArgumentException if {@code rule} is not one of
* the following: {@link #CLEAR}, {@link #SRC}, {@link #DST},
* {@link #SRC_OVER}, {@link #DST_OVER}, {@link #SRC_IN},
* {@link #DST_IN}, {@link #SRC_OUT}, {@link #DST_OUT},
@ -662,19 +662,19 @@ public final class AlphaComposite implements Composite {
}
/**
* Creates an <code>AlphaComposite</code> object with the specified rule and
* Creates an {@code AlphaComposite} object with the specified rule and
* the constant alpha to multiply with the alpha of the source.
* The source is multiplied with the specified alpha before being composited
* with the destination.
*
* @param rule the compositing rule
* @param alpha the constant alpha to be multiplied with the alpha of
* the source. <code>alpha</code> must be a floating point number in the
* the source. {@code alpha} must be a floating point number in the
* inclusive range [0.0,&nbsp;1.0].
* @return the {@code AlphaComposite} object created
* @throws IllegalArgumentException if
* <code>alpha</code> is less than 0.0 or greater than 1.0, or if
* <code>rule</code> is not one of
* {@code alpha} is less than 0.0 or greater than 1.0, or if
* {@code rule} is not one of
* the following: {@link #CLEAR}, {@link #SRC}, {@link #DST},
* {@link #SRC_OVER}, {@link #DST_OVER}, {@link #SRC_IN},
* {@link #DST_IN}, {@link #SRC_OUT}, {@link #DST_OUT},
@ -692,8 +692,8 @@ public final class AlphaComposite implements Composite {
* The context contains state that is used in performing
* the compositing operation.
* @param srcColorModel the {@link ColorModel} of the source
* @param dstColorModel the <code>ColorModel</code> of the destination
* @return the <code>CompositeContext</code> object to be used to perform
* @param dstColorModel the {@code ColorModel} of the destination
* @return the {@code CompositeContext} object to be used to perform
* compositing operations.
*/
public CompositeContext createContext(ColorModel srcColorModel,
@ -703,32 +703,32 @@ public final class AlphaComposite implements Composite {
}
/**
* Returns the alpha value of this <code>AlphaComposite</code>. If this
* <code>AlphaComposite</code> does not have an alpha value, 1.0 is returned.
* @return the alpha value of this <code>AlphaComposite</code>.
* Returns the alpha value of this {@code AlphaComposite}. If this
* {@code AlphaComposite} does not have an alpha value, 1.0 is returned.
* @return the alpha value of this {@code AlphaComposite}.
*/
public float getAlpha() {
return extraAlpha;
}
/**
* Returns the compositing rule of this <code>AlphaComposite</code>.
* @return the compositing rule of this <code>AlphaComposite</code>.
* Returns the compositing rule of this {@code AlphaComposite}.
* @return the compositing rule of this {@code AlphaComposite}.
*/
public int getRule() {
return rule;
}
/**
* Returns a similar <code>AlphaComposite</code> object that uses
* Returns a similar {@code AlphaComposite} object that uses
* the specified compositing rule.
* If this object already uses the specified compositing rule,
* this object is returned.
* @return an <code>AlphaComposite</code> object derived from
* @return an {@code AlphaComposite} object derived from
* this object that uses the specified compositing rule.
* @param rule the compositing rule
* @throws IllegalArgumentException if
* <code>rule</code> is not one of
* {@code rule} is not one of
* the following: {@link #CLEAR}, {@link #SRC}, {@link #DST},
* {@link #SRC_OVER}, {@link #DST_OVER}, {@link #SRC_IN},
* {@link #DST_IN}, {@link #SRC_OUT}, {@link #DST_OUT},
@ -742,17 +742,17 @@ public final class AlphaComposite implements Composite {
}
/**
* Returns a similar <code>AlphaComposite</code> object that uses
* Returns a similar {@code AlphaComposite} object that uses
* the specified alpha value.
* If this object already has the specified alpha value,
* this object is returned.
* @return an <code>AlphaComposite</code> object derived from
* @return an {@code AlphaComposite} object derived from
* this object that uses the specified alpha value.
* @param alpha the constant alpha to be multiplied with the alpha of
* the source. <code>alpha</code> must be a floating point number in the
* the source. {@code alpha} must be a floating point number in the
* inclusive range [0.0,&nbsp;1.0].
* @throws IllegalArgumentException if
* <code>alpha</code> is less than 0.0 or greater than 1.0
* {@code alpha} is less than 0.0 or greater than 1.0
* @since 1.6
*/
public AlphaComposite derive(float alpha) {
@ -771,16 +771,16 @@ public final class AlphaComposite implements Composite {
/**
* Determines whether the specified object is equal to this
* <code>AlphaComposite</code>.
* {@code AlphaComposite}.
* <p>
* The result is <code>true</code> if and only if
* the argument is not <code>null</code> and is an
* <code>AlphaComposite</code> object that has the same
* The result is {@code true} if and only if
* the argument is not {@code null} and is an
* {@code AlphaComposite} object that has the same
* compositing rule and alpha value as this object.
*
* @param obj the <code>Object</code> to test for equality
* @return <code>true</code> if <code>obj</code> equals this
* <code>AlphaComposite</code>; <code>false</code> otherwise.
* @param obj the {@code Object} to test for equality
* @return {@code true} if {@code obj} equals this
* {@code AlphaComposite}; {@code false} otherwise.
*/
public boolean equals(Object obj) {
if (!(obj instanceof AlphaComposite)) {

138
jdk/src/java.desktop/share/classes/java/awt/BorderLayout.java
View file

@ -33,8 +33,8 @@ import java.util.Hashtable;
* north, south, east, west, and center.
* Each region may contain no more than one component, and
* is identified by a corresponding constant:
* <code>NORTH</code>, <code>SOUTH</code>, <code>EAST</code>,
* <code>WEST</code>, and <code>CENTER</code>. When adding a
* {@code NORTH}, {@code SOUTH}, {@code EAST},
* {@code WEST}, and {@code CENTER}. When adding a
* component to a container with a border layout, use one of these
* five constants, for example:
* <pre>
@ -42,55 +42,55 @@ import java.util.Hashtable;
* p.setLayout(new BorderLayout());
* p.add(new Button("Okay"), BorderLayout.SOUTH);
* </pre>
* As a convenience, <code>BorderLayout</code> interprets the
* As a convenience, {@code BorderLayout} interprets the
* absence of a string specification the same as the constant
* <code>CENTER</code>:
* {@code CENTER}:
* <pre>
* Panel p2 = new Panel();
* p2.setLayout(new BorderLayout());
* p2.add(new TextArea()); // Same as p.add(new TextArea(), BorderLayout.CENTER);
* </pre>
* <p>
* In addition, <code>BorderLayout</code> supports the relative
* positioning constants, <code>PAGE_START</code>, <code>PAGE_END</code>,
* <code>LINE_START</code>, and <code>LINE_END</code>.
* In a container whose <code>ComponentOrientation</code> is set to
* <code>ComponentOrientation.LEFT_TO_RIGHT</code>, these constants map to
* <code>NORTH</code>, <code>SOUTH</code>, <code>WEST</code>, and
* <code>EAST</code>, respectively.
* In addition, {@code BorderLayout} supports the relative
* positioning constants, {@code PAGE_START}, {@code PAGE_END},
* {@code LINE_START}, and {@code LINE_END}.
* In a container whose {@code ComponentOrientation} is set to
* {@code ComponentOrientation.LEFT_TO_RIGHT}, these constants map to
* {@code NORTH}, {@code SOUTH}, {@code WEST}, and
* {@code EAST}, respectively.
* <p>
* For compatibility with previous releases, <code>BorderLayout</code>
* also includes the relative positioning constants <code>BEFORE_FIRST_LINE</code>,
* <code>AFTER_LAST_LINE</code>, <code>BEFORE_LINE_BEGINS</code> and
* <code>AFTER_LINE_ENDS</code>. These are equivalent to
* <code>PAGE_START</code>, <code>PAGE_END</code>, <code>LINE_START</code>
* and <code>LINE_END</code> respectively. For
* For compatibility with previous releases, {@code BorderLayout}
* also includes the relative positioning constants {@code BEFORE_FIRST_LINE},
* {@code AFTER_LAST_LINE}, {@code BEFORE_LINE_BEGINS} and
* {@code AFTER_LINE_ENDS}. These are equivalent to
* {@code PAGE_START}, {@code PAGE_END}, {@code LINE_START}
* and {@code LINE_END} respectively. For
* consistency with the relative positioning constants used by other
* components, the latter constants are preferred.
* <p>
* Mixing both absolute and relative positioning constants can lead to
* unpredictable results. If
* you use both types, the relative constants will take precedence.
* For example, if you add components using both the <code>NORTH</code>
* and <code>PAGE_START</code> constants in a container whose
* orientation is <code>LEFT_TO_RIGHT</code>, only the
* <code>PAGE_START</code> will be laid out.
* For example, if you add components using both the {@code NORTH}
* and {@code PAGE_START} constants in a container whose
* orientation is {@code LEFT_TO_RIGHT}, only the
* {@code PAGE_START} will be laid out.
* <p>
* NOTE: Currently (in the Java 2 platform v1.2),
* <code>BorderLayout</code> does not support vertical
* orientations. The <code>isVertical</code> setting on the container's
* <code>ComponentOrientation</code> is not respected.
* {@code BorderLayout} does not support vertical
* orientations. The {@code isVertical} setting on the container's
* {@code ComponentOrientation} is not respected.
* <p>
* The components are laid out according to their
* preferred sizes and the constraints of the container's size.
* The <code>NORTH</code> and <code>SOUTH</code> components may
* be stretched horizontally; the <code>EAST</code> and
* <code>WEST</code> components may be stretched vertically;
* the <code>CENTER</code> component may stretch both horizontally
* The {@code NORTH} and {@code SOUTH} components may
* be stretched horizontally; the {@code EAST} and
* {@code WEST} components may be stretched vertically;
* the {@code CENTER} component may stretch both horizontally
* and vertically to fill any space left over.
* <p>
* Here is an example of five buttons in an applet laid out using
* the <code>BorderLayout</code> layout manager:
* the {@code BorderLayout} layout manager:
* <p>
* <img src="doc-files/BorderLayout-1.gif"
* alt="Diagram of an applet demonstrating BorderLayout.
@ -126,7 +126,7 @@ public class BorderLayout implements LayoutManager2,
/**
* Constructs a border layout with the horizontal gaps
* between components.
* The horizontal gap is specified by <code>hgap</code>.
* The horizontal gap is specified by {@code hgap}.
*
* @see #getHgap()
* @see #setHgap(int)
@ -138,7 +138,7 @@ public class BorderLayout implements LayoutManager2,
/**
* Constructs a border layout with the vertical gaps
* between components.
* The vertical gap is specified by <code>vgap</code>.
* The vertical gap is specified by {@code vgap}.
*
* @see #getVgap()
* @see #setVgap(int)
@ -208,10 +208,10 @@ public class BorderLayout implements LayoutManager2,
* north, south, east, west or center.
* mixing the two types of constants can lead to unpredictable results. If
* you use both types, the relative constants will take precedence.
* For example, if you add components using both the <code>NORTH</code>
* and <code>BEFORE_FIRST_LINE</code> constants in a container whose
* orientation is <code>LEFT_TO_RIGHT</code>, only the
* <code>BEFORE_FIRST_LINE</code> will be laid out.
* For example, if you add components using both the {@code NORTH}
* and {@code BEFORE_FIRST_LINE} constants in a container whose
* orientation is {@code LEFT_TO_RIGHT}, only the
* {@code BEFORE_FIRST_LINE} will be laid out.
* This will be the same for lastLine, firstItem, lastItem.
* @serial
*/
@ -355,8 +355,8 @@ public class BorderLayout implements LayoutManager2,
/**
* Constructs a border layout with the specified gaps
* between components.
* The horizontal gap is specified by <code>hgap</code>
* and the vertical gap is specified by <code>vgap</code>.
* The horizontal gap is specified by {@code hgap}
* and the vertical gap is specified by {@code vgap}.
* @param hgap the horizontal gap.
* @param vgap the vertical gap.
*/
@ -408,13 +408,13 @@ public class BorderLayout implements LayoutManager2,
/**
* Adds the specified component to the layout, using the specified
* constraint object. For border layouts, the constraint must be
* one of the following constants: <code>NORTH</code>,
* <code>SOUTH</code>, <code>EAST</code>,
* <code>WEST</code>, or <code>CENTER</code>.
* one of the following constants: {@code NORTH},
* {@code SOUTH}, {@code EAST},
* {@code WEST}, or {@code CENTER}.
* <p>
* Most applications do not call this method directly. This method
* is called when a component is added to a container using the
* <code>Container.add</code> method with the same argument types.
* {@code Container.add} method with the same argument types.
* @param comp the component to be added.
* @param constraints an object that specifies how and where
* the component is added to the layout.
@ -434,7 +434,7 @@ public class BorderLayout implements LayoutManager2,
}
/**
* @deprecated replaced by <code>addLayoutComponent(Component, Object)</code>.
* @deprecated replaced by {@code addLayoutComponent(Component, Object)}.
*/
@Deprecated
public void addLayoutComponent(String name, Component comp) {
@ -472,8 +472,8 @@ public class BorderLayout implements LayoutManager2,
/**
* Removes the specified component from this border layout. This
* method is called when a container calls its <code>remove</code> or
* <code>removeAll</code> methods. Most applications do not call this
* method is called when a container calls its {@code remove} or
* {@code removeAll} methods. Most applications do not call this
* method directly.
* @param comp the component to be removed.
* @see java.awt.Container#remove(java.awt.Component)
@ -507,12 +507,12 @@ public class BorderLayout implements LayoutManager2,
/**
* Gets the component that was added using the given constraint
*
* @param constraints the desired constraint, one of <code>CENTER</code>,
* <code>NORTH</code>, <code>SOUTH</code>,
* <code>WEST</code>, <code>EAST</code>,
* <code>PAGE_START</code>, <code>PAGE_END</code>,
* <code>LINE_START</code>, <code>LINE_END</code>
* @return the component at the given location, or <code>null</code> if
* @param constraints the desired constraint, one of {@code CENTER},
* {@code NORTH}, {@code SOUTH},
* {@code WEST}, {@code EAST},
* {@code PAGE_START}, {@code PAGE_END},
* {@code LINE_START}, {@code LINE_END}
* @return the component at the given location, or {@code null} if
* the location is empty
* @exception IllegalArgumentException if the constraint object is
* not one of the nine specified constants
@ -546,21 +546,21 @@ public class BorderLayout implements LayoutManager2,
/**
* Returns the component that corresponds to the given constraint location
* based on the target <code>Container</code>'s component orientation.
* Components added with the relative constraints <code>PAGE_START</code>,
* <code>PAGE_END</code>, <code>LINE_START</code>, and <code>LINE_END</code>
* based on the target {@code Container}'s component orientation.
* Components added with the relative constraints {@code PAGE_START},
* {@code PAGE_END}, {@code LINE_START}, and {@code LINE_END}
* take precedence over components added with the explicit constraints
* <code>NORTH</code>, <code>SOUTH</code>, <code>WEST</code>, and <code>EAST</code>.
* The <code>Container</code>'s component orientation is used to determine the location of components
* added with <code>LINE_START</code> and <code>LINE_END</code>.
* {@code NORTH}, {@code SOUTH}, {@code WEST}, and {@code EAST}.
* The {@code Container}'s component orientation is used to determine the location of components
* added with {@code LINE_START} and {@code LINE_END}.
*
* @param constraints the desired absolute position, one of <code>CENTER</code>,
* <code>NORTH</code>, <code>SOUTH</code>,
* <code>EAST</code>, <code>WEST</code>
* @param constraints the desired absolute position, one of {@code CENTER},
* {@code NORTH}, {@code SOUTH},
* {@code EAST}, {@code WEST}
* @param target the {@code Container} used to obtain
* the constraint location based on the target
* {@code Container}'s component orientation.
* @return the component at the given location, or <code>null</code> if
* @return the component at the given location, or {@code null} if
* the location is empty
* @exception IllegalArgumentException if the constraint object is
* not one of the five specified constants
@ -634,11 +634,11 @@ public class BorderLayout implements LayoutManager2,
}
/**
* Determines the minimum size of the <code>target</code> container
* Determines the minimum size of the {@code target} container
* using this layout manager.
* <p>
* This method is called when a container calls its
* <code>getMinimumSize</code> method. Most applications do not call
* {@code getMinimumSize} method. Most applications do not call
* this method directly.
* @param target the container in which to do the layout.
* @return the minimum dimensions needed to lay out the subcomponents
@ -689,12 +689,12 @@ public class BorderLayout implements LayoutManager2,
}
/**
* Determines the preferred size of the <code>target</code>
* Determines the preferred size of the {@code target}
* container using this layout manager, based on the components
* in the container.
* <p>
* Most applications do not call this method directly. This method
* is called when a container calls its <code>getPreferredSize</code>
* is called when a container calls its {@code getPreferredSize}
* method.
* @param target the container in which to do the layout.
* @return the preferred dimensions to lay out the subcomponents
@ -790,16 +790,16 @@ public class BorderLayout implements LayoutManager2,
* <p>
* This method actually reshapes the components in the specified
* container in order to satisfy the constraints of this
* <code>BorderLayout</code> object. The <code>NORTH</code>
* and <code>SOUTH</code> components, if any, are placed at
* {@code BorderLayout} object. The {@code NORTH}
* and {@code SOUTH} components, if any, are placed at
* the top and bottom of the container, respectively. The
* <code>WEST</code> and <code>EAST</code> components are
* {@code WEST} and {@code EAST} components are
* then placed on the left and right, respectively. Finally,
* the <code>CENTER</code> object is placed in any remaining
* the {@code CENTER} object is placed in any remaining
* space in the middle.
* <p>
* Most applications do not call this method directly. This method
* is called when a container calls its <code>doLayout</code> method.
* is called when a container calls its {@code doLayout} method.
* @param target the container in which to do the layout.
* @see java.awt.Container
* @see java.awt.Container#doLayout()

34
jdk/src/java.desktop/share/classes/java/awt/BufferCapabilities.java
View file

@ -42,13 +42,13 @@ public class BufferCapabilities implements Cloneable {
/**
* Creates a new object for specifying buffering capabilities
* @param frontCaps the capabilities of the front buffer; cannot be
* <code>null</code>
* {@code null}
* @param backCaps the capabilities of the back and intermediate buffers;
* cannot be <code>null</code>
* cannot be {@code null}
* @param flipContents the contents of the back buffer after page-flipping,
* <code>null</code> if page flipping is not used (implies blitting)
* {@code null} if page flipping is not used (implies blitting)
* @exception IllegalArgumentException if frontCaps or backCaps are
* <code>null</code>
* {@code null}
*/
public BufferCapabilities(ImageCapabilities frontCaps,
ImageCapabilities backCaps, FlipContents flipContents) {
@ -83,8 +83,8 @@ public class BufferCapabilities implements Cloneable {
* more back buffers by switching the video pointer (or by copying memory
* internally). A non-flipping set of
* buffers uses blitting to copy the contents from one buffer to
* another; when this is the case, <code>getFlipContents</code> returns
* <code>null</code>
* another; when this is the case, {@code getFlipContents} returns
* {@code null}
*/
public boolean isPageFlipping() {
return (getFlipContents() != null);
@ -92,12 +92,12 @@ public class BufferCapabilities implements Cloneable {
/**
* @return the resulting contents of the back buffer after page-flipping.
* This value is <code>null</code> when the <code>isPageFlipping</code>
* returns <code>false</code>, implying blitting. It can be one of
* <code>FlipContents.UNDEFINED</code>
* (the assumed default), <code>FlipContents.BACKGROUND</code>,
* <code>FlipContents.PRIOR</code>, or
* <code>FlipContents.COPIED</code>.
* This value is {@code null} when the {@code isPageFlipping}
* returns {@code false}, implying blitting. It can be one of
* {@code FlipContents.UNDEFINED}
* (the assumed default), {@code FlipContents.BACKGROUND},
* {@code FlipContents.PRIOR}, or
* {@code FlipContents.COPIED}.
* @see #isPageFlipping
* @see FlipContents#UNDEFINED
* @see FlipContents#BACKGROUND
@ -110,7 +110,7 @@ public class BufferCapabilities implements Cloneable {
/**
* @return whether page flipping is only available in full-screen mode. If this
* is <code>true</code>, full-screen exclusive mode is required for
* is {@code true}, full-screen exclusive mode is required for
* page-flipping.
* @see #isPageFlipping
* @see GraphicsDevice#setFullScreenWindow
@ -158,7 +158,7 @@ public class BufferCapabilities implements Cloneable {
{ "undefined", "background", "prior", "copied" };
/**
* When flip contents are <code>UNDEFINED</code>, the
* When flip contents are {@code UNDEFINED}, the
* contents of the back buffer are undefined after flipping.
* @see #isPageFlipping
* @see #getFlipContents
@ -170,7 +170,7 @@ public class BufferCapabilities implements Cloneable {
new FlipContents(I_UNDEFINED);
/**
* When flip contents are <code>BACKGROUND</code>, the
* When flip contents are {@code BACKGROUND}, the
* contents of the back buffer are cleared with the background color after
* flipping.
* @see #isPageFlipping
@ -183,7 +183,7 @@ public class BufferCapabilities implements Cloneable {
new FlipContents(I_BACKGROUND);
/**
* When flip contents are <code>PRIOR</code>, the
* When flip contents are {@code PRIOR}, the
* contents of the back buffer are the prior contents of the front buffer
* (a true page flip).
* @see #isPageFlipping
@ -196,7 +196,7 @@ public class BufferCapabilities implements Cloneable {
new FlipContents(I_PRIOR);
/**
* When flip contents are <code>COPIED</code>, the
* When flip contents are {@code COPIED}, the
* contents of the back buffer are copied to the front buffer when
* flipping.
* @see #isPageFlipping

110
jdk/src/java.desktop/share/classes/java/awt/Button.java
View file

@ -37,7 +37,7 @@ import javax.accessibility.*;
/**
* This class creates a labeled button. The application can cause
* some action to happen when the button is pushed. This image
* depicts three views of a "<code>Quit</code>" button as it appears
* depicts three views of a "{@code Quit}" button as it appears
* under the Solaris operating system:
* <p>
* <img src="doc-files/Button-1.gif" alt="The following context describes the graphic"
@ -51,31 +51,31 @@ import javax.accessibility.*;
* requests that an action be performed.
* <p>
* The gesture of clicking on a button with the mouse
* is associated with one instance of <code>ActionEvent</code>,
* is associated with one instance of {@code ActionEvent},
* which is sent out when the mouse is both pressed and released
* over the button. If an application is interested in knowing
* when the button has been pressed but not released, as a separate
* gesture, it can specialize <code>processMouseEvent</code>,
* gesture, it can specialize {@code processMouseEvent},
* or it can register itself as a listener for mouse events by
* calling <code>addMouseListener</code>. Both of these methods are
* defined by <code>Component</code>, the abstract superclass of
* calling {@code addMouseListener}. Both of these methods are
* defined by {@code Component}, the abstract superclass of
* all components.
* <p>
* When a button is pressed and released, AWT sends an instance
* of <code>ActionEvent</code> to the button, by calling
* <code>processEvent</code> on the button. The button's
* <code>processEvent</code> method receives all events
* of {@code ActionEvent} to the button, by calling
* {@code processEvent} on the button. The button's
* {@code processEvent} method receives all events
* for the button; it passes an action event along by
* calling its own <code>processActionEvent</code> method.
* calling its own {@code processActionEvent} method.
* The latter method passes the action event on to any action
* listeners that have registered an interest in action
* events generated by this button.
* <p>
* If an application wants to perform some action based on
* a button being pressed and released, it should implement
* <code>ActionListener</code> and register the new listener
* {@code ActionListener} and register the new listener
* to receive events from this button, by calling the button's
* <code>addActionListener</code> method. The application can
* {@code addActionListener} method. The application can
* make use of the button's action command as a messaging protocol.
*
* @author Sami Shaio
@ -144,7 +144,7 @@ public class Button extends Component implements Accessible {
* Constructs a button with the specified label.
*
* @param label a string label for the button, or
* <code>null</code> for no label
* {@code null} for no label
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true
* @see java.awt.GraphicsEnvironment#isHeadless
@ -182,7 +182,7 @@ public class Button extends Component implements Accessible {
/**
* Gets the label of this button.
*
* @return the button's label, or <code>null</code>
* @return the button's label, or {@code null}
* if the button has no label.
* @see java.awt.Button#setLabel
*/
@ -193,7 +193,7 @@ public class Button extends Component implements Accessible {
/**
* Sets the button's label to be the specified string.
*
* @param label the new label, or <code>null</code>
* @param label the new label, or {@code null}
* if the button has no label.
* @see java.awt.Button#getLabel
*/
@ -225,7 +225,7 @@ public class Button extends Component implements Accessible {
*
* @param command a string used to set the button's
* action command.
* If the string is <code>null</code> then the action command
* If the string is {@code null} then the action command
* is set to match the label of the button.
* @see java.awt.event.ActionEvent
* @since 1.1
@ -236,7 +236,7 @@ public class Button extends Component implements Accessible {
/**
* Returns the command name of the action event fired by this button.
* If the command name is <code>null</code> (default) then this method
* If the command name is {@code null} (default) then this method
* returns the label of the button.
*
* @return the action command name (or label) for this button
@ -292,7 +292,7 @@ public class Button extends Component implements Accessible {
* Returns an array of all the action listeners
* registered on this button.
*
* @return all of this button's <code>ActionListener</code>s
* @return all of this button's {@code ActionListener}s
* or an empty array if no action
* listeners are currently registered
*
@ -308,16 +308,16 @@ public class Button extends Component implements Accessible {
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
* upon this <code>Button</code>.
* upon this {@code Button}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
*
* <p>
* You can specify the <code>listenerType</code> argument
* You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
* <code>Button</code> <code>b</code>
* {@code Button b}
* for its action listeners with the following code:
*
* <pre>ActionListener[] als = (ActionListener[])(b.getListeners(ActionListener.class));</pre>
@ -326,14 +326,14 @@ public class Button extends Component implements Accessible {
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this button,
* or an empty array if no such
* listeners have been added
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
*
* @see #getActionListeners
* @since 1.3
@ -362,10 +362,10 @@ public class Button extends Component implements Accessible {
/**
* Processes events on this button. If an event is
* an instance of <code>ActionEvent</code>, this method invokes
* the <code>processActionEvent</code> method. Otherwise,
* it invokes <code>processEvent</code> on the superclass.
* <p>Note that if the event parameter is <code>null</code>
* an instance of {@code ActionEvent}, this method invokes
* the {@code processActionEvent} method. Otherwise,
* it invokes {@code processEvent} on the superclass.
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -385,17 +385,17 @@ public class Button extends Component implements Accessible {
/**
* Processes action events occurring on this button
* by dispatching them to any registered
* <code>ActionListener</code> objects.
* {@code ActionListener} objects.
* <p>
* This method is not called unless action events are
* enabled for this button. Action events are enabled
* when one of the following occurs:
* <ul>
* <li>An <code>ActionListener</code> object is registered
* via <code>addActionListener</code>.
* <li>Action events are enabled via <code>enableEvents</code>.
* <li>An {@code ActionListener} object is registered
* via {@code addActionListener}.
* <li>Action events are enabled via {@code enableEvents}.
* </ul>
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -413,11 +413,11 @@ public class Button extends Component implements Accessible {
}
/**
* Returns a string representing the state of this <code>Button</code>.
* Returns a string representing the state of this {@code Button}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this button
*/
@ -437,19 +437,19 @@ public class Button extends Component implements Accessible {
/**
* Writes default serializable fields to stream. Writes
* a list of serializable <code>ActionListeners</code>
* a list of serializable {@code ActionListeners}
* as optional data. The non-serializable
* <code>ActionListeners</code> are detected and
* {@code ActionListeners} are detected and
* no attempt is made to serialize them.
*
* @serialData <code>null</code> terminated sequence of 0 or
* more pairs: the pair consists of a <code>String</code>
* and an <code>Object</code>; the <code>String</code>
* @serialData {@code null} terminated sequence of 0 or
* more pairs: the pair consists of a {@code String}
* and an {@code Object}; the {@code String}
* indicates the type of object and is one of the following:
* <code>actionListenerK</code> indicating an
* <code>ActionListener</code> object
* {@code actionListenerK} indicating an
* {@code ActionListener} object
*
* @param s the <code>ObjectOutputStream</code> to write
* @param s the {@code ObjectOutputStream} to write
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#actionListenerK
* @see #readObject(ObjectInputStream)
@ -464,15 +464,15 @@ public class Button extends Component implements Accessible {
}
/**
* Reads the <code>ObjectInputStream</code> and if
* it isn't <code>null</code> adds a listener to
* Reads the {@code ObjectInputStream} and if
* it isn't {@code null} adds a listener to
* receive action events fired by the button.
* Unrecognized keys or values will be ignored.
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code> returns
* <code>true</code>
* {@code GraphicsEnvironment.isHeadless} returns
* {@code true}
* @serial
* @see #removeActionListener(ActionListener)
* @see #addActionListener(ActionListener)
@ -503,15 +503,15 @@ public class Button extends Component implements Accessible {
////////////////
/**
* Gets the <code>AccessibleContext</code> associated with
* this <code>Button</code>. For buttons, the
* <code>AccessibleContext</code> takes the form of an
* <code>AccessibleAWTButton</code>.
* A new <code>AccessibleAWTButton</code> instance is
* Gets the {@code AccessibleContext} associated with
* this {@code Button}. For buttons, the
* {@code AccessibleContext} takes the form of an
* {@code AccessibleAWTButton}.
* A new {@code AccessibleAWTButton} instance is
* created if necessary.
*
* @return an <code>AccessibleAWTButton</code> that serves as the
* <code>AccessibleContext</code> of this <code>Button</code>
* @return an {@code AccessibleAWTButton} that serves as the
* {@code AccessibleContext} of this {@code Button}
* @since 1.3
*/
@BeanProperty(expert = true, description
@ -525,7 +525,7 @@ public class Button extends Component implements Accessible {
/**
* This class implements accessibility support for the
* <code>Button</code> class. It provides an implementation of the
* {@code Button} class. It provides an implementation of the
* Java Accessibility API appropriate to button user-interface elements.
* @since 1.3
*/

24
jdk/src/java.desktop/share/classes/java/awt/Canvas.java
View file

@ -29,13 +29,13 @@ import java.awt.peer.CanvasPeer;
import javax.accessibility.*;
/**
* A <code>Canvas</code> component represents a blank rectangular
* A {@code Canvas} component represents a blank rectangular
* area of the screen onto which the application can draw or from
* which the application can trap input events from the user.
* <p>
* An application must subclass the <code>Canvas</code> class in
* An application must subclass the {@code Canvas} class in
* order to get useful functionality such as creating a custom
* component. The <code>paint</code> method must be overridden
* component. The {@code paint} method must be overridden
* in order to perform custom graphics on the canvas.
*
* @author Sami Shaio
@ -108,7 +108,7 @@ public class Canvas extends Component implements Accessible {
/**
* Paints this canvas.
* <p>
* Most applications that subclass <code>Canvas</code> should
* Most applications that subclass {@code Canvas} should
* override this method in order to perform some useful operation
* (typically, custom painting of the canvas).
* The default operation is simply to clear the canvas.
@ -126,10 +126,10 @@ public class Canvas extends Component implements Accessible {
/**
* Updates this canvas.
* <p>
* This method is called in response to a call to <code>repaint</code>.
* This method is called in response to a call to {@code repaint}.
* The canvas is first cleared by filling it with the background
* color, and then completely redrawn by calling this canvas's
* <code>paint</code> method.
* {@code paint} method.
* Note: applications that override this method should either call
* super.update(g) or incorporate the functionality described
* above into their own code.
@ -151,7 +151,7 @@ public class Canvas extends Component implements Accessible {
* Creates a new strategy for multi-buffering on this component.
* Multi-buffering is useful for rendering performance. This method
* attempts to create the best strategy available with the number of
* buffers supplied. It will always create a <code>BufferStrategy</code>
* buffers supplied. It will always create a {@code BufferStrategy}
* with that number of buffers.
* A page-flipping strategy is attempted first, then a blitting strategy
* using accelerated buffers. Finally, an unaccelerated blitting
@ -180,13 +180,13 @@ public class Canvas extends Component implements Accessible {
* is called, the existing buffer strategy for this component is discarded.
* @param numBuffers number of buffers to create
* @param caps the required capabilities for creating the buffer strategy;
* cannot be <code>null</code>
* cannot be {@code null}
* @exception AWTException if the capabilities supplied could not be
* supported or met; this may happen, for example, if there is not enough
* accelerated memory currently available, or if page flipping is specified
* but not possible.
* @exception IllegalArgumentException if numBuffers is less than 1, or if
* caps is <code>null</code>
* caps is {@code null}
* @see #getBufferStrategy
* @since 1.4
*/
@ -196,8 +196,8 @@ public class Canvas extends Component implements Accessible {
}
/**
* Returns the <code>BufferStrategy</code> used by this component. This
* method will return null if a <code>BufferStrategy</code> has not yet
* Returns the {@code BufferStrategy} used by this component. This
* method will return null if a {@code BufferStrategy} has not yet
* been created or has been disposed.
*
* @return the buffer strategy used by this component
@ -232,7 +232,7 @@ public class Canvas extends Component implements Accessible {
/**
* This class implements accessibility support for the
* <code>Canvas</code> class. It provides an implementation of the
* {@code Canvas} class. It provides an implementation of the
* Java Accessibility API appropriate to canvas user-interface elements.
* @since 1.3
*/

16
jdk/src/java.desktop/share/classes/java/awt/CardLayout.java
View file

@ -36,15 +36,15 @@ import java.io.ObjectStreamField;
import java.io.IOException;
/**
* A <code>CardLayout</code> object is a layout manager for a
* A {@code CardLayout} object is a layout manager for a
* container. It treats each component in the container as a card.
* Only one card is visible at a time, and the container acts as
* a stack of cards. The first component added to a
* <code>CardLayout</code> object is the visible component when the
* {@code CardLayout} object is the visible component when the
* container is first displayed.
* <p>
* The ordering of cards is determined by the container's own internal
* ordering of its component objects. <code>CardLayout</code>
* ordering of its component objects. {@code CardLayout}
* defines a set of methods that allow an application to flip
* through these cards sequentially, or to show a specified card.
* The {@link CardLayout#addLayoutComponent}
@ -188,10 +188,10 @@ public class CardLayout implements LayoutManager2,
/**
* Adds the specified component to this card layout's internal
* table of names. The object specified by <code>constraints</code>
* table of names. The object specified by {@code constraints}
* must be a string. The card layout stores this string as a key-value
* pair that can be used for random access to a particular card.
* By calling the <code>show</code> method, an application can
* By calling the {@code show} method, an application can
* display the component with the specified name.
* @param comp the component to be added.
* @param constraints a tag that identifies a particular
@ -214,7 +214,7 @@ public class CardLayout implements LayoutManager2,
/**
* @deprecated replaced by
* <code>addLayoutComponent(Component, Object)</code>.
* {@code addLayoutComponent(Component, Object)}.
*/
@Deprecated
public void addLayoutComponent(String name, Component comp) {
@ -365,7 +365,7 @@ public class CardLayout implements LayoutManager2,
/**
* Lays out the specified container using this card layout.
* <p>
* Each component in the <code>parent</code> container is reshaped
* Each component in the {@code parent} container is reshaped
* to be the size of the container, minus space for surrounding
* insets, horizontal gaps, and vertical gaps.
*
@ -515,7 +515,7 @@ public class CardLayout implements LayoutManager2,
/**
* Flips to the component that was added to this layout with the
* specified <code>name</code>, using <code>addLayoutComponent</code>.
* specified {@code name}, using {@code addLayoutComponent}.
* If no such component exists, then nothing happens.
* @param parent the parent container in which to do the layout
* @param name the component name

134
jdk/src/java.desktop/share/classes/java/awt/Checkbox.java
View file

@ -35,7 +35,7 @@ import javax.accessibility.*;
/**
* A check box is a graphical component that can be in either an
* "on" (<code>true</code>) or "off" (<code>false</code>) state.
* "on" ({@code true}) or "off" ({@code false}) state.
* Clicking on a check box changes its state from
* "on" to "off," or from "off" to "on."
* <p>
@ -55,14 +55,14 @@ import javax.accessibility.*;
* <img src="doc-files/Checkbox-1.gif" alt="The following context describes the graphic."
* style="float:center; margin: 7px 10px;">
* <p>
* The button labeled <code>one</code> is in the "on" state, and the
* The button labeled {@code one} is in the "on" state, and the
* other two are in the "off" state. In this example, which uses the
* <code>GridLayout</code> class, the states of the three check
* {@code GridLayout} class, the states of the three check
* boxes are set independently.
* <p>
* Alternatively, several check boxes can be grouped together under
* the control of a single object, using the
* <code>CheckboxGroup</code> class.
* {@code CheckboxGroup} class.
* In a check box group, at most one button can be in the "on"
* state at any given time. Clicking on a check box to turn it on
* forces any other check box in the same group that is on
@ -93,7 +93,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
String label;
/**
* The state of the <code>Checkbox</code>.
* The state of the {@code Checkbox}.
* @serial
* @see #getState()
* @see #setState(boolean)
@ -150,10 +150,10 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* any check box group.
*
* @param label a string label for this check box,
* or <code>null</code> for no label.
* or {@code null} for no label.
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
*/
public Checkbox(String label) throws HeadlessException {
@ -166,11 +166,11 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* This check box is not part of any check box group.
*
* @param label a string label for this check box,
* or <code>null</code> for no label
* or {@code null} for no label
* @param state the initial state of this check box
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
*/
public Checkbox(String label, boolean state) throws HeadlessException {
@ -182,13 +182,13 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* specified state, and in the specified check box group.
*
* @param label a string label for this check box,
* or <code>null</code> for no label.
* or {@code null} for no label.
* @param state the initial state of this check box.
* @param group a check box group for this check box,
* or <code>null</code> for no group.
* or {@code null} for no group.
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.1
*/
@ -208,13 +208,13 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* check box group, and set to the specified state.
*
* @param label a string label for this check box,
* or <code>null</code> for no label.
* or {@code null} for no label.
* @param group a check box group for this check box,
* or <code>null</code> for no group.
* or {@code null} for no group.
* @param state the initial state of this check box.
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.1
*/
@ -225,7 +225,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Constructs a name for this component. Called by
* <code>getName</code> when the name is <code>null</code>.
* {@code getName} when the name is {@code null}.
*
* @return a name for this component
*/
@ -252,7 +252,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Gets the label of this check box.
*
* @return the label of this check box, or <code>null</code>
* @return the label of this check box, or {@code null}
* if this check box has no label.
* @see #setLabel(String)
*/
@ -264,7 +264,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* Sets this check box's label to be the string argument.
*
* @param label a string to set as the new label, or
* <code>null</code> for no label.
* {@code null} for no label.
* @see #getLabel
*/
public void setLabel(String label) {
@ -290,8 +290,8 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Determines whether this check box is in the "on" or "off" state.
* The boolean value <code>true</code> indicates the "on" state,
* and <code>false</code> indicates the "off" state.
* The boolean value {@code true} indicates the "on" state,
* and {@code false} indicates the "off" state.
*
* @return the state of this check box, as a boolean value
* @see #setState
@ -302,14 +302,14 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Sets the state of this check box to the specified state.
* The boolean value <code>true</code> indicates the "on" state,
* and <code>false</code> indicates the "off" state.
* The boolean value {@code true} indicates the "on" state,
* and {@code false} indicates the "off" state.
*
* <p>Note that this method should be primarily used to
* initialize the state of the checkbox. Programmatically
* setting the state of the checkbox will <i>not</i> trigger
* an <code>ItemEvent</code>. The only way to trigger an
* <code>ItemEvent</code> is by user interaction.
* an {@code ItemEvent}. The only way to trigger an
* {@code ItemEvent} is by user interaction.
*
* @param state the boolean state of the check box
* @see #getState
@ -343,7 +343,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Determines this check box's group.
* @return this check box's group, or <code>null</code>
* @return this check box's group, or {@code null}
* if the check box is not part of a check box group.
* @see #setCheckboxGroup(CheckboxGroup)
*/
@ -356,14 +356,14 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* If this check box is already in a different check box group,
* it is first taken out of that group.
* <p>
* If the state of this check box is <code>true</code> and the new
* If the state of this check box is {@code true} and the new
* group already has a check box selected, this check box's state
* is changed to <code>false</code>. If the state of this check
* box is <code>true</code> and the new group has no check box
* is changed to {@code false}. If the state of this check
* box is {@code true} and the new group has no check box
* selected, this check box becomes the selected checkbox for
* the new group and its state is <code>true</code>.
* the new group and its state is {@code true}.
*
* @param g the new check box group, or <code>null</code>
* @param g the new check box group, or {@code null}
* to remove this check box from any check box group
* @see #getCheckboxGroup
*/
@ -458,7 +458,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
* Returns an array of all the item listeners
* registered on this checkbox.
*
* @return all of this checkbox's <code>ItemListener</code>s
* @return all of this checkbox's {@code ItemListener}s
* or an empty array if no item
* listeners are currently registered
*
@ -475,16 +475,16 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
* upon this <code>Checkbox</code>.
* upon this {@code Checkbox}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
*
* <p>
* You can specify the <code>listenerType</code> argument
* You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
* <code>Checkbox</code> <code>c</code>
* {@code Checkbox c}
* for its item listeners with the following code:
*
* <pre>ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));</pre>
@ -493,14 +493,14 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this checkbox,
* or an empty array if no such
* listeners have been added
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
*
* @see #getItemListeners
* @since 1.3
@ -529,10 +529,10 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Processes events on this check box.
* If the event is an instance of <code>ItemEvent</code>,
* this method invokes the <code>processItemEvent</code> method.
* Otherwise, it calls its superclass's <code>processEvent</code> method.
* <p>Note that if the event parameter is <code>null</code>
* If the event is an instance of {@code ItemEvent},
* this method invokes the {@code processItemEvent} method.
* Otherwise, it calls its superclass's {@code processEvent} method.
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -552,17 +552,17 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Processes item events occurring on this check box by
* dispatching them to any registered
* <code>ItemListener</code> objects.
* {@code ItemListener} objects.
* <p>
* This method is not called unless item events are
* enabled for this component. Item events are enabled
* when one of the following occurs:
* <ul>
* <li>An <code>ItemListener</code> object is registered
* via <code>addItemListener</code>.
* <li>Item events are enabled via <code>enableEvents</code>.
* <li>An {@code ItemListener} object is registered
* via {@code addItemListener}.
* <li>Item events are enabled via {@code enableEvents}.
* </ul>
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -581,11 +581,11 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
}
/**
* Returns a string representing the state of this <code>Checkbox</code>.
* Returns a string representing the state of this {@code Checkbox}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this check box
*/
@ -610,18 +610,18 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* Writes default serializable fields to stream. Writes
* a list of serializable <code>ItemListeners</code>
* a list of serializable {@code ItemListeners}
* as optional data. The non-serializable
* <code>ItemListeners</code> are detected and
* {@code ItemListeners} are detected and
* no attempt is made to serialize them.
*
* @param s the <code>ObjectOutputStream</code> to write
* @serialData <code>null</code> terminated sequence of 0
* or more pairs; the pair consists of a <code>String</code>
* and an <code>Object</code>; the <code>String</code> indicates
* @param s the {@code ObjectOutputStream} to write
* @serialData {@code null} terminated sequence of 0
* or more pairs; the pair consists of a {@code String}
* and an {@code Object}; the {@code String} indicates
* the type of object and is one of the following:
* <code>itemListenerK</code> indicating an
* <code>ItemListener</code> object
* {@code itemListenerK} indicating an
* {@code ItemListener} object
*
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#itemListenerK
@ -637,15 +637,15 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
}
/**
* Reads the <code>ObjectInputStream</code> and if it
* isn't <code>null</code> adds a listener to receive
* item events fired by the <code>Checkbox</code>.
* Reads the {@code ObjectInputStream} and if it
* isn't {@code null} adds a listener to receive
* item events fired by the {@code Checkbox}.
* Unrecognized keys or values will be ignored.
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code> returns
* <code>true</code>
* {@code GraphicsEnvironment.isHeadless} returns
* {@code true}
* @serial
* @see #removeItemListener(ItemListener)
* @see #addItemListener(ItemListener)
@ -700,7 +700,7 @@ public class Checkbox extends Component implements ItemSelectable, Accessible {
/**
* This class implements accessibility support for the
* <code>Checkbox</code> class. It provides an implementation of the
* {@code Checkbox} class. It provides an implementation of the
* Java Accessibility API appropriate to checkbox user-interface elements.
* @since 1.3
*/

98
jdk/src/java.desktop/share/classes/java/awt/CheckboxMenuItem.java
View file

@ -40,20 +40,20 @@ import sun.awt.AWTAccessor;
* "on" to "off" or from "off" to "on."
* <p>
* The following picture depicts a menu which contains an instance
* of <code>CheckBoxMenuItem</code>:
* of {@code CheckBoxMenuItem}:
* <p>
* <img src="doc-files/MenuBar-1.gif"
* alt="Menu labeled Examples, containing items Basic, Simple, Check, and More Examples. The Check item is a CheckBoxMenuItem instance, in the off state."
* style="float:center; margin: 7px 10px;">
* <p>
* The item labeled <code>Check</code> shows a check box menu item
* The item labeled {@code Check} shows a check box menu item
* in its "off" state.
* <p>
* When a check box menu item is selected, AWT sends an item event to
* the item. Since the event is an instance of <code>ItemEvent</code>,
* the <code>processEvent</code> method examines the event and passes
* it along to <code>processItemEvent</code>. The latter method redirects
* the event to any <code>ItemListener</code> objects that have
* the item. Since the event is an instance of {@code ItemEvent},
* the {@code processEvent} method examines the event and passes
* it along to {@code processItemEvent}. The latter method redirects
* the event to any {@code ItemListener} objects that have
* registered an interest in item events generated by this menu item.
*
* @author Sami Shaio
@ -113,7 +113,7 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
* The item's state is initially set to "off."
* @param label a string label for the check box menu item,
* or <code>null</code> for an unlabeled menu item.
* or {@code null} for an unlabeled menu item.
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true
* @see java.awt.GraphicsEnvironment#isHeadless
@ -125,10 +125,10 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Create a check box menu item with the specified label and state.
* @param label a string label for the check box menu item,
* or <code>null</code> for an unlabeled menu item.
* or {@code null} for an unlabeled menu item.
* @param state the initial state of the menu item, where
* <code>true</code> indicates "on" and
* <code>false</code> indicates "off."
* {@code true} indicates "on" and
* {@code false} indicates "off."
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true
* @see java.awt.GraphicsEnvironment#isHeadless
@ -170,8 +170,8 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
* is "on" or "off."
*
* @return the state of this check box menu item, where
* <code>true</code> indicates "on" and
* <code>false</code> indicates "off"
* {@code true} indicates "on" and
* {@code false} indicates "off"
* @see #setState
*/
public boolean getState() {
@ -180,18 +180,18 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Sets this check box menu item to the specified state.
* The boolean value <code>true</code> indicates "on" while
* <code>false</code> indicates "off."
* The boolean value {@code true} indicates "on" while
* {@code false} indicates "off."
*
* <p>Note that this method should be primarily used to
* initialize the state of the check box menu item.
* Programmatically setting the state of the check box
* menu item will <i>not</i> trigger
* an <code>ItemEvent</code>. The only way to trigger an
* <code>ItemEvent</code> is by user interaction.
* an {@code ItemEvent}. The only way to trigger an
* {@code ItemEvent} is by user interaction.
*
* @param b <code>true</code> if the check box
* menu item is on, otherwise <code>false</code>
* @param b {@code true} if the check box
* menu item is on, otherwise {@code false}
* @see #getState
*/
public synchronized void setState(boolean b) {
@ -265,7 +265,7 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
* Returns an array of all the item listeners
* registered on this checkbox menuitem.
*
* @return all of this checkbox menuitem's <code>ItemListener</code>s
* @return all of this checkbox menuitem's {@code ItemListener}s
* or an empty array if no item
* listeners are currently registered
*
@ -282,16 +282,16 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
* upon this <code>CheckboxMenuItem</code>.
* upon this {@code CheckboxMenuItem}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
*
* <p>
* You can specify the <code>listenerType</code> argument
* You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
* <code>CheckboxMenuItem</code> <code>c</code>
* {@code CheckboxMenuItem c}
* for its item listeners with the following code:
*
* <pre>ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));</pre>
@ -300,14 +300,14 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this checkbox menuitem,
* or an empty array if no such
* listeners have been added
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
*
* @see #getItemListeners
* @since 1.3
@ -336,13 +336,13 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Processes events on this check box menu item.
* If the event is an instance of <code>ItemEvent</code>,
* this method invokes the <code>processItemEvent</code> method.
* If the event is an instance of {@code ItemEvent},
* this method invokes the {@code processItemEvent} method.
* If the event is not an item event,
* it invokes <code>processEvent</code> on the superclass.
* it invokes {@code processEvent} on the superclass.
* <p>
* Check box menu items currently support only item events.
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -361,17 +361,17 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Processes item events occurring on this check box menu item by
* dispatching them to any registered <code>ItemListener</code> objects.
* dispatching them to any registered {@code ItemListener} objects.
* <p>
* This method is not called unless item events are
* enabled for this menu item. Item events are enabled
* when one of the following occurs:
* <ul>
* <li>An <code>ItemListener</code> object is registered
* via <code>addItemListener</code>.
* <li>Item events are enabled via <code>enableEvents</code>.
* <li>An {@code ItemListener} object is registered
* via {@code addItemListener}.
* <li>Item events are enabled via {@code enableEvents}.
* </ul>
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -403,11 +403,11 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Returns a string representing the state of this
* <code>CheckBoxMenuItem</code>. This
* {@code CheckBoxMenuItem}. This
* method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this check box menu item
*/
@ -426,18 +426,18 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
/**
* Writes default serializable fields to stream. Writes
* a list of serializable <code>ItemListeners</code>
* a list of serializable {@code ItemListeners}
* as optional data. The non-serializable
* <code>ItemListeners</code> are detected and
* {@code ItemListeners} are detected and
* no attempt is made to serialize them.
*
* @param s the <code>ObjectOutputStream</code> to write
* @serialData <code>null</code> terminated sequence of
* 0 or more pairs; the pair consists of a <code>String</code>
* and an <code>Object</code>; the <code>String</code> indicates
* @param s the {@code ObjectOutputStream} to write
* @serialData {@code null} terminated sequence of
* 0 or more pairs; the pair consists of a {@code String}
* and an {@code Object}; the {@code String} indicates
* the type of object and is one of the following:
* <code>itemListenerK</code> indicating an
* <code>ItemListener</code> object
* {@code itemListenerK} indicating an
* {@code ItemListener} object
*
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#itemListenerK
@ -453,12 +453,12 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
}
/*
* Reads the <code>ObjectInputStream</code> and if it
* isn't <code>null</code> adds a listener to receive
* item events fired by the <code>Checkbox</code> menu item.
* Reads the {@code ObjectInputStream} and if it
* isn't {@code null} adds a listener to receive
* item events fired by the {@code Checkbox} menu item.
* Unrecognized keys or values will be ignored.
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
* @serial
* @see removeActionListener()
* @see addActionListener()
@ -515,7 +515,7 @@ public class CheckboxMenuItem extends MenuItem implements ItemSelectable, Access
* subclassed by menu component developers.
* <p>
* This class implements accessibility support for the
* <code>CheckboxMenuItem</code> class. It provides an implementation
* {@code CheckboxMenuItem} class. It provides an implementation
* of the Java Accessibility API appropriate to checkbox menu item
* user-interface elements.
* @since 1.3

174
jdk/src/java.desktop/share/classes/java/awt/Choice.java
View file

@ -36,7 +36,7 @@ import javax.accessibility.*;
/**
* The <code>Choice</code> class presents a pop-up menu of choices.
* The {@code Choice} class presents a pop-up menu of choices.
* The current choice is displayed as the title of the menu.
* <p>
* The following code example produces a pop-up menu:
@ -54,17 +54,17 @@ import javax.accessibility.*;
* <img src="doc-files/Choice-1.gif" alt="The following text describes the graphic"
* style="float:center; margin: 7px 10px;">
* <p>
* In the picture, <code>"Green"</code> is the current choice.
* In the picture, {@code "Green"} is the current choice.
* Pushing the mouse button down on the object causes a menu to
* appear with the current choice highlighted.
* <p>
* Some native platforms do not support arbitrary resizing of
* <code>Choice</code> components and the behavior of
* <code>setSize()/getSize()</code> is bound by
* {@code Choice} components and the behavior of
* {@code setSize()/getSize()} is bound by
* such limitations.
* Native GUI <code>Choice</code> components' size are often bound by such
* Native GUI {@code Choice} components' size are often bound by such
* attributes as font size and length of items contained within
* the <code>Choice</code>.
* the {@code Choice}.
*
* @author Sami Shaio
* @author Arthur van Hoff
@ -72,8 +72,8 @@ import javax.accessibility.*;
*/
public class Choice extends Component implements ItemSelectable, Accessible {
/**
* The items for the <code>Choice</code>.
* This can be a <code>null</code> value.
* The items for the {@code Choice}.
* This can be a {@code null} value.
* @serial
* @see #add(String)
* @see #addItem(String)
@ -85,7 +85,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
Vector<String> pItems;
/**
* The index of the current choice for this <code>Choice</code>
* The index of the current choice for this {@code Choice}
* or -1 if nothing is selected.
* @serial
* @see #getSelectedItem()
@ -117,7 +117,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
* <p>
* By default, the first item added to the choice menu becomes the
* selected item, until a different selection is made by the user
* by calling one of the <code>select</code> methods.
* by calling one of the {@code select} methods.
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true
* @see java.awt.GraphicsEnvironment#isHeadless
@ -131,7 +131,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Constructs a name for this component. Called by
* <code>getName</code> when the name is <code>null</code>.
* {@code getName} when the name is {@code null}.
*/
String constructComponentName() {
synchronized (Choice.class) {
@ -140,9 +140,9 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Creates the <code>Choice</code>'s peer. This peer allows us
* Creates the {@code Choice}'s peer. This peer allows us
* to change the look
* of the <code>Choice</code> without changing its functionality.
* of the {@code Choice} without changing its functionality.
* @see java.awt.Component#getToolkit()
*/
public void addNotify() {
@ -154,9 +154,9 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Returns the number of items in this <code>Choice</code> menu.
* Returns the number of items in this {@code Choice} menu.
*
* @return the number of items in this <code>Choice</code> menu
* @return the number of items in this {@code Choice} menu
* @see #getItem
* @since 1.1
*/
@ -169,7 +169,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
*
* @return the number of items in this {@code Choice} menu
* @deprecated As of JDK version 1.1,
* replaced by <code>getItemCount()</code>.
* replaced by {@code getItemCount()}.
*/
@Deprecated
public int countItems() {
@ -178,7 +178,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Gets the string at the specified index in this
* <code>Choice</code> menu.
* {@code Choice} menu.
*
* @param index the index at which to begin
* @return the item at the specified index
@ -197,10 +197,10 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Adds an item to this <code>Choice</code> menu.
* Adds an item to this {@code Choice} menu.
* @param item the item to be added
* @exception NullPointerException if the item's value is
* <code>null</code>
* {@code null}
* @since 1.1
*/
public void add(String item) {
@ -209,12 +209,12 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Obsolete as of Java 2 platform v1.1. Please use the
* <code>add</code> method instead.
* {@code add} method instead.
* <p>
* Adds an item to this <code>Choice</code> menu.
* Adds an item to this {@code Choice} menu.
* @param item the item to be added
* @exception NullPointerException if the item's value is equal to
* <code>null</code>
* {@code null}
*/
public void addItem(String item) {
synchronized (this) {
@ -226,14 +226,14 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Inserts an item to this <code>Choice</code>,
* but does not invalidate the <code>Choice</code>.
* Inserts an item to this {@code Choice},
* but does not invalidate the {@code Choice}.
* Client methods must provide their own synchronization before
* invoking this method.
* @param item the item to be added
* @param index the new item position
* @exception NullPointerException if the item's value is equal to
* <code>null</code>
* {@code null}
*/
private void insertNoInvalidate(String item, int index) {
if (item == null) {
@ -255,10 +255,10 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Inserts the item into this choice at the specified position.
* Existing items at an index greater than or equal to
* <code>index</code> are shifted up by one to accommodate
* the new item. If <code>index</code> is greater than or
* {@code index} are shifted up by one to accommodate
* the new item. If {@code index} is greater than or
* equal to the number of items in this choice,
* <code>item</code> is added to the end of this choice.
* {@code item} is added to the end of this choice.
* <p>
* If the item is the first one being added to the choice,
* then the item becomes selected. Otherwise, if the
@ -266,7 +266,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
* item in the choice becomes the selected item. If the
* selected item was no among those shifted, it remains
* the selected item.
* @param item the non-<code>null</code> item to be inserted
* @param item the non-{@code null} item to be inserted
* @param index the position at which the item should be inserted
* @exception IllegalArgumentException if index is less than 0
*/
@ -286,14 +286,14 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Removes the first occurrence of <code>item</code>
* from the <code>Choice</code> menu. If the item
* Removes the first occurrence of {@code item}
* from the {@code Choice} menu. If the item
* being removed is the currently selected item,
* then the first item in the choice becomes the
* selected item. Otherwise, the currently selected
* item remains selected (and the selected index is
* updated accordingly).
* @param item the item to remove from this <code>Choice</code> menu
* @param item the item to remove from this {@code Choice} menu
* @exception IllegalArgumentException if the item doesn't
* exist in the choice menu
* @since 1.1
@ -336,8 +336,8 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Removes an item from the <code>Choice</code> at the
* specified position, but does not invalidate the <code>Choice</code>.
* Removes an item from the {@code Choice} at the
* specified position, but does not invalidate the {@code Choice}.
* Client methods must provide their
* own synchronization before invoking this method.
* @param position the position of the item
@ -389,7 +389,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Returns an array (length 1) containing the currently selected
* item. If this choice has no items, returns <code>null</code>.
* item. If this choice has no items, returns {@code null}.
* @see ItemSelectable
*/
public synchronized Object[] getSelectedObjects() {
@ -414,14 +414,14 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Sets the selected item in this <code>Choice</code> menu to be the
* Sets the selected item in this {@code Choice} menu to be the
* item at the specified position.
*
* <p>Note that this method should be primarily used to
* initially select an item in this component.
* Programmatically calling this method will <i>not</i> trigger
* an <code>ItemEvent</code>. The only way to trigger an
* <code>ItemEvent</code> is by user interaction.
* an {@code ItemEvent}. The only way to trigger an
* {@code ItemEvent} is by user interaction.
*
* @param pos the position of the selected item
* @exception IllegalArgumentException if the specified
@ -444,7 +444,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Sets the selected item in this <code>Choice</code> menu
* Sets the selected item in this {@code Choice} menu
* to be the item whose name is equal to the specified string.
* If more than one item matches (is equal to) the specified string,
* the one with the smallest index is selected.
@ -452,8 +452,8 @@ public class Choice extends Component implements ItemSelectable, Accessible {
* <p>Note that this method should be primarily used to
* initially select an item in this component.
* Programmatically calling this method will <i>not</i> trigger
* an <code>ItemEvent</code>. The only way to trigger an
* <code>ItemEvent</code> is by user interaction.
* an {@code ItemEvent}. The only way to trigger an
* {@code ItemEvent} is by user interaction.
*
* @param str the specified string
* @see #getSelectedItem
@ -468,9 +468,9 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Adds the specified item listener to receive item events from
* this <code>Choice</code> menu. Item events are sent in response
* to user input, but not in response to calls to <code>select</code>.
* If l is <code>null</code>, no exception is thrown and no action
* this {@code Choice} menu. Item events are sent in response
* to user input, but not in response to calls to {@code select}.
* If l is {@code null}, no exception is thrown and no action
* is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
@ -492,8 +492,8 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Removes the specified item listener so that it no longer receives
* item events from this <code>Choice</code> menu.
* If l is <code>null</code>, no exception is thrown and no
* item events from this {@code Choice} menu.
* If l is {@code null}, no exception is thrown and no
* action is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
@ -515,7 +515,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
* Returns an array of all the item listeners
* registered on this choice.
*
* @return all of this choice's <code>ItemListener</code>s
* @return all of this choice's {@code ItemListener}s
* or an empty array if no item
* listeners are currently registered
*
@ -532,16 +532,16 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
* upon this <code>Choice</code>.
* upon this {@code Choice}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
*
* <p>
* You can specify the <code>listenerType</code> argument
* You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
* <code>Choice</code> <code>c</code>
* {@code Choice c}
* for its item listeners with the following code:
*
* <pre>ItemListener[] ils = (ItemListener[])(c.getListeners(ItemListener.class));</pre>
@ -550,14 +550,14 @@ public class Choice extends Component implements ItemSelectable, Accessible {
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this choice,
* or an empty array if no such
* listeners have been added
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
*
* @see #getItemListeners
* @since 1.3
@ -586,10 +586,10 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Processes events on this choice. If the event is an
* instance of <code>ItemEvent</code>, it invokes the
* <code>processItemEvent</code> method. Otherwise, it calls its
* superclass's <code>processEvent</code> method.
* <p>Note that if the event parameter is <code>null</code>
* instance of {@code ItemEvent}, it invokes the
* {@code processItemEvent} method. Otherwise, it calls its
* superclass's {@code processEvent} method.
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -607,19 +607,19 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Processes item events occurring on this <code>Choice</code>
* Processes item events occurring on this {@code Choice}
* menu by dispatching them to any registered
* <code>ItemListener</code> objects.
* {@code ItemListener} objects.
* <p>
* This method is not called unless item events are
* enabled for this component. Item events are enabled
* when one of the following occurs:
* <ul>
* <li>An <code>ItemListener</code> object is registered
* via <code>addItemListener</code>.
* <li>Item events are enabled via <code>enableEvents</code>.
* <li>An {@code ItemListener} object is registered
* via {@code addItemListener}.
* <li>Item events are enabled via {@code enableEvents}.
* </ul>
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -638,13 +638,13 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Returns a string representing the state of this <code>Choice</code>
* Returns a string representing the state of this {@code Choice}
* menu. This method is intended to be used only for debugging purposes,
* and the content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this <code>Choice</code> menu
* @return the parameter string of this {@code Choice} menu
*/
protected String paramString() {
return super.paramString() + ",current=" + getSelectedItem();
@ -662,18 +662,18 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Writes default serializable fields to stream. Writes
* a list of serializable <code>ItemListeners</code>
* a list of serializable {@code ItemListeners}
* as optional data. The non-serializable
* <code>ItemListeners</code> are detected and
* {@code ItemListeners} are detected and
* no attempt is made to serialize them.
*
* @param s the <code>ObjectOutputStream</code> to write
* @serialData <code>null</code> terminated sequence of 0
* or more pairs; the pair consists of a <code>String</code>
* and an <code>Object</code>; the <code>String</code> indicates
* @param s the {@code ObjectOutputStream} to write
* @serialData {@code null} terminated sequence of 0
* or more pairs; the pair consists of a {@code String}
* and an {@code Object}; the {@code String} indicates
* the type of object and is one of the following:
* <code>itemListenerK</code> indicating an
* <code>ItemListener</code> object
* {@code itemListenerK} indicating an
* {@code ItemListener} object
*
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#itemListenerK
@ -689,15 +689,15 @@ public class Choice extends Component implements ItemSelectable, Accessible {
}
/**
* Reads the <code>ObjectInputStream</code> and if it
* isn't <code>null</code> adds a listener to receive
* item events fired by the <code>Choice</code> item.
* Reads the {@code ObjectInputStream} and if it
* isn't {@code null} adds a listener to receive
* item events fired by the {@code Choice} item.
* Unrecognized keys or values will be ignored.
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code> returns
* <code>true</code>
* {@code GraphicsEnvironment.isHeadless} returns
* {@code true}
* @serial
* @see #removeItemListener(ItemListener)
* @see #addItemListener(ItemListener)
@ -733,14 +733,14 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* Gets the <code>AccessibleContext</code> associated with this
* <code>Choice</code>. For <code>Choice</code> components,
* the <code>AccessibleContext</code> takes the form of an
* <code>AccessibleAWTChoice</code>. A new <code>AccessibleAWTChoice</code>
* Gets the {@code AccessibleContext} associated with this
* {@code Choice}. For {@code Choice} components,
* the {@code AccessibleContext} takes the form of an
* {@code AccessibleAWTChoice}. A new {@code AccessibleAWTChoice}
* instance is created if necessary.
*
* @return an <code>AccessibleAWTChoice</code> that serves as the
* <code>AccessibleContext</code> of this <code>Choice</code>
* @return an {@code AccessibleAWTChoice} that serves as the
* {@code AccessibleContext} of this {@code Choice}
* @since 1.3
*/
public AccessibleContext getAccessibleContext() {
@ -752,7 +752,7 @@ public class Choice extends Component implements ItemSelectable, Accessible {
/**
* This class implements accessibility support for the
* <code>Choice</code> class. It provides an implementation of the
* {@code Choice} class. It provides an implementation of the
* Java Accessibility API appropriate to choice user-interface elements.
* @since 1.3
*/

284
jdk/src/java.desktop/share/classes/java/awt/Color.java
View file

@ -32,7 +32,7 @@ import java.awt.geom.Rectangle2D;
import java.awt.color.ColorSpace;
/**
* The <code>Color</code> class is used to encapsulate colors in the default
* The {@code Color} class is used to encapsulate colors in the default
* sRGB color space or colors in arbitrary color spaces identified by a
* {@link ColorSpace}. Every color has an implicit alpha value of 1.0 or
* an explicit one provided in the constructor. The alpha value
@ -41,8 +41,8 @@ import java.awt.color.ColorSpace;
* An alpha value of 1.0 or 255 means that the color is completely
* opaque and an alpha value of 0 or 0.0 means that the color is
* completely transparent.
* When constructing a <code>Color</code> with an explicit alpha or
* getting the color/alpha components of a <code>Color</code>, the color
* When constructing a {@code Color} with an explicit alpha or
* getting the color/alpha components of a {@code Color}, the color
* components are never premultiplied by the alpha component.
* <p>
* The default color space for the Java 2D(tm) API is sRGB, a proposed
@ -210,11 +210,11 @@ public class Color implements Paint, java.io.Serializable {
int value;
/**
* The color value in the default sRGB <code>ColorSpace</code> as
* <code>float</code> components (no alpha).
* If <code>null</code> after object construction, this must be an
* The color value in the default sRGB {@code ColorSpace} as
* {@code float} components (no alpha).
* If {@code null} after object construction, this must be an
* sRGB color constructed with 8-bit precision, so compute from the
* <code>int</code> color value.
* {@code int} color value.
* @serial
* @see #getRGBColorComponents
* @see #getRGBComponents
@ -222,11 +222,11 @@ public class Color implements Paint, java.io.Serializable {
private float frgbvalue[] = null;
/**
* The color value in the native <code>ColorSpace</code> as
* <code>float</code> components (no alpha).
* If <code>null</code> after object construction, this must be an
* The color value in the native {@code ColorSpace} as
* {@code float} components (no alpha).
* If {@code null} after object construction, this must be an
* sRGB color constructed with 8-bit precision, so compute from the
* <code>int</code> color value.
* {@code int} color value.
* @serial
* @see #getRGBColorComponents
* @see #getRGBComponents
@ -234,9 +234,9 @@ public class Color implements Paint, java.io.Serializable {
private float fvalue[] = null;
/**
* The alpha value as a <code>float</code> component.
* If <code>frgbvalue</code> is <code>null</code>, this is not valid
* data, so compute from the <code>int</code> color value.
* The alpha value as a {@code float} component.
* If {@code frgbvalue} is {@code null}, this is not valid
* data, so compute from the {@code int} color value.
* @serial
* @see #getRGBComponents
* @see #getComponents
@ -244,7 +244,7 @@ public class Color implements Paint, java.io.Serializable {
private float falpha = 0.0f;
/**
* The <code>ColorSpace</code>. If <code>null</code>, then it's
* The {@code ColorSpace}. If {@code null}, then it's
* default is sRGB.
* @serial
* @see #getColor
@ -313,9 +313,9 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Checks the color <code>float</code> components supplied for
* Checks the color {@code float} components supplied for
* validity.
* Throws an <code>IllegalArgumentException</code> if the value is out
* Throws an {@code IllegalArgumentException} if the value is out
* of range.
* @param r the Red component
* @param g the Green component
@ -354,8 +354,8 @@ public class Color implements Paint, java.io.Serializable {
* available for a given output device.
* Alpha is defaulted to 255.
*
* @throws IllegalArgumentException if <code>r</code>, <code>g</code>
* or <code>b</code> are outside of the range
* @throws IllegalArgumentException if {@code r}, {@code g}
* or {@code b} are outside of the range
* 0 to 255, inclusive
* @param r the red component
* @param g the green component
@ -373,8 +373,8 @@ public class Color implements Paint, java.io.Serializable {
* Creates an sRGB color with the specified red, green, blue, and alpha
* values in the range (0 - 255).
*
* @throws IllegalArgumentException if <code>r</code>, <code>g</code>,
* <code>b</code> or <code>a</code> are outside of the range
* @throws IllegalArgumentException if {@code r}, {@code g},
* {@code b} or {@code a} are outside of the range
* 0 to 255, inclusive
* @param r the red component
* @param g the green component
@ -418,12 +418,12 @@ public class Color implements Paint, java.io.Serializable {
* Creates an sRGB color with the specified combined RGBA value consisting
* of the alpha component in bits 24-31, the red component in bits 16-23,
* the green component in bits 8-15, and the blue component in bits 0-7.
* If the <code>hasalpha</code> argument is <code>false</code>, alpha
* If the {@code hasalpha} argument is {@code false}, alpha
* is defaulted to 255.
*
* @param rgba the combined RGBA components
* @param hasalpha <code>true</code> if the alpha bits are valid;
* <code>false</code> otherwise
* @param hasalpha {@code true} if the alpha bits are valid;
* {@code false} otherwise
* @see java.awt.image.ColorModel#getRGBdefault
* @see #getRed
* @see #getGreen
@ -446,8 +446,8 @@ public class Color implements Paint, java.io.Serializable {
* match given the color space available for a particular output
* device.
*
* @throws IllegalArgumentException if <code>r</code>, <code>g</code>
* or <code>b</code> are outside of the range
* @throws IllegalArgumentException if {@code r}, {@code g}
* or {@code b} are outside of the range
* 0.0 to 1.0, inclusive
* @param r the red component
* @param g the green component
@ -473,8 +473,8 @@ public class Color implements Paint, java.io.Serializable {
* alpha values in the range (0.0 - 1.0). The actual color
* used in rendering depends on finding the best match given the
* color space available for a particular output device.
* @throws IllegalArgumentException if <code>r</code>, <code>g</code>
* <code>b</code> or <code>a</code> are outside of the range
* @throws IllegalArgumentException if {@code r}, {@code g}
* {@code b} or {@code a} are outside of the range
* 0.0 to 1.0, inclusive
* @param r the red component
* @param g the green component
@ -497,19 +497,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Creates a color in the specified <code>ColorSpace</code>
* with the color components specified in the <code>float</code>
* Creates a color in the specified {@code ColorSpace}
* with the color components specified in the {@code float}
* array and the specified alpha. The number of components is
* determined by the type of the <code>ColorSpace</code>. For
* determined by the type of the {@code ColorSpace}. For
* example, RGB requires 3 components, but CMYK requires 4
* components.
* @param cspace the <code>ColorSpace</code> to be used to
* @param cspace the {@code ColorSpace} to be used to
* interpret the components
* @param components an arbitrary number of color components
* that is compatible with the <code>ColorSpace</code>
* that is compatible with the {@code ColorSpace}
* @param alpha alpha value
* @throws IllegalArgumentException if any of the values in the
* <code>components</code> array or <code>alpha</code> is
* {@code components} array or {@code alpha} is
* outside of the range 0.0 to 1.0
* @see #getComponents
* @see #getColorComponents
@ -592,7 +592,7 @@ public class Color implements Paint, java.io.Serializable {
* (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are
* blue).
* @return the RGB value of the color in the default sRGB
* <code>ColorModel</code>.
* {@code ColorModel}.
* @see java.awt.image.ColorModel#getRGBdefault
* @see #getRed
* @see #getGreen
@ -606,19 +606,19 @@ public class Color implements Paint, java.io.Serializable {
private static final double FACTOR = 0.7;
/**
* Creates a new <code>Color</code> that is a brighter version of this
* <code>Color</code>.
* Creates a new {@code Color} that is a brighter version of this
* {@code Color}.
* <p>
* This method applies an arbitrary scale factor to each of the three RGB
* components of this <code>Color</code> to create a brighter version
* of this <code>Color</code>.
* components of this {@code Color} to create a brighter version
* of this {@code Color}.
* The {@code alpha} value is preserved.
* Although <code>brighter</code> and
* <code>darker</code> are inverse operations, the results of a
* Although {@code brighter} and
* {@code darker} are inverse operations, the results of a
* series of invocations of these two methods might be inconsistent
* because of rounding errors.
* @return a new <code>Color</code> object that is
* a brighter version of this <code>Color</code>
* @return a new {@code Color} object that is
* a brighter version of this {@code Color}
* with the same {@code alpha} value.
* @see java.awt.Color#darker
* @since 1.0
@ -649,19 +649,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Creates a new <code>Color</code> that is a darker version of this
* <code>Color</code>.
* Creates a new {@code Color} that is a darker version of this
* {@code Color}.
* <p>
* This method applies an arbitrary scale factor to each of the three RGB
* components of this <code>Color</code> to create a darker version of
* this <code>Color</code>.
* components of this {@code Color} to create a darker version of
* this {@code Color}.
* The {@code alpha} value is preserved.
* Although <code>brighter</code> and
* <code>darker</code> are inverse operations, the results of a series
* Although {@code brighter} and
* {@code darker} are inverse operations, the results of a series
* of invocations of these two methods might be inconsistent because
* of rounding errors.
* @return a new <code>Color</code> object that is
* a darker version of this <code>Color</code>
* @return a new {@code Color} object that is
* a darker version of this {@code Color}
* with the same {@code alpha} value.
* @see java.awt.Color#brighter
* @since 1.0
@ -674,7 +674,7 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Computes the hash code for this <code>Color</code>.
* Computes the hash code for this {@code Color}.
* @return a hash code value for this object.
* @since 1.0
*/
@ -684,15 +684,15 @@ public class Color implements Paint, java.io.Serializable {
/**
* Determines whether another object is equal to this
* <code>Color</code>.
* {@code Color}.
* <p>
* The result is <code>true</code> if and only if the argument is not
* <code>null</code> and is a <code>Color</code> object that has the same
* The result is {@code true} if and only if the argument is not
* {@code null} and is a {@code Color} object that has the same
* red, green, blue, and alpha values as this object.
* @param obj the object to test for equality with this
* <code>Color</code>
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
* {@code Color}
* @return {@code true} if the objects are the same;
* {@code false} otherwise.
* @since 1.0
*/
public boolean equals(Object obj) {
@ -700,25 +700,25 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a string representation of this <code>Color</code>. This
* Returns a string representation of this {@code Color}. This
* method is intended to be used only for debugging purposes. The
* content and format of the returned string might vary between
* implementations. The returned string might be empty but cannot
* be <code>null</code>.
* be {@code null}.
*
* @return a string representation of this <code>Color</code>.
* @return a string representation of this {@code Color}.
*/
public String toString() {
return getClass().getName() + "[r=" + getRed() + ",g=" + getGreen() + ",b=" + getBlue() + "]";
}
/**
* Converts a <code>String</code> to an integer and returns the
* specified opaque <code>Color</code>. This method handles string
* Converts a {@code String} to an integer and returns the
* specified opaque {@code Color}. This method handles string
* formats that are used to represent octal and hexadecimal numbers.
* @param nm a <code>String</code> that represents
* @param nm a {@code String} that represents
* an opaque color as a 24-bit integer
* @return the new <code>Color</code> object.
* @return the new {@code Color} object.
* @see java.lang.Integer#decode
* @exception NumberFormatException if the specified string cannot
* be interpreted as a decimal,
@ -736,13 +736,13 @@ public class Color implements Paint, java.io.Serializable {
* <p>
* The argument is treated as the name of a system property to
* be obtained. The string value of this property is then interpreted
* as an integer which is then converted to a <code>Color</code>
* as an integer which is then converted to a {@code Color}
* object.
* <p>
* If the specified property is not found or could not be parsed as
* an integer then <code>null</code> is returned.
* an integer then {@code null} is returned.
* @param nm the name of the color property
* @return the <code>Color</code> converted from the system
* @return the {@code Color} converted from the system
* property.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.Integer#getInteger(java.lang.String)
@ -758,16 +758,16 @@ public class Color implements Paint, java.io.Serializable {
* <p>
* The first argument is treated as the name of a system property to
* be obtained. The string value of this property is then interpreted
* as an integer which is then converted to a <code>Color</code>
* as an integer which is then converted to a {@code Color}
* object.
* <p>
* If the specified property is not found or cannot be parsed as
* an integer then the <code>Color</code> specified by the second
* an integer then the {@code Color} specified by the second
* argument is returned instead.
* @param nm the name of the color property
* @param v the default <code>Color</code>
* @return the <code>Color</code> converted from the system
* property, or the specified <code>Color</code>.
* @param v the default {@code Color}
* @return the {@code Color} converted from the system
* property, or the specified {@code Color}.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.Integer#getInteger(java.lang.String)
* @see java.awt.Color#Color(int)
@ -787,16 +787,16 @@ public class Color implements Paint, java.io.Serializable {
* <p>
* The first argument is treated as the name of a system property to
* be obtained. The string value of this property is then interpreted
* as an integer which is then converted to a <code>Color</code>
* as an integer which is then converted to a {@code Color}
* object.
* <p>
* If the specified property is not found or could not be parsed as
* an integer then the integer value <code>v</code> is used instead,
* and is converted to a <code>Color</code> object.
* an integer then the integer value {@code v} is used instead,
* and is converted to a {@code Color} object.
* @param nm the name of the color property
* @param v the default color value, as an integer
* @return the <code>Color</code> converted from the system
* property or the <code>Color</code> converted from
* @return the {@code Color} converted from the system
* property or the {@code Color} converted from
* the specified integer.
* @see java.lang.System#getProperty(java.lang.String)
* @see java.lang.Integer#getInteger(java.lang.String)
@ -813,19 +813,19 @@ public class Color implements Paint, java.io.Serializable {
* Converts the components of a color, as specified by the HSB
* model, to an equivalent set of values for the default RGB model.
* <p>
* The <code>saturation</code> and <code>brightness</code> components
* The {@code saturation} and {@code brightness} components
* should be floating-point values between zero and one
* (numbers in the range 0.0-1.0). The <code>hue</code> component
* (numbers in the range 0.0-1.0). The {@code hue} component
* can be any floating-point number. The floor of this number is
* subtracted from it to create a fraction between 0 and 1. This
* fractional number is then multiplied by 360 to produce the hue
* angle in the HSB color model.
* <p>
* The integer that is returned by <code>HSBtoRGB</code> encodes the
* The integer that is returned by {@code HSBtoRGB} encodes the
* value of a color in bits 0-23 of an integer value that is the same
* format used by the method {@link #getRGB() getRGB}.
* This integer can be supplied as an argument to the
* <code>Color</code> constructor that takes a single integer argument.
* {@code Color} constructor that takes a single integer argument.
* @param hue the hue component of the color
* @param saturation the saturation of the color
* @param brightness the brightness of the color
@ -887,15 +887,15 @@ public class Color implements Paint, java.io.Serializable {
* model, to an equivalent set of values for hue, saturation, and
* brightness that are the three components of the HSB model.
* <p>
* If the <code>hsbvals</code> argument is <code>null</code>, then a
* If the {@code hsbvals} argument is {@code null}, then a
* new array is allocated to return the result. Otherwise, the method
* returns the array <code>hsbvals</code>, with the values put into
* returns the array {@code hsbvals}, with the values put into
* that array.
* @param r the red component of the color
* @param g the green component of the color
* @param b the blue component of the color
* @param hsbvals the array used to return the
* three HSB values, or <code>null</code>
* three HSB values, or {@code null}
* @return an array of three elements containing the hue, saturation,
* and brightness (in that order), of the color with
* the indicated red, green, and blue components.
@ -942,12 +942,12 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Creates a <code>Color</code> object based on the specified values
* Creates a {@code Color} object based on the specified values
* for the HSB color model.
* <p>
* The <code>s</code> and <code>b</code> components should be
* The {@code s} and {@code b} components should be
* floating-point values between zero and one
* (numbers in the range 0.0-1.0). The <code>h</code> component
* (numbers in the range 0.0-1.0). The {@code h} component
* can be any floating-point number. The floor of this number is
* subtracted from it to create a fraction between 0 and 1. This
* fractional number is then multiplied by 360 to produce the hue
@ -955,7 +955,7 @@ public class Color implements Paint, java.io.Serializable {
* @param h the hue component
* @param s the saturation of the color
* @param b the brightness of the color
* @return a <code>Color</code> object with the specified hue,
* @return a {@code Color} object with the specified hue,
* saturation, and brightness.
* @since 1.0
*/
@ -964,16 +964,16 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing the color and alpha
* components of the <code>Color</code>, as represented in the default
* Returns a {@code float} array containing the color and alpha
* components of the {@code Color}, as represented in the default
* sRGB color space.
* If <code>compArray</code> is <code>null</code>, an array of length
* If {@code compArray} is {@code null}, an array of length
* 4 is created for the return value. Otherwise,
* <code>compArray</code> must have length 4 or greater,
* {@code compArray} must have length 4 or greater,
* and it is filled in with the components and returned.
* @param compArray an array that this method fills with
* color and alpha components and returns
* @return the RGBA components in a <code>float</code> array.
* @return the RGBA components in a {@code float} array.
*/
public float[] getRGBComponents(float[] compArray) {
float[] f;
@ -997,15 +997,15 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing only the color
* components of the <code>Color</code>, in the default sRGB color
* space. If <code>compArray</code> is <code>null</code>, an array of
* Returns a {@code float} array containing only the color
* components of the {@code Color}, in the default sRGB color
* space. If {@code compArray} is {@code null}, an array of
* length 3 is created for the return value. Otherwise,
* <code>compArray</code> must have length 3 or greater, and it is
* {@code compArray} must have length 3 or greater, and it is
* filled in with the components and returned.
* @param compArray an array that this method fills with color
* components and returns
* @return the RGB components in a <code>float</code> array.
* @return the RGB components in a {@code float} array.
*/
public float[] getRGBColorComponents(float[] compArray) {
float[] f;
@ -1027,19 +1027,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing the color and alpha
* components of the <code>Color</code>, in the
* <code>ColorSpace</code> of the <code>Color</code>.
* If <code>compArray</code> is <code>null</code>, an array with
* Returns a {@code float} array containing the color and alpha
* components of the {@code Color}, in the
* {@code ColorSpace} of the {@code Color}.
* If {@code compArray} is {@code null}, an array with
* length equal to the number of components in the associated
* <code>ColorSpace</code> plus one is created for
* the return value. Otherwise, <code>compArray</code> must have at
* {@code ColorSpace} plus one is created for
* the return value. Otherwise, {@code compArray} must have at
* least this length and it is filled in with the components and
* returned.
* @param compArray an array that this method fills with the color and
* alpha components of this <code>Color</code> in its
* <code>ColorSpace</code> and returns
* @return the color and alpha components in a <code>float</code>
* alpha components of this {@code Color} in its
* {@code ColorSpace} and returns
* @return the color and alpha components in a {@code float}
* array.
*/
public float[] getComponents(float[] compArray) {
@ -1060,19 +1060,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing only the color
* components of the <code>Color</code>, in the
* <code>ColorSpace</code> of the <code>Color</code>.
* If <code>compArray</code> is <code>null</code>, an array with
* Returns a {@code float} array containing only the color
* components of the {@code Color}, in the
* {@code ColorSpace} of the {@code Color}.
* If {@code compArray} is {@code null}, an array with
* length equal to the number of components in the associated
* <code>ColorSpace</code> is created for
* the return value. Otherwise, <code>compArray</code> must have at
* {@code ColorSpace} is created for
* the return value. Otherwise, {@code compArray} must have at
* least this length and it is filled in with the components and
* returned.
* @param compArray an array that this method fills with the color
* components of this <code>Color</code> in its
* <code>ColorSpace</code> and returns
* @return the color components in a <code>float</code> array.
* components of this {@code Color} in its
* {@code ColorSpace} and returns
* @return the color components in a {@code float} array.
*/
public float[] getColorComponents(float[] compArray) {
if (fvalue == null)
@ -1091,19 +1091,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing the color and alpha
* components of the <code>Color</code>, in the
* <code>ColorSpace</code> specified by the <code>cspace</code>
* parameter. If <code>compArray</code> is <code>null</code>, an
* Returns a {@code float} array containing the color and alpha
* components of the {@code Color}, in the
* {@code ColorSpace} specified by the {@code cspace}
* parameter. If {@code compArray} is {@code null}, an
* array with length equal to the number of components in
* <code>cspace</code> plus one is created for the return value.
* Otherwise, <code>compArray</code> must have at least this
* {@code cspace} plus one is created for the return value.
* Otherwise, {@code compArray} must have at least this
* length, and it is filled in with the components and returned.
* @param cspace a specified <code>ColorSpace</code>
* @param cspace a specified {@code ColorSpace}
* @param compArray an array that this method fills with the
* color and alpha components of this <code>Color</code> in
* the specified <code>ColorSpace</code> and returns
* @return the color and alpha components in a <code>float</code>
* color and alpha components of this {@code Color} in
* the specified {@code ColorSpace} and returns
* @return the color and alpha components in a {@code float}
* array.
*/
public float[] getComponents(ColorSpace cspace, float[] compArray) {
@ -1136,19 +1136,19 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns a <code>float</code> array containing only the color
* components of the <code>Color</code> in the
* <code>ColorSpace</code> specified by the <code>cspace</code>
* parameter. If <code>compArray</code> is <code>null</code>, an array
* Returns a {@code float} array containing only the color
* components of the {@code Color} in the
* {@code ColorSpace} specified by the {@code cspace}
* parameter. If {@code compArray} is {@code null}, an array
* with length equal to the number of components in
* <code>cspace</code> is created for the return value. Otherwise,
* <code>compArray</code> must have at least this length, and it is
* {@code cspace} is created for the return value. Otherwise,
* {@code compArray} must have at least this length, and it is
* filled in with the components and returned.
* @param cspace a specified <code>ColorSpace</code>
* @param cspace a specified {@code ColorSpace}
* @param compArray an array that this method fills with the color
* components of this <code>Color</code> in the specified
* <code>ColorSpace</code>
* @return the color components in a <code>float</code> array.
* components of this {@code Color} in the specified
* {@code ColorSpace}
* @return the color components in a {@code float} array.
*/
public float[] getColorComponents(ColorSpace cspace, float[] compArray) {
if (cs == null) {
@ -1175,8 +1175,8 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns the <code>ColorSpace</code> of this <code>Color</code>.
* @return this <code>Color</code> object's <code>ColorSpace</code>.
* Returns the {@code ColorSpace} of this {@code Color}.
* @return this {@code Color} object's {@code ColorSpace}.
*/
public ColorSpace getColorSpace() {
if (cs == null) {
@ -1221,9 +1221,9 @@ public class Color implements Paint, java.io.Serializable {
}
/**
* Returns the transparency mode for this <code>Color</code>. This is
* required to implement the <code>Paint</code> interface.
* @return this <code>Color</code> object's transparency mode.
* Returns the transparency mode for this {@code Color}. This is
* required to implement the {@code Paint} interface.
* @return this {@code Color} object's transparency mode.
* @see Paint
* @see Transparency
* @see #createContext

2
jdk/src/java.desktop/share/classes/java/awt/ColorPaintContext.java
View file

@ -50,7 +50,7 @@ class ColorPaintContext implements PaintContext {
* (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are
* blue).
* @return the RGB value of the color in the default sRGB
* <code>ColorModel</code>.
* {@code ColorModel}.
* @see java.awt.image.ColorModel#getRGBdefault
* @see #getRed
* @see #getGreen

1152
jdk/src/java.desktop/share/classes/java/awt/Component.java
View file

File diff suppressed because it is too large Load diff

4
jdk/src/java.desktop/share/classes/java/awt/ComponentOrientation.java
View file

@ -72,8 +72,8 @@ import java.util.ResourceBundle;
* <li>TL - Mongolian
* </ul>
* Components whose view and controller code depends on orientation
* should use the <code>isLeftToRight()</code> and
* <code>isHorizontal()</code> methods to
* should use the {@code isLeftToRight()} and
* {@code isHorizontal()} methods to
* determine their behavior. They should not include switch-like
* code that keys off of the constants, such as:
* <pre>

38
jdk/src/java.desktop/share/classes/java/awt/Composite.java
View file

@ -28,39 +28,39 @@ package java.awt;
import java.awt.image.ColorModel;
/**
* The <code>Composite</code> interface, along with
* The {@code Composite} interface, along with
* {@link CompositeContext}, defines the methods to compose a draw
* primitive with the underlying graphics area.
* After the <code>Composite</code> is set in the
* After the {@code Composite} is set in the
* {@link Graphics2D} context, it combines a shape, text, or an image
* being rendered with the colors that have already been rendered
* according to pre-defined rules. The classes
* implementing this interface provide the rules and a method to create
* the context for a particular operation.
* <code>CompositeContext</code> is an environment used by the
* compositing operation, which is created by the <code>Graphics2D</code>
* prior to the start of the operation. <code>CompositeContext</code>
* {@code CompositeContext} is an environment used by the
* compositing operation, which is created by the {@code Graphics2D}
* prior to the start of the operation. {@code CompositeContext}
* contains private information and resources needed for a compositing
* operation. When the <code>CompositeContext</code> is no longer needed,
* the <code>Graphics2D</code> object disposes of it in order to reclaim
* operation. When the {@code CompositeContext} is no longer needed,
* the {@code Graphics2D} object disposes of it in order to reclaim
* resources allocated for the operation.
* <p>
* Instances of classes implementing <code>Composite</code> must be
* immutable because the <code>Graphics2D</code> does not clone
* Instances of classes implementing {@code Composite} must be
* immutable because the {@code Graphics2D} does not clone
* these objects when they are set as an attribute with the
* <code>setComposite</code> method or when the <code>Graphics2D</code>
* {@code setComposite} method or when the {@code Graphics2D}
* object is cloned. This is to avoid undefined rendering behavior of
* <code>Graphics2D</code>, resulting from the modification of
* the <code>Composite</code> object after it has been set in the
* <code>Graphics2D</code> context.
* {@code Graphics2D}, resulting from the modification of
* the {@code Composite} object after it has been set in the
* {@code Graphics2D} context.
* <p>
* Since this interface must expose the contents of pixels on the
* target device or image to potentially arbitrary code, the use of
* custom objects which implement this interface when rendering directly
* to a screen device is governed by the <code>readDisplayPixels</code>
* to a screen device is governed by the {@code readDisplayPixels}
* {@link AWTPermission}. The permission check will occur when such
* a custom object is passed to the <code>setComposite</code> method
* of a <code>Graphics2D</code> retrieved from a {@link Component}.
* a custom object is passed to the {@code setComposite} method
* of a {@code Graphics2D} retrieved from a {@link Component}.
* @see AlphaComposite
* @see CompositeContext
* @see Graphics2D#setComposite
@ -71,12 +71,12 @@ public interface Composite {
* Creates a context containing state that is used to perform
* the compositing operation. In a multi-threaded environment,
* several contexts can exist simultaneously for a single
* <code>Composite</code> object.
* {@code Composite} object.
* @param srcColorModel the {@link ColorModel} of the source
* @param dstColorModel the <code>ColorModel</code> of the destination
* @param dstColorModel the {@code ColorModel} of the destination
* @param hints the hint that the context object uses to choose between
* rendering alternatives
* @return the <code>CompositeContext</code> object used to perform the
* @return the {@code CompositeContext} object used to perform the
* compositing operation.
*/
public CompositeContext createContext(ColorModel srcColorModel,

14
jdk/src/java.desktop/share/classes/java/awt/CompositeContext.java
View file

@ -29,9 +29,9 @@ import java.awt.image.Raster;
import java.awt.image.WritableRaster;
/**
* The <code>CompositeContext</code> interface defines the encapsulated
* The {@code CompositeContext} interface defines the encapsulated
* and optimized environment for a compositing operation.
* <code>CompositeContext</code> objects maintain state for
* {@code CompositeContext} objects maintain state for
* compositing operations. In a multi-threaded environment, several
* contexts can exist simultaneously for a single {@link Composite}
* object.
@ -49,14 +49,14 @@ public interface CompositeContext {
* places the result in the destination
* {@link WritableRaster}. Note that the destination
* can be the same object as either the first or second
* source. Note that <code>dstIn</code> and
* <code>dstOut</code> must be compatible with the
* <code>dstColorModel</code> passed to the
* source. Note that {@code dstIn} and
* {@code dstOut} must be compatible with the
* {@code dstColorModel} passed to the
* {@link Composite#createContext(java.awt.image.ColorModel, java.awt.image.ColorModel, java.awt.RenderingHints) createContext}
* method of the <code>Composite</code> interface.
* method of the {@code Composite} interface.
* @param src the first source for the compositing operation
* @param dstIn the second source for the compositing operation
* @param dstOut the <code>WritableRaster</code> into which the
* @param dstOut the {@code WritableRaster} into which the
* result of the operation is stored
* @see Composite
*/

266
jdk/src/java.desktop/share/classes/java/awt/Container.java
View file

@ -183,7 +183,7 @@ public class Container extends Component {
/**
* A constant which toggles one of the controllable behaviors
* of <code>getMouseEventTarget</code>. It is used to specify whether
* of {@code getMouseEventTarget}. It is used to specify whether
* the method can return the Container on which it is originally called
* in case if none of its children are the current mouse event targets.
*
@ -193,7 +193,7 @@ public class Container extends Component {
/**
* A constant which toggles one of the controllable behaviors
* of <code>getMouseEventTarget</code>. It is used to specify whether
* of {@code getMouseEventTarget}. It is used to specify whether
* the method should search only lightweight components.
*
* @see #getMouseEventTarget(int, int, boolean)
@ -384,7 +384,7 @@ public class Container extends Component {
* Determines the insets of this container, which indicate the size
* of the container's border.
* <p>
* A <code>Frame</code> object, for example, has a top inset that
* A {@code Frame} object, for example, has a top inset that
* corresponds to the height of the frame's title bar.
* @return the insets of this container.
* @see Insets
@ -399,7 +399,7 @@ public class Container extends Component {
* Returns the insets for this container.
*
* @deprecated As of JDK version 1.1,
* replaced by <code>getInsets()</code>.
* replaced by {@code getInsets()}.
* @return the insets for this container
*/
@Deprecated
@ -439,7 +439,7 @@ public class Container extends Component {
* This is a convenience method for {@link #addImpl}.
* <p>
* This method is obsolete as of 1.1. Please use the
* method <code>add(Component, Object)</code> instead.
* method {@code add(Component, Object)} instead.
* <p>
* This method changes layout-related information, and therefore,
* invalidates the component hierarchy. If the container has already been
@ -471,11 +471,11 @@ public class Container extends Component {
*
* @param comp the component to be added
* @param index the position at which to insert the component,
* or <code>-1</code> to append the component to the end
* or {@code -1} to append the component to the end
* @exception NullPointerException if {@code comp} is {@code null}
* @exception IllegalArgumentException if {@code index} is invalid (see
* {@link #addImpl} for details)
* @return the component <code>comp</code>
* @return the component {@code comp}
* @see #addImpl
* @see #remove
* @see #invalidate
@ -532,7 +532,7 @@ public class Container extends Component {
if (comp.parent == this) {
if (index == component.size()) {
throw new IllegalArgumentException("illegal component position " +
index + " should be less then " + component.size());
index + " should be less than " + component.size());
}
}
checkAddToSelf(comp);
@ -734,40 +734,40 @@ public class Container extends Component {
* If the component is a child of some other container, it is
* removed from that container before being added to this container.
* The important difference between this method and
* <code>java.awt.Container.add(Component, int)</code> is that this method
* doesn't call <code>removeNotify</code> on the component while
* {@code java.awt.Container.add(Component, int)} is that this method
* doesn't call {@code removeNotify} on the component while
* removing it from its previous container unless necessary and when
* allowed by the underlying native windowing system. This way, if the
* component has the keyboard focus, it maintains the focus when
* moved to the new position.
* <p>
* This property is guaranteed to apply only to lightweight
* non-<code>Container</code> components.
* non-{@code Container} components.
* <p>
* This method changes layout-related information, and therefore,
* invalidates the component hierarchy.
* <p>
* <b>Note</b>: Not all platforms support changing the z-order of
* heavyweight components from one container into another without
* the call to <code>removeNotify</code>. There is no way to detect
* the call to {@code removeNotify}. There is no way to detect
* whether a platform supports this, so developers shouldn't make
* any assumptions.
*
* @param comp the component to be moved
* @param index the position in the container's list to
* insert the component, where <code>getComponentCount()</code>
* insert the component, where {@code getComponentCount()}
* appends to the end
* @exception NullPointerException if <code>comp</code> is
* <code>null</code>
* @exception IllegalArgumentException if <code>comp</code> is one of the
* @exception NullPointerException if {@code comp} is
* {@code null}
* @exception IllegalArgumentException if {@code comp} is one of the
* container's parents
* @exception IllegalArgumentException if <code>index</code> is not in
* the range <code>[0, getComponentCount()]</code> for moving
* @exception IllegalArgumentException if {@code index} is not in
* the range {@code [0, getComponentCount()]} for moving
* between containers, or not in the range
* <code>[0, getComponentCount()-1]</code> for moving inside
* {@code [0, getComponentCount()-1]} for moving inside
* a container
* @exception IllegalArgumentException if adding a container to itself
* @exception IllegalArgumentException if adding a <code>Window</code>
* @exception IllegalArgumentException if adding a {@code Window}
* to a container
* @see #getComponentZOrder(java.awt.Component)
* @see #invalidate
@ -949,7 +949,7 @@ public class Container extends Component {
*
* @param comp the component being queried
* @return the z-order index of the component; otherwise
* returns -1 if the component is <code>null</code>
* returns -1 if the component is {@code null}
* or doesn't belong to the container
* @see #setComponentZOrder(java.awt.Component, int)
* @since 1.5
@ -1010,7 +1010,7 @@ public class Container extends Component {
* @param comp the component to be added
* @param constraints an object expressing layout constraints for this
* @param index the position in the container's list at which to insert
* the component; <code>-1</code> means insert at the end
* the component; {@code -1} means insert at the end
* component
* @exception NullPointerException if {@code comp} is {@code null}
* @exception IllegalArgumentException if {@code index} is invalid (see
@ -1030,20 +1030,20 @@ public class Container extends Component {
* Adds the specified component to this container at the specified
* index. This method also notifies the layout manager to add
* the component to this container's layout using the specified
* constraints object via the <code>addLayoutComponent</code>
* constraints object via the {@code addLayoutComponent}
* method.
* <p>
* The constraints are
* defined by the particular layout manager being used. For
* example, the <code>BorderLayout</code> class defines five
* constraints: <code>BorderLayout.NORTH</code>,
* <code>BorderLayout.SOUTH</code>, <code>BorderLayout.EAST</code>,
* <code>BorderLayout.WEST</code>, and <code>BorderLayout.CENTER</code>.
* example, the {@code BorderLayout} class defines five
* constraints: {@code BorderLayout.NORTH},
* {@code BorderLayout.SOUTH}, {@code BorderLayout.EAST},
* {@code BorderLayout.WEST}, and {@code BorderLayout.CENTER}.
* <p>
* The <code>GridBagLayout</code> class requires a
* <code>GridBagConstraints</code> object. Failure to pass
* The {@code GridBagLayout} class requires a
* {@code GridBagConstraints} object. Failure to pass
* the correct type of constraints object results in an
* <code>IllegalArgumentException</code>.
* {@code IllegalArgumentException}.
* <p>
* If the current layout manager implements {@code LayoutManager2}, then
* {@link LayoutManager2#addLayoutComponent(Component,Object)} is invoked on
@ -1061,7 +1061,7 @@ public class Container extends Component {
* usually include a call to the superclass's version of the method:
*
* <blockquote>
* <code>super.addImpl(comp, constraints, index)</code>
* {@code super.addImpl(comp, constraints, index)}
* </blockquote>
* <p>
* This method changes layout-related information, and therefore,
@ -1073,7 +1073,7 @@ public class Container extends Component {
* @param constraints an object expressing layout constraints
* for this component
* @param index the position in the container's list at which to
* insert the component, where <code>-1</code>
* insert the component, where {@code -1}
* means append to the end
* @exception IllegalArgumentException if {@code index} is invalid;
* if {@code comp} is a child of this container, the valid
@ -1196,11 +1196,11 @@ public class Container extends Component {
}
/**
* Removes the component, specified by <code>index</code>,
* Removes the component, specified by {@code index},
* from this container.
* This method also notifies the layout manager to remove the
* component from this container's layout via the
* <code>removeLayoutComponent</code> method.
* {@code removeLayoutComponent} method.
* <p>
* This method changes layout-related information, and therefore,
* invalidates the component hierarchy. If the container has already been
@ -1263,7 +1263,7 @@ public class Container extends Component {
* Removes the specified component from this container.
* This method also notifies the layout manager to remove the
* component from this container's layout via the
* <code>removeLayoutComponent</code> method.
* {@code removeLayoutComponent} method.
* <p>
* This method changes layout-related information, and therefore,
* invalidates the component hierarchy. If the container has already been
@ -1292,7 +1292,7 @@ public class Container extends Component {
* Removes all the components from this container.
* This method also notifies the layout manager to remove the
* components from this container's layout via the
* <code>removeLayoutComponent</code> method.
* {@code removeLayoutComponent} method.
* <p>
* This method changes layout-related information, and therefore,
* invalidates the component hierarchy. If the container has already been
@ -1512,7 +1512,7 @@ public class Container extends Component {
/**
* Causes this container to lay out its components. Most programs
* should not call this method directly, but should invoke
* the <code>validate</code> method instead.
* the {@code validate} method instead.
* @see LayoutManager#layoutContainer
* @see #setLayout
* @see #validate
@ -1524,7 +1524,7 @@ public class Container extends Component {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>doLayout()</code>.
* replaced by {@code doLayout()}.
*/
@Deprecated
public void layout() {
@ -1703,7 +1703,7 @@ public class Container extends Component {
* Recursively descends the container tree and recomputes the
* layout for any subtrees marked as needing it (those marked as
* invalid). Synchronization should be provided by the method
* that calls this one: <code>validate</code>.
* that calls this one: {@code validate}.
*
* @see #doLayout
* @see #validate
@ -1791,7 +1791,7 @@ public class Container extends Component {
* this method is invoked, rather the {@code LayoutManager} will only
* be queried after the {@code Container} becomes invalid.
*
* @return an instance of <code>Dimension</code> that represents
* @return an instance of {@code Dimension} that represents
* the preferred size of this container.
* @see #getMinimumSize
* @see #getMaximumSize
@ -1805,7 +1805,7 @@ public class Container extends Component {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>getPreferredSize()</code>.
* replaced by {@code getPreferredSize()}.
*/
@Deprecated
public Dimension preferredSize() {
@ -1842,7 +1842,7 @@ public class Container extends Component {
* this method is invoked, rather the {@code LayoutManager} will only
* be queried after the {@code Container} becomes invalid.
*
* @return an instance of <code>Dimension</code> that represents
* @return an instance of {@code Dimension} that represents
* the minimum size of this container.
* @see #getPreferredSize
* @see #getMaximumSize
@ -1857,7 +1857,7 @@ public class Container extends Component {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>getMinimumSize()</code>.
* replaced by {@code getMinimumSize()}.
*/
@Deprecated
public Dimension minimumSize() {
@ -1895,7 +1895,7 @@ public class Container extends Component {
* this method is invoked, rather the {@code LayoutManager2} will only
* be queried after the {@code Container} becomes invalid.
*
* @return an instance of <code>Dimension</code> that represents
* @return an instance of {@code Dimension} that represents
* the maximum size of this container.
* @see #getPreferredSize
* @see #getMinimumSize
@ -2169,7 +2169,7 @@ public class Container extends Component {
* Returns an array of all the container listeners
* registered on this container.
*
* @return all of this container's <code>ContainerListener</code>s
* @return all of this container's {@code ContainerListener}s
* or an empty array if no container
* listeners are currently registered
*
@ -2184,16 +2184,16 @@ public class Container extends Component {
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
* upon this <code>Container</code>.
* upon this {@code Container}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
*
* <p>
* You can specify the <code>listenerType</code> argument
* You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
* <code>Container</code> <code>c</code>
* {@code Container c}
* for its container listeners with the following code:
*
* <pre>ContainerListener[] cls = (ContainerListener[])(c.getListeners(ContainerListener.class));</pre>
@ -2202,13 +2202,13 @@ public class Container extends Component {
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this container,
* or an empty array if no such listeners have been added
* @exception ClassCastException if <code>listenerType</code>
* @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
* <code>java.util.EventListener</code>
* {@code java.util.EventListener}
* @exception NullPointerException if {@code listenerType} is {@code null}
*
* @see #getContainerListeners
@ -2242,10 +2242,10 @@ public class Container extends Component {
/**
* Processes events on this container. If the event is a
* <code>ContainerEvent</code>, it invokes the
* <code>processContainerEvent</code> method, else it invokes
* its superclass's <code>processEvent</code>.
* <p>Note that if the event parameter is <code>null</code>
* {@code ContainerEvent}, it invokes the
* {@code processContainerEvent} method, else it invokes
* its superclass's {@code processEvent}.
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -2267,10 +2267,10 @@ public class Container extends Component {
* following occurs:
* <ul>
* <li>A ContainerListener object is registered via
* <code>addContainerListener</code>
* <li>Container events are enabled via <code>enableEvents</code>
* {@code addContainerListener}
* <li>Container events are enabled via {@code enableEvents}
* </ul>
* <p>Note that if the event parameter is <code>null</code>
* <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
@ -2365,11 +2365,11 @@ public class Container extends Component {
* controllable behaviors. This method searches for the top-most
* descendant of this container that contains the given coordinates
* and is accepted by the given filter. The search will be constrained to
* lightweight descendants if the last argument is <code>false</code>.
* lightweight descendants if the last argument is {@code false}.
*
* @param filter EventTargetFilter instance to determine whether the
* given component is a valid target for this event.
* @param searchHeavyweights if <code>false</code>, the method
* @param searchHeavyweights if {@code false}, the method
* will bypass heavyweight components during the search.
*/
private Component getMouseEventTarget(int x, int y, boolean includeSelf,
@ -2399,17 +2399,17 @@ public class Container extends Component {
* descendants of only lightweight children or only heavyweight children
* of this container depending on searchHeavyweightChildren. The search will
* be constrained to only lightweight descendants of the searched children
* of this container if searchHeavyweightDescendants is <code>false</code>.
* of this container if searchHeavyweightDescendants is {@code false}.
*
* @param filter EventTargetFilter instance to determine whether the
* selected component is a valid target for this event.
* @param searchHeavyweightChildren if <code>true</code>, the method
* @param searchHeavyweightChildren if {@code true}, the method
* will bypass immediate lightweight children during the search.
* If <code>false</code>, the methods will bypass immediate
* If {@code false}, the methods will bypass immediate
* heavyweight children during the search.
* @param searchHeavyweightDescendants if <code>false</code>, the method
* @param searchHeavyweightDescendants if {@code false}, the method
* will bypass heavyweight descendants which are not immediate
* children during the search. If <code>true</code>, the method
* children during the search. If {@code true}, the method
* will traverse both lightweight and heavyweight descendants during
* the search.
*/
@ -2525,7 +2525,7 @@ public class Container extends Component {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>dispatchEvent(AWTEvent e)</code>
* replaced by {@code dispatchEvent(AWTEvent e)}
*/
@Deprecated
public void deliverEvent(Event e) {
@ -2562,7 +2562,7 @@ public class Container extends Component {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>getComponentAt(int, int)</code>.
* replaced by {@code getComponentAt(int, int)}.
*/
@Deprecated
public Component locate(int x, int y) {
@ -2593,7 +2593,7 @@ public class Container extends Component {
* Gets the component that contains the specified point.
* @param p the point.
* @return returns the component that contains the point,
* or <code>null</code> if the component does
* or {@code null} if the component does
* not contain the point.
* @see Component#contains
* @since 1.1
@ -2603,22 +2603,22 @@ public class Container extends Component {
}
/**
* Returns the position of the mouse pointer in this <code>Container</code>'s
* coordinate space if the <code>Container</code> is under the mouse pointer,
* otherwise returns <code>null</code>.
* Returns the position of the mouse pointer in this {@code Container}'s
* coordinate space if the {@code Container} is under the mouse pointer,
* otherwise returns {@code null}.
* This method is similar to {@link Component#getMousePosition()} with the exception
* that it can take the <code>Container</code>'s children into account.
* If <code>allowChildren</code> is <code>false</code>, this method will return
* a non-null value only if the mouse pointer is above the <code>Container</code>
* that it can take the {@code Container}'s children into account.
* If {@code allowChildren} is {@code false}, this method will return
* a non-null value only if the mouse pointer is above the {@code Container}
* directly, not above the part obscured by children.
* If <code>allowChildren</code> is <code>true</code>, this method returns
* a non-null value if the mouse pointer is above <code>Container</code> or any
* If {@code allowChildren} is {@code true}, this method returns
* a non-null value if the mouse pointer is above {@code Container} or any
* of its descendants.
*
* @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true
* @param allowChildren true if children should be taken into account
* @see Component#getMousePosition
* @return mouse coordinates relative to this <code>Component</code>, or null
* @return mouse coordinates relative to this {@code Component}, or null
* @since 1.5
*/
public Point getMousePosition(boolean allowChildren) throws HeadlessException {
@ -2848,8 +2848,8 @@ public class Container extends Component {
* Checks if the component is contained in the component hierarchy of
* this container.
* @param c the component
* @return <code>true</code> if it is an ancestor;
* <code>false</code> otherwise.
* @return {@code true} if it is an ancestor;
* {@code false} otherwise.
* @since 1.1
*/
public boolean isAncestorOf(Component c) {
@ -2983,11 +2983,11 @@ public class Container extends Component {
/* End of JOptionPane support code */
/**
* Returns a string representing the state of this <code>Container</code>.
* Returns a string representing the state of this {@code Container}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this container
*/
@ -3005,8 +3005,8 @@ public class Container extends Component {
* stream. The listing starts at the specified indentation.
* <p>
* The immediate children of the container are printed with
* an indentation of <code>indent+1</code>. The children
* of those children are printed at <code>indent+2</code>
* an indentation of {@code indent+1}. The children
* of those children are printed at {@code indent+2}
* and so on.
*
* @param out a print stream
@ -3032,8 +3032,8 @@ public class Container extends Component {
* to the specified print writer.
* <p>
* The immediate children of the container are printed with
* an indentation of <code>indent+1</code>. The children
* of those children are printed at <code>indent+2</code>
* an indentation of {@code indent+1}. The children
* of those children are printed at {@code indent+2}
* and so on.
*
* @param out a print writer
@ -3147,7 +3147,7 @@ public class Container extends Component {
/**
* Returns the Set of focus traversal keys for a given traversal operation
* for this Container. (See
* <code>setFocusTraversalKeys</code> for a full description of each key.)
* {@code setFocusTraversalKeys} for a full description of each key.)
* <p>
* If a Set of traversal keys has not been explicitly defined for this
* Container, then this Container's parent's Set is returned. If no Set
@ -3186,16 +3186,16 @@ public class Container extends Component {
/**
* Returns whether the Set of focus traversal keys for the given focus
* traversal operation has been explicitly defined for this Container. If
* this method returns <code>false</code>, this Container is inheriting the
* this method returns {@code false}, this Container is inheriting the
* Set from an ancestor, or from the current KeyboardFocusManager.
*
* @param id one of KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
* KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS,
* KeyboardFocusManager.UP_CYCLE_TRAVERSAL_KEYS, or
* KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS
* @return <code>true</code> if the Set of focus traversal keys for the
* @return {@code true} if the Set of focus traversal keys for the
* given focus traversal operation has been explicitly defined for
* this Component; <code>false</code> otherwise.
* this Component; {@code false} otherwise.
* @throws IllegalArgumentException if id is not one of
* KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS,
* KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS,
@ -3218,12 +3218,12 @@ public class Container extends Component {
* root belongs to only a single focus traversal cycle. Containers which
* are focus cycle roots belong to two cycles: one rooted at the Container
* itself, and one rooted at the Container's nearest focus-cycle-root
* ancestor. This method will return <code>true</code> for both such
* ancestor. This method will return {@code true} for both such
* Containers in this case.
*
* @param container the Container to be tested
* @return <code>true</code> if the specified Container is a focus-cycle-
* root of this Container; <code>false</code> otherwise
* @return {@code true} if the specified Container is a focus-cycle-
* root of this Container; {@code false} otherwise
* @see #isFocusCycleRoot()
* @since 1.4
*/
@ -3390,11 +3390,11 @@ public class Container extends Component {
/**
* Returns whether the focus traversal policy has been explicitly set for
* this Container. If this method returns <code>false</code>, this
* this Container. If this method returns {@code false}, this
* Container will inherit its focus traversal policy from an ancestor.
*
* @return <code>true</code> if the focus traversal policy has been
* explicitly set for this Container; <code>false</code> otherwise.
* @return {@code true} if the focus traversal policy has been
* explicitly set for this Container; {@code false} otherwise.
* @since 1.4
*/
public boolean isFocusTraversalPolicySet() {
@ -3458,7 +3458,7 @@ public class Container extends Component {
/**
* Sets whether this container will be used to provide focus
* traversal policy. Container with this property as
* <code>true</code> will be used to acquire focus traversal policy
* {@code true} will be used to acquire focus traversal policy
* instead of closest focus cycle root ancestor.
* @param provider indicates whether this container will be used to
* provide focus traversal policy
@ -3478,7 +3478,7 @@ public class Container extends Component {
/**
* Returns whether this container provides focus traversal
* policy. If this property is set to <code>true</code> then when
* policy. If this property is set to {@code true} then when
* keyboard focus manager searches container hierarchy for focus
* traversal policy and encounters this container before any other
* container with this property as true or focus cycle roots then
@ -3488,8 +3488,8 @@ public class Container extends Component {
* @see #getFocusTraversalPolicy
* @see #setFocusCycleRoot
* @see #setFocusTraversalPolicyProvider
* @return <code>true</code> if this container provides focus traversal
* policy, <code>false</code> otherwise
* @return {@code true} if this container provides focus traversal
* policy, {@code false} otherwise
* @since 1.5
*/
public final boolean isFocusTraversalPolicyProvider() {
@ -3539,7 +3539,7 @@ public class Container extends Component {
}
/**
* Sets the <code>ComponentOrientation</code> property of this container
* Sets the {@code ComponentOrientation} property of this container
* and all components contained within it.
* <p>
* This method changes layout-related information, and therefore,
@ -3547,7 +3547,7 @@ public class Container extends Component {
*
* @param o the new component orientation of this container and
* the components contained within it.
* @exception NullPointerException if <code>orientation</code> is null.
* @exception NullPointerException if {@code orientation} is null.
* @see Component#setComponentOrientation
* @see Component#getComponentOrientation
* @see #invalidate
@ -3650,26 +3650,26 @@ public class Container extends Component {
private int containerSerializedDataVersion = 1;
/**
* Serializes this <code>Container</code> to the specified
* <code>ObjectOutputStream</code>.
* Serializes this {@code Container} to the specified
* {@code ObjectOutputStream}.
* <ul>
* <li>Writes default serializable fields to the stream.</li>
* <li>Writes a list of serializable ContainerListener(s) as optional
* data. The non-serializable ContainerListener(s) are detected and
* no attempt is made to serialize them.</li>
* <li>Write this Container's FocusTraversalPolicy if and only if it
* is Serializable; otherwise, <code>null</code> is written.</li>
* is Serializable; otherwise, {@code null} is written.</li>
* </ul>
*
* @param s the <code>ObjectOutputStream</code> to write
* @serialData <code>null</code> terminated sequence of 0 or more pairs;
* the pair consists of a <code>String</code> and <code>Object</code>;
* the <code>String</code> indicates the type of object and
* @param s the {@code ObjectOutputStream} to write
* @serialData {@code null} terminated sequence of 0 or more pairs;
* the pair consists of a {@code String} and {@code Object};
* the {@code String} indicates the type of object and
* is one of the following:
* <code>containerListenerK</code> indicating an
* <code>ContainerListener</code> object;
* the <code>Container</code>'s <code>FocusTraversalPolicy</code>,
* or <code>null</code>
* {@code containerListenerK} indicating an
* {@code ContainerListener} object;
* the {@code Container}'s {@code FocusTraversalPolicy},
* or {@code null}
*
* @see AWTEventMulticaster#save(java.io.ObjectOutputStream, java.lang.String, java.util.EventListener)
* @see Container#containerListenerK
@ -3698,8 +3698,8 @@ public class Container extends Component {
}
/**
* Deserializes this <code>Container</code> from the specified
* <code>ObjectInputStream</code>.
* Deserializes this {@code Container} from the specified
* {@code ObjectInputStream}.
* <ul>
* <li>Reads default serializable fields from the stream.</li>
* <li>Reads a list of serializable ContainerListener(s) as optional
@ -3708,7 +3708,7 @@ public class Container extends Component {
* as optional data.</li>
* </ul>
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
* @serial
* @see #addContainerListener
* @see #writeObject(ObjectOutputStream)
@ -3796,7 +3796,7 @@ public class Container extends Component {
/**
* Returns the number of accessible children in the object. If all
* of the children of this object implement <code>Accessible</code>,
* of the children of this object implement {@code Accessible},
* then this method should return the number of children of this object.
*
* @return the number of accessible children in the object
@ -3806,24 +3806,24 @@ public class Container extends Component {
}
/**
* Returns the nth <code>Accessible</code> child of the object.
* Returns the nth {@code Accessible} child of the object.
*
* @param i zero-based index of child
* @return the nth <code>Accessible</code> child of the object
* @return the nth {@code Accessible} child of the object
*/
public Accessible getAccessibleChild(int i) {
return Container.this.getAccessibleChild(i);
}
/**
* Returns the <code>Accessible</code> child, if one exists,
* contained at the local coordinate <code>Point</code>.
* Returns the {@code Accessible} child, if one exists,
* contained at the local coordinate {@code Point}.
*
* @param p the point defining the top-left corner of the
* <code>Accessible</code>, given in the coordinate space
* {@code Accessible}, given in the coordinate space
* of the object's parent
* @return the <code>Accessible</code>, if it exists,
* at the specified location; else <code>null</code>
* @return the {@code Accessible}, if it exists,
* at the specified location; else {@code null}
*/
public Accessible getAccessibleAt(Point p) {
return Container.this.getAccessibleAt(p);
@ -3842,7 +3842,7 @@ public class Container extends Component {
protected ContainerListener accessibleContainerHandler = null;
/**
* Fire <code>PropertyChange</code> listener, if one is registered,
* Fire {@code PropertyChange} listener, if one is registered,
* when children are added or removed.
* @since 1.3
*/
@ -3898,15 +3898,15 @@ public class Container extends Component {
} // inner class AccessibleAWTContainer
/**
* Returns the <code>Accessible</code> child contained at the local
* coordinate <code>Point</code>, if one exists. Otherwise
* returns <code>null</code>.
* Returns the {@code Accessible} child contained at the local
* coordinate {@code Point}, if one exists. Otherwise
* returns {@code null}.
*
* @param p the point defining the top-left corner of the
* <code>Accessible</code>, given in the coordinate space
* {@code Accessible}, given in the coordinate space
* of the object's parent
* @return the <code>Accessible</code> at the specified location,
* if it exists; otherwise <code>null</code>
* @return the {@code Accessible} at the specified location,
* if it exists; otherwise {@code null}
*/
Accessible getAccessibleAt(Point p) {
synchronized (getTreeLock()) {
@ -3962,7 +3962,7 @@ public class Container extends Component {
/**
* Returns the number of accessible children in the object. If all
* of the children of this object implement <code>Accessible</code>,
* of the children of this object implement {@code Accessible},
* then this method should return the number of children of this object.
*
* @return the number of accessible children in the object
@ -3981,10 +3981,10 @@ public class Container extends Component {
}
/**
* Returns the nth <code>Accessible</code> child of the object.
* Returns the nth {@code Accessible} child of the object.
*
* @param i zero-based index of child
* @return the nth <code>Accessible</code> child of the object
* @return the nth {@code Accessible} child of the object
*/
Accessible getAccessibleChild(int i) {
synchronized (getTreeLock()) {

24
jdk/src/java.desktop/share/classes/java/awt/ContainerOrderFocusTraversalPolicy.java
View file

@ -33,18 +33,18 @@ import sun.util.logging.PlatformLogger;
* of child Components in a Container. From a particular focus cycle root, the
* policy makes a pre-order traversal of the Component hierarchy, and traverses
* a Container's children according to the ordering of the array returned by
* <code>Container.getComponents()</code>. Portions of the hierarchy that are
* {@code Container.getComponents()}. Portions of the hierarchy that are
* not visible and displayable will not be searched.
* <p>
* By default, ContainerOrderFocusTraversalPolicy implicitly transfers focus
* down-cycle. That is, during normal forward focus traversal, the Component
* traversed after a focus cycle root will be the focus-cycle-root's default
* Component to focus. This behavior can be disabled using the
* <code>setImplicitDownCycleTraversal</code> method.
* {@code setImplicitDownCycleTraversal} method.
* <p>
* By default, methods of this class will return a Component only if it is
* visible, displayable, enabled, and focusable. Subclasses can modify this
* behavior by overriding the <code>accept</code> method.
* behavior by overriding the {@code accept} method.
* <p>
* This policy takes into account <a
* href="doc-files/FocusSpec.html#FocusTraversalPolicyProviders">focus traversal
@ -193,7 +193,7 @@ public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy
* focus down-cycle. That is, during normal forward focus traversal, the
* Component traversed after a focus cycle root will be the focus-cycle-
* root's default Component to focus. This behavior can be disabled using
* the <code>setImplicitDownCycleTraversal</code> method.
* the {@code setImplicitDownCycleTraversal} method.
* <p>
* If aContainer is <a href="doc-files/FocusSpec.html#FocusTraversalPolicyProviders">focus
* traversal policy provider</a>, the focus is always transferred down-cycle.
@ -519,7 +519,7 @@ public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy
* Returns the default Component to focus. This Component will be the first
* to receive focus when traversing down into a new focus traversal cycle
* rooted at aContainer. The default implementation of this method
* returns the same Component as <code>getFirstComponent</code>.
* returns the same Component as {@code getFirstComponent}.
*
* @param aContainer the focus cycle root or focus traversal policy provider whose default
* Component is to be returned
@ -534,12 +534,12 @@ public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy
/**
* Sets whether this ContainerOrderFocusTraversalPolicy transfers focus
* down-cycle implicitly. If <code>true</code>, during normal forward focus
* down-cycle implicitly. If {@code true}, during normal forward focus
* traversal, the Component traversed after a focus cycle root will be the
* focus-cycle-root's default Component to focus. If <code>false</code>,
* focus-cycle-root's default Component to focus. If {@code false},
* the next Component in the focus traversal cycle rooted at the specified
* focus cycle root will be traversed instead. The default value for this
* property is <code>true</code>.
* property is {@code true}.
*
* @param implicitDownCycleTraversal whether this
* ContainerOrderFocusTraversalPolicy transfers focus down-cycle
@ -553,9 +553,9 @@ public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy
/**
* Returns whether this ContainerOrderFocusTraversalPolicy transfers focus
* down-cycle implicitly. If <code>true</code>, during normal forward focus
* down-cycle implicitly. If {@code true}, during normal forward focus
* traversal, the Component traversed after a focus cycle root will be the
* focus-cycle-root's default Component to focus. If <code>false</code>,
* focus-cycle-root's default Component to focus. If {@code false},
* the next Component in the focus traversal cycle rooted at the specified
* focus cycle root will be traversed instead.
*
@ -575,8 +575,8 @@ public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy
*
* @param aComponent the Component whose fitness as a focus owner is to
* be tested
* @return <code>true</code> if aComponent is visible, displayable,
* enabled, and focusable; <code>false</code> otherwise
* @return {@code true} if aComponent is visible, displayable,
* enabled, and focusable; {@code false} otherwise
*/
protected boolean accept(Component aComponent) {
if (!aComponent.canBeFocusOwner()) {

4
jdk/src/java.desktop/share/classes/java/awt/Cursor.java
View file

@ -146,7 +146,7 @@ public class Cursor implements java.io.Serializable {
/**
* The chosen cursor type initially set to
* the <code>DEFAULT_CURSOR</code>.
* the {@code DEFAULT_CURSOR}.
*
* @serial
* @see #getType()
@ -283,7 +283,7 @@ public class Cursor implements java.io.Serializable {
* @param name a string describing the desired system-specific custom cursor
* @return the system specific custom cursor named
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code> returns true
* {@code GraphicsEnvironment.isHeadless} returns true
* @exception AWTException in case of erroneous retrieving of the cursor
*/
public static Cursor getSystemCustomCursor(final String name)

18
jdk/src/java.desktop/share/classes/java/awt/DefaultFocusTraversalPolicy.java
View file

@ -32,13 +32,13 @@ import java.awt.peer.ComponentPeer;
* of child Components in a Container. From a particular focus cycle root, the
* policy makes a pre-order traversal of the Component hierarchy, and traverses
* a Container's children according to the ordering of the array returned by
* <code>Container.getComponents()</code>. Portions of the hierarchy that are
* {@code Container.getComponents()}. Portions of the hierarchy that are
* not visible and displayable will not be searched.
* <p>
* If client code has explicitly set the focusability of a Component by either
* overriding <code>Component.isFocusTraversable()</code> or
* <code>Component.isFocusable()</code>, or by calling
* <code>Component.setFocusable()</code>, then a DefaultFocusTraversalPolicy
* overriding {@code Component.isFocusTraversable()} or
* {@code Component.isFocusable()}, or by calling
* {@code Component.setFocusable()}, then a DefaultFocusTraversalPolicy
* behaves exactly like a ContainerOrderFocusTraversalPolicy. If, however, the
* Component is relying on default focusability, then a
* DefaultFocusTraversalPolicy will reject all Components with non-focusable
@ -80,9 +80,9 @@ public class DefaultFocusTraversalPolicy
* focus owner. The Component must be visible, displayable, and enabled
* to be accepted. If client code has explicitly set the focusability
* of the Component by either overriding
* <code>Component.isFocusTraversable()</code> or
* <code>Component.isFocusable()</code>, or by calling
* <code>Component.setFocusable()</code>, then the Component will be
* {@code Component.isFocusTraversable()} or
* {@code Component.isFocusable()}, or by calling
* {@code Component.setFocusable()}, then the Component will be
* accepted if and only if it is focusable. If, however, the Component is
* relying on default focusability, then all Canvases, Labels, Panels,
* Scrollbars, ScrollPanes, Windows, and lightweight Components will be
@ -90,8 +90,8 @@ public class DefaultFocusTraversalPolicy
*
* @param aComponent the Component whose fitness as a focus owner is to
* be tested
* @return <code>true</code> if aComponent meets the above requirements;
* <code>false</code> otherwise
* @return {@code true} if aComponent meets the above requirements;
* {@code false} otherwise
*/
protected boolean accept(Component aComponent) {
if (!(aComponent.isVisible() && aComponent.isDisplayable() &&

34
jdk/src/java.desktop/share/classes/java/awt/DefaultKeyboardFocusManager.java
View file

@ -309,12 +309,12 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
* related to focus, and all KeyEvents. These events are dispatched based
* on the KeyboardFocusManager's notion of the focus owner and the focused
* and active Windows, sometimes overriding the source of the specified
* AWTEvent. If this method returns <code>false</code>, then the AWT event
* AWTEvent. If this method returns {@code false}, then the AWT event
* dispatcher will attempt to dispatch the event itself.
*
* @param e the AWTEvent to be dispatched
* @return <code>true</code> if this method dispatched the event;
* <code>false</code> otherwise
* @return {@code true} if this method dispatched the event;
* {@code false} otherwise
*/
public boolean dispatchEvent(AWTEvent e) {
if (focusLog.isLoggable(PlatformLogger.Level.FINE) && (e instanceof WindowEvent || e instanceof FocusEvent)) {
@ -778,7 +778,7 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
}
/**
* Called by <code>dispatchEvent</code> if no other
* Called by {@code dispatchEvent} if no other
* KeyEventDispatcher in the dispatcher chain dispatched the KeyEvent, or
* if no other KeyEventDispatchers are registered. If the event has not
* been consumed, its target is enabled, and the focus owner is not null,
@ -787,13 +787,13 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
* KeyEventPostProcessors. After all this operations are finished,
* the event is passed to peers for processing.
* <p>
* In all cases, this method returns <code>true</code>, since
* In all cases, this method returns {@code true}, since
* DefaultKeyboardFocusManager is designed so that neither
* <code>dispatchEvent</code>, nor the AWT event dispatcher, should take
* {@code dispatchEvent}, nor the AWT event dispatcher, should take
* further action on the event in any situation.
*
* @param e the KeyEvent to be dispatched
* @return <code>true</code>
* @return {@code true}
* @see Component#dispatchEvent
*/
public boolean dispatchKeyEvent(KeyEvent e) {
@ -841,13 +841,13 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
}
/**
* This method will be called by <code>dispatchKeyEvent</code>. It will
* This method will be called by {@code dispatchKeyEvent}. It will
* handle any unconsumed KeyEvents that map to an AWT
* <code>MenuShortcut</code> by consuming the event and activating the
* {@code MenuShortcut} by consuming the event and activating the
* shortcut.
*
* @param e the KeyEvent to post-process
* @return <code>true</code>
* @return {@code true}
* @see #dispatchKeyEvent
* @see MenuShortcut
*/
@ -998,7 +998,7 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
}
/**
* Returns true if there are some marker associated with component <code>comp</code>
* Returns true if there are some marker associated with component {@code comp}
* in a markers' queue
* @since 1.5
*/
@ -1201,7 +1201,7 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
* the focus owner. KeyEvents with timestamps later than the specified
* timestamp will be enqueued until the specified Component receives a
* FOCUS_GAINED event, or the AWT cancels the delay request by invoking
* <code>dequeueKeyEvents</code> or <code>discardKeyEvents</code>.
* {@code dequeueKeyEvents} or {@code discardKeyEvents}.
*
* @param after timestamp of current event, or the current, system time if
* the current event has no timestamp, or the AWT cannot determine
@ -1241,15 +1241,15 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
/**
* Releases for normal dispatching to the current focus owner all
* KeyEvents which were enqueued because of a call to
* <code>enqueueKeyEvents</code> with the same timestamp and Component.
* {@code enqueueKeyEvents} with the same timestamp and Component.
* If the given timestamp is less than zero, the outstanding enqueue
* request for the given Component with the <b>oldest</b> timestamp (if
* any) should be cancelled.
*
* @param after the timestamp specified in the call to
* <code>enqueueKeyEvents</code>, or any value &lt; 0
* {@code enqueueKeyEvents}, or any value &lt; 0
* @param untilFocused the Component specified in the call to
* <code>enqueueKeyEvents</code>
* {@code enqueueKeyEvents}
* @see #enqueueKeyEvents
* @see #discardKeyEvents
*/
@ -1292,11 +1292,11 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager {
/**
* Discards all KeyEvents which were enqueued because of one or more calls
* to <code>enqueueKeyEvents</code> with the specified Component, or one of
* to {@code enqueueKeyEvents} with the specified Component, or one of
* its descendants.
*
* @param comp the Component specified in one or more calls to
* <code>enqueueKeyEvents</code>, or a parent of such a Component
* {@code enqueueKeyEvents}, or a parent of such a Component
* @see #enqueueKeyEvents
* @see #dequeueKeyEvents
*/

28
jdk/src/java.desktop/share/classes/java/awt/Desktop.java
View file

@ -127,7 +127,7 @@ public class Desktop {
}
/**
* Returns the <code>Desktop</code> instance of the current
* Returns the {@code Desktop} instance of the current
* browser context. On some platforms the Desktop API may not be
* supported; use the {@link #isDesktopSupported} method to
* determine if the current desktop is supported.
@ -162,8 +162,8 @@ public class Desktop {
* If it's supported, use {@link #getDesktop()} to retrieve an
* instance.
*
* @return <code>true</code> if this class is supported on the
* current platform; <code>false</code> otherwise
* @return {@code true} if this class is supported on the
* current platform; {@code false} otherwise
* @see #getDesktop()
*/
public static boolean isDesktopSupported(){
@ -186,8 +186,8 @@ public class Desktop {
* action method will throw an {@link IOException}.
*
* @param action the specified {@link Action}
* @return <code>true</code> if the specified action is supported on
* the current platform; <code>false</code> otherwise
* @return {@code true} if the specified action is supported on
* the current platform; {@code false} otherwise
* @see Desktop.Action
*/
public boolean isSupported(Action action) {
@ -230,8 +230,8 @@ public class Desktop {
/**
* Calls to the security manager's <code>checkPermission</code> method with
* an <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* Calls to the security manager's {@code checkPermission} method with
* an {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission.
*/
private void checkAWTPermission(){
@ -259,7 +259,7 @@ public class Desktop {
* @throws SecurityException if a security manager exists and its
* {@link java.lang.SecurityManager#checkRead(java.lang.String)}
* method denies read access to the file, or it denies the
* <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
@ -290,7 +290,7 @@ public class Desktop {
* method denies read access to the file, or {@link
* java.lang.SecurityManager#checkWrite(java.lang.String)} method
* denies write access to the file, or it denies the
* <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
@ -361,7 +361,7 @@ public class Desktop {
* failed to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission, or the calling thread is not allowed to create a
* subprocess; and not invoked from within an applet or Java Web Started
* application
@ -415,7 +415,7 @@ public class Desktop {
* found, or it fails to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.awt.AWTPermission
@ -438,7 +438,7 @@ public class Desktop {
* client, filling the message fields specified by a {@code
* mailto:} URI.
*
* <p> A <code>mailto:</code> URI can specify message fields
* <p> A {@code mailto:} URI can specify message fields
* including <i>"to"</i>, <i>"cc"</i>, <i>"subject"</i>,
* <i>"body"</i>, etc. See <a
* href="http://www.ietf.org/rfc/rfc2368.txt">The mailto URL
@ -449,14 +449,14 @@ public class Desktop {
* @throws NullPointerException if the specified URI is {@code
* null}
* @throws IllegalArgumentException if the URI scheme is not
* <code>"mailto"</code>
* {@code "mailto"}
* @throws UnsupportedOperationException if the current platform
* does not support the {@link Desktop.Action#MAIL} action
* @throws IOException if the user default mail client is not
* found or fails to be launched
* @throws SecurityException if a security manager exists and it
* denies the
* <code>AWTPermission("showWindowWithoutWarningBanner")</code>
* {@code AWTPermission("showWindowWithoutWarningBanner")}
* permission, or the calling thread is not allowed to create a
* subprocess
* @see java.net.URI

356
jdk/src/java.desktop/share/classes/java/awt/Dialog.java
View file

@ -46,22 +46,22 @@ import java.security.AccessControlException;
*
* The size of the dialog includes any area designated for the
* border. The dimensions of the border area can be obtained
* using the <code>getInsets</code> method, however, since
* using the {@code getInsets} method, however, since
* these dimensions are platform-dependent, a valid insets
* value cannot be obtained until the dialog is made displayable
* by either calling <code>pack</code> or <code>show</code>.
* by either calling {@code pack} or {@code show}.
* Since the border area is included in the overall size of the
* dialog, the border effectively obscures a portion of the dialog,
* constraining the area available for rendering and/or displaying
* subcomponents to the rectangle which has an upper-left corner
* location of <code>(insets.left, insets.top)</code>, and has a size of
* <code>width - (insets.left + insets.right)</code> by
* <code>height - (insets.top + insets.bottom)</code>.
* location of {@code (insets.left, insets.top)}, and has a size of
* {@code width - (insets.left + insets.right)} by
* {@code height - (insets.top + insets.bottom)}.
* <p>
* The default layout for a dialog is <code>BorderLayout</code>.
* The default layout for a dialog is {@code BorderLayout}.
* <p>
* A dialog may have its native decorations (i.e. Frame &amp; Titlebar) turned off
* with <code>setUndecorated</code>. This can only be done while the dialog
* with {@code setUndecorated}. This can only be done while the dialog
* is not {@link Component#isDisplayable() displayable}.
* <p>
* A dialog may have another window as its owner when it's constructed. When
@ -69,7 +69,7 @@ import java.security.AccessControlException;
* automatically be hidden from the user. When the owner window is subsequently
* restored, the dialog is made visible to the user again.
* <p>
* In a multi-screen environment, you can create a <code>Dialog</code>
* In a multi-screen environment, you can create a {@code Dialog}
* on a different screen device than its owner. See {@link java.awt.Frame} for
* more information.
* <p>
@ -80,11 +80,11 @@ import java.security.AccessControlException;
* specification for details.
* <p>
* Dialogs are capable of generating the following
* <code>WindowEvents</code>:
* <code>WindowOpened</code>, <code>WindowClosing</code>,
* <code>WindowClosed</code>, <code>WindowActivated</code>,
* <code>WindowDeactivated</code>, <code>WindowGainedFocus</code>,
* <code>WindowLostFocus</code>.
* {@code WindowEvents}:
* {@code WindowOpened}, {@code WindowClosing},
* {@code WindowClosed}, {@code WindowActivated},
* {@code WindowDeactivated}, {@code WindowGainedFocus},
* {@code WindowLostFocus}.
*
* @see WindowEvent
* @see Window#addWindowListener
@ -117,7 +117,7 @@ public class Dialog extends Window {
/**
* This field indicates whether the dialog is undecorated.
* This property can only be changed while the dialog is not displayable.
* <code>undecorated</code> will be true if the dialog is
* {@code undecorated} will be true if the dialog is
* undecorated, otherwise it will be false.
*
* @serial
@ -134,7 +134,7 @@ public class Dialog extends Window {
* Modal dialogs block all input to some top-level windows.
* Whether a particular window is blocked depends on dialog's type
* of modality; this is called the "scope of blocking". The
* <code>ModalityType</code> enum specifies modal types and their
* {@code ModalityType} enum specifies modal types and their
* associated scopes.
*
* @see Dialog#getModalityType
@ -145,11 +145,11 @@ public class Dialog extends Window {
*/
public static enum ModalityType {
/**
* <code>MODELESS</code> dialog doesn't block any top-level windows.
* {@code MODELESS} dialog doesn't block any top-level windows.
*/
MODELESS,
/**
* A <code>DOCUMENT_MODAL</code> dialog blocks input to all top-level windows
* A {@code DOCUMENT_MODAL} dialog blocks input to all top-level windows
* from the same document except those from its own child hierarchy.
* A document is a top-level window without an owner. It may contain child
* windows that, together with the top-level window are treated as a single
@ -158,7 +158,7 @@ public class Dialog extends Window {
*/
DOCUMENT_MODAL,
/**
* An <code>APPLICATION_MODAL</code> dialog blocks all top-level windows
* An {@code APPLICATION_MODAL} dialog blocks all top-level windows
* from the same Java application except those from its own child hierarchy.
* If there are several applets launched in a browser, they can be
* treated either as separate applications or a single one. This behavior
@ -166,18 +166,18 @@ public class Dialog extends Window {
*/
APPLICATION_MODAL,
/**
* A <code>TOOLKIT_MODAL</code> dialog blocks all top-level windows run
* A {@code TOOLKIT_MODAL} dialog blocks all top-level windows run
* from the same toolkit except those from its own child hierarchy. If there
* are several applets launched in a browser, all of them run with the same
* toolkit; thus, a toolkit-modal dialog displayed by an applet may affect
* other applets and all windows of the browser instance which embeds the
* Java runtime environment for this toolkit.
* Special <code>AWTPermission</code> "toolkitModality" must be granted to use
* toolkit-modal dialogs. If a <code>TOOLKIT_MODAL</code> dialog is being created
* and this permission is not granted, a <code>SecurityException</code> will be
* Special {@code AWTPermission} "toolkitModality" must be granted to use
* toolkit-modal dialogs. If a {@code TOOLKIT_MODAL} dialog is being created
* and this permission is not granted, a {@code SecurityException} will be
* thrown, and no dialog will be created. If a modality type is being changed
* to <code>TOOLKIT_MODAL</code> and this permission is not granted, a
* <code>SecurityException</code> will be thrown, and the modality type will
* to {@code TOOLKIT_MODAL} and this permission is not granted, a
* {@code SecurityException} will be thrown, and the modality type will
* be left unchanged.
*/
TOOLKIT_MODAL
@ -185,8 +185,8 @@ public class Dialog extends Window {
/**
* Default modality type for modal dialogs. The default modality type is
* <code>APPLICATION_MODAL</code>. Calling the oldstyle <code>setModal(true)</code>
* is equal to <code>setModalityType(DEFAULT_MODALITY_TYPE)</code>.
* {@code APPLICATION_MODAL}. Calling the oldstyle {@code setModal(true)}
* is equal to {@code setModalityType(DEFAULT_MODALITY_TYPE)}.
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog#setModal
@ -245,20 +245,20 @@ public class Dialog extends Window {
*/
NO_EXCLUDE,
/**
* <code>APPLICATION_EXCLUDE</code> indicates that a top-level window
* {@code APPLICATION_EXCLUDE} indicates that a top-level window
* won't be blocked by any application-modal dialogs. Also, it isn't
* blocked by document-modal dialogs from outside of its child hierarchy.
*/
APPLICATION_EXCLUDE,
/**
* <code>TOOLKIT_EXCLUDE</code> indicates that a top-level window
* {@code TOOLKIT_EXCLUDE} indicates that a top-level window
* won't be blocked by application-modal or toolkit-modal dialogs. Also,
* it isn't blocked by document-modal dialogs from outside of its
* child hierarchy.
* The "toolkitModality" <code>AWTPermission</code> must be granted
* The "toolkitModality" {@code AWTPermission} must be granted
* for this exclusion. If an exclusion property is being changed to
* <code>TOOLKIT_EXCLUDE</code> and this permission is not granted, a
* <code>SecurityException</code> will be thrown, and the exclusion
* {@code TOOLKIT_EXCLUDE} and this permission is not granted, a
* {@code SecurityException} will be thrown, and the exclusion
* property will be left unchanged.
*/
TOOLKIT_EXCLUDE
@ -313,15 +313,15 @@ public class Dialog extends Window {
private static final long serialVersionUID = 5920926903803293709L;
/**
* Constructs an initially invisible, modeless <code>Dialog</code> with
* the specified owner <code>Frame</code> and an empty title.
* Constructs an initially invisible, modeless {@code Dialog} with
* the specified owner {@code Frame} and an empty title.
*
* @param owner the owner of the dialog or <code>null</code> if
* @param owner the owner of the dialog or {@code null} if
* this dialog has no owner
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.GraphicsEnvironment#isHeadless
* @see Component#setSize
@ -332,19 +332,19 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the specified
* owner <code>Frame</code> and modality and an empty title.
* Constructs an initially invisible {@code Dialog} with the specified
* owner {@code Frame} and modality and an empty title.
*
* @param owner the owner of the dialog or <code>null</code> if
* @param owner the owner of the dialog or {@code null} if
* this dialog has no owner
* @param modal specifies whether dialog blocks user input to other top-level
* windows when shown. If <code>false</code>, the dialog is <code>MODELESS</code>;
* if <code>true</code>, the modality type property is set to
* <code>DEFAULT_MODALITY_TYPE</code>
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* windows when shown. If {@code false}, the dialog is {@code MODELESS};
* if {@code true}, the modality type property is set to
* {@code DEFAULT_MODALITY_TYPE}
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog.ModalityType#MODELESS
@ -358,17 +358,17 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible, modeless <code>Dialog</code> with
* the specified owner <code>Frame</code> and title.
* Constructs an initially invisible, modeless {@code Dialog} with
* the specified owner {@code Frame} and title.
*
* @param owner the owner of the dialog or <code>null</code> if
* @param owner the owner of the dialog or {@code null} if
* this dialog has no owner
* @param title the title of the dialog or <code>null</code> if this dialog
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @exception IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.GraphicsEnvironment#isHeadless
* @see Component#setSize
@ -379,21 +379,21 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Frame</code>, title and modality.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Frame}, title and modality.
*
* @param owner the owner of the dialog or <code>null</code> if
* @param owner the owner of the dialog or {@code null} if
* this dialog has no owner
* @param title the title of the dialog or <code>null</code> if this dialog
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @param modal specifies whether dialog blocks user input to other top-level
* windows when shown. If <code>false</code>, the dialog is <code>MODELESS</code>;
* if <code>true</code>, the modality type property is set to
* <code>DEFAULT_MODALITY_TYPE</code>
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* windows when shown. If {@code false}, the dialog is {@code MODELESS};
* if {@code true}, the modality type property is set to
* {@code DEFAULT_MODALITY_TYPE}
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog.ModalityType#MODELESS
@ -409,23 +409,23 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the specified owner
* <code>Frame</code>, title, modality, and <code>GraphicsConfiguration</code>.
* @param owner the owner of the dialog or <code>null</code> if this dialog
* Constructs an initially invisible {@code Dialog} with the specified owner
* {@code Frame}, title, modality, and {@code GraphicsConfiguration}.
* @param owner the owner of the dialog or {@code null} if this dialog
* has no owner
* @param title the title of the dialog or <code>null</code> if this dialog
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @param modal specifies whether dialog blocks user input to other top-level
* windows when shown. If <code>false</code>, the dialog is <code>MODELESS</code>;
* if <code>true</code>, the modality type property is set to
* <code>DEFAULT_MODALITY_TYPE</code>
* @param gc the <code>GraphicsConfiguration</code> of the target screen device;
* if <code>null</code>, the default system <code>GraphicsConfiguration</code>
* windows when shown. If {@code false}, the dialog is {@code MODELESS};
* if {@code true}, the modality type property is set to
* {@code DEFAULT_MODALITY_TYPE}
* @param gc the {@code GraphicsConfiguration} of the target screen device;
* if {@code null}, the default system {@code GraphicsConfiguration}
* is assumed
* @exception java.lang.IllegalArgumentException if <code>gc</code>
* @exception java.lang.IllegalArgumentException if {@code gc}
* is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog.ModalityType#MODELESS
@ -443,15 +443,15 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible, modeless <code>Dialog</code> with
* the specified owner <code>Dialog</code> and an empty title.
* Constructs an initially invisible, modeless {@code Dialog} with
* the specified owner {@code Dialog} and an empty title.
*
* @param owner the owner of the dialog or <code>null</code> if this
* @param owner the owner of the dialog or {@code null} if this
* dialog has no owner
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.2
*/
@ -460,17 +460,17 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible, modeless <code>Dialog</code>
* with the specified owner <code>Dialog</code> and title.
* Constructs an initially invisible, modeless {@code Dialog}
* with the specified owner {@code Dialog} and title.
*
* @param owner the owner of the dialog or <code>null</code> if this
* @param owner the owner of the dialog or {@code null} if this
* has no owner
* @param title the title of the dialog or <code>null</code> if this dialog
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.2
@ -480,21 +480,21 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Dialog</code>, title, and modality.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Dialog}, title, and modality.
*
* @param owner the owner of the dialog or <code>null</code> if this
* @param owner the owner of the dialog or {@code null} if this
* dialog has no owner
* @param title the title of the dialog or <code>null</code> if this
* @param title the title of the dialog or {@code null} if this
* dialog has no title
* @param modal specifies whether dialog blocks user input to other top-level
* windows when shown. If <code>false</code>, the dialog is <code>MODELESS</code>;
* if <code>true</code>, the modality type property is set to
* <code>DEFAULT_MODALITY_TYPE</code>
* @exception IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* windows when shown. If {@code false}, the dialog is {@code MODELESS};
* if {@code true}, the modality type property is set to
* {@code DEFAULT_MODALITY_TYPE}
* @exception IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog.ModalityType#MODELESS
@ -510,25 +510,25 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Dialog</code>, title, modality and
* <code>GraphicsConfiguration</code>.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Dialog}, title, modality and
* {@code GraphicsConfiguration}.
*
* @param owner the owner of the dialog or <code>null</code> if this
* @param owner the owner of the dialog or {@code null} if this
* dialog has no owner
* @param title the title of the dialog or <code>null</code> if this
* @param title the title of the dialog or {@code null} if this
* dialog has no title
* @param modal specifies whether dialog blocks user input to other top-level
* windows when shown. If <code>false</code>, the dialog is <code>MODELESS</code>;
* if <code>true</code>, the modality type property is set to
* <code>DEFAULT_MODALITY_TYPE</code>
* @param gc the <code>GraphicsConfiguration</code> of the target screen device;
* if <code>null</code>, the default system <code>GraphicsConfiguration</code>
* windows when shown. If {@code false}, the dialog is {@code MODELESS};
* if {@code true}, the modality type property is set to
* {@code DEFAULT_MODALITY_TYPE}
* @param gc the {@code GraphicsConfiguration} of the target screen device;
* if {@code null}, the default system {@code GraphicsConfiguration}
* is assumed
* @exception java.lang.IllegalArgumentException if <code>gc</code>
* @exception java.lang.IllegalArgumentException if {@code gc}
* is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog.ModalityType#MODELESS
@ -547,20 +547,20 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible, modeless <code>Dialog</code> with the
* specified owner <code>Window</code> and an empty title.
* Constructs an initially invisible, modeless {@code Dialog} with the
* specified owner {@code Window} and an empty title.
*
* @param owner the owner of the dialog. The owner must be an instance of
* {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any
* of their descendants or <code>null</code>
* of their descendants or {@code null}
*
* @exception java.lang.IllegalArgumentException if the <code>owner</code>
* @exception java.lang.IllegalArgumentException if the {@code owner}
* is not an instance of {@link java.awt.Dialog Dialog} or {@link
* java.awt.Frame Frame}
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.GraphicsEnvironment#isHeadless
*
@ -571,22 +571,22 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible, modeless <code>Dialog</code> with
* the specified owner <code>Window</code> and title.
* Constructs an initially invisible, modeless {@code Dialog} with
* the specified owner {@code Window} and title.
*
* @param owner the owner of the dialog. The owner must be an instance of
* {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any
* of their descendants or <code>null</code>
* @param title the title of the dialog or <code>null</code> if this dialog
* of their descendants or {@code null}
* @param title the title of the dialog or {@code null} if this dialog
* has no title
*
* @exception java.lang.IllegalArgumentException if the <code>owner</code>
* @exception java.lang.IllegalArgumentException if the {@code owner}
* is not an instance of {@link java.awt.Dialog Dialog} or {@link
* java.awt.Frame Frame}
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
*
* @see java.awt.GraphicsEnvironment#isHeadless
*
@ -597,25 +597,25 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Window</code> and modality and an empty title.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Window} and modality and an empty title.
*
* @param owner the owner of the dialog. The owner must be an instance of
* {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any
* of their descendants or <code>null</code>
* of their descendants or {@code null}
* @param modalityType specifies whether dialog blocks input to other
* windows when shown. <code>null</code> value and unsupported modality
* types are equivalent to <code>MODELESS</code>
* windows when shown. {@code null} value and unsupported modality
* types are equivalent to {@code MODELESS}
*
* @exception java.lang.IllegalArgumentException if the <code>owner</code>
* @exception java.lang.IllegalArgumentException if the {@code owner}
* is not an instance of {@link java.awt.Dialog Dialog} or {@link
* java.awt.Frame Frame}
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @exception SecurityException if the calling thread does not have permission
* to create modal dialogs with the given <code>modalityType</code>
* to create modal dialogs with the given {@code modalityType}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog#setModal
@ -630,27 +630,27 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Window</code>, title and modality.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Window}, title and modality.
*
* @param owner the owner of the dialog. The owner must be an instance of
* {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any
* of their descendants or <code>null</code>
* @param title the title of the dialog or <code>null</code> if this dialog
* of their descendants or {@code null}
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @param modalityType specifies whether dialog blocks input to other
* windows when shown. <code>null</code> value and unsupported modality
* types are equivalent to <code>MODELESS</code>
* windows when shown. {@code null} value and unsupported modality
* types are equivalent to {@code MODELESS}
*
* @exception java.lang.IllegalArgumentException if the <code>owner</code>
* @exception java.lang.IllegalArgumentException if the {@code owner}
* is not an instance of {@link java.awt.Dialog Dialog} or {@link
* java.awt.Frame Frame}
* @exception java.lang.IllegalArgumentException if the <code>owner</code>'s
* <code>GraphicsConfiguration</code> is not from a screen device
* @exception java.lang.IllegalArgumentException if the {@code owner}'s
* {@code GraphicsConfiguration} is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @exception SecurityException if the calling thread does not have permission
* to create modal dialogs with the given <code>modalityType</code>
* to create modal dialogs with the given {@code modalityType}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog#setModal
@ -677,31 +677,31 @@ public class Dialog extends Window {
}
/**
* Constructs an initially invisible <code>Dialog</code> with the
* specified owner <code>Window</code>, title, modality and
* <code>GraphicsConfiguration</code>.
* Constructs an initially invisible {@code Dialog} with the
* specified owner {@code Window}, title, modality and
* {@code GraphicsConfiguration}.
*
* @param owner the owner of the dialog. The owner must be an instance of
* {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any
* of their descendants or <code>null</code>
* @param title the title of the dialog or <code>null</code> if this dialog
* of their descendants or {@code null}
* @param title the title of the dialog or {@code null} if this dialog
* has no title
* @param modalityType specifies whether dialog blocks input to other
* windows when shown. <code>null</code> value and unsupported modality
* types are equivalent to <code>MODELESS</code>
* @param gc the <code>GraphicsConfiguration</code> of the target screen device;
* if <code>null</code>, the default system <code>GraphicsConfiguration</code>
* windows when shown. {@code null} value and unsupported modality
* types are equivalent to {@code MODELESS}
* @param gc the {@code GraphicsConfiguration} of the target screen device;
* if {@code null}, the default system {@code GraphicsConfiguration}
* is assumed
*
* @exception java.lang.IllegalArgumentException if the <code>owner</code>
* @exception java.lang.IllegalArgumentException if the {@code owner}
* is not an instance of {@link java.awt.Dialog Dialog} or {@link
* java.awt.Frame Frame}
* @exception java.lang.IllegalArgumentException if <code>gc</code>
* @exception java.lang.IllegalArgumentException if {@code gc}
* is not from a screen device
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @exception SecurityException if the calling thread does not have permission
* to create modal dialogs with the given <code>modalityType</code>
* to create modal dialogs with the given {@code modalityType}
*
* @see java.awt.Dialog.ModalityType
* @see java.awt.Dialog#setModal
@ -766,8 +766,8 @@ public class Dialog extends Window {
* This method is obsolete and is kept for backwards compatibility only.
* Use {@link #getModalityType getModalityType()} instead.
*
* @return <code>true</code> if this dialog window is modal;
* <code>false</code> otherwise
* @return {@code true} if this dialog window is modal;
* {@code false} otherwise
*
* @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
* @see java.awt.Dialog.ModalityType#MODELESS
@ -792,10 +792,10 @@ public class Dialog extends Window {
* until it is hidden and then shown again.
*
* @param modal specifies whether dialog blocks input to other windows
* when shown; calling to <code>setModal(true)</code> is equivalent to
* <code>setModalityType(Dialog.DEFAULT_MODALITY_TYPE)</code>, and
* calling to <code>setModal(false)</code> is equivalent to
* <code>setModalityType(Dialog.ModalityType.MODELESS)</code>
* when shown; calling to {@code setModal(true)} is equivalent to
* {@code setModalityType(Dialog.DEFAULT_MODALITY_TYPE)}, and
* calling to {@code setModal(false)} is equivalent to
* {@code setModalityType(Dialog.ModalityType.MODELESS)}
*
* @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
* @see java.awt.Dialog.ModalityType#MODELESS
@ -827,18 +827,18 @@ public class Dialog extends Window {
* Sets the modality type for this dialog. See {@link
* java.awt.Dialog.ModalityType ModalityType} for possible modality types.
* <p>
* If the given modality type is not supported, <code>MODELESS</code>
* is used. You may want to call <code>getModalityType()</code> after calling
* If the given modality type is not supported, {@code MODELESS}
* is used. You may want to call {@code getModalityType()} after calling
* this method to ensure that the modality type has been set.
* <p>
* Note: changing modality of the visible dialog may have no effect
* until it is hidden and then shown again.
*
* @param type specifies whether dialog blocks input to other
* windows when shown. <code>null</code> value and unsupported modality
* types are equivalent to <code>MODELESS</code>
* windows when shown. {@code null} value and unsupported modality
* types are equivalent to {@code MODELESS}
* @exception SecurityException if the calling thread does not have permission
* to create modal dialogs with the given <code>modalityType</code>
* to create modal dialogs with the given {@code modalityType}
*
* @see java.awt.Dialog#getModalityType
* @see java.awt.Toolkit#isModalityTypeSupported
@ -866,7 +866,7 @@ public class Dialog extends Window {
* Gets the title of the dialog. The title is displayed in the
* dialog's border.
* @return the title of this dialog window. The title may be
* <code>null</code>.
* {@code null}.
* @see java.awt.Dialog#setTitle
*/
public String getTitle() {
@ -1193,8 +1193,8 @@ public class Dialog extends Window {
/**
* Indicates whether this dialog is resizable by the user.
* By default, all dialogs are initially resizable.
* @return <code>true</code> if the user can resize the dialog;
* <code>false</code> otherwise.
* @return {@code true} if the user can resize the dialog;
* {@code false} otherwise.
* @see java.awt.Dialog#setResizable
*/
public boolean isResizable() {
@ -1203,8 +1203,8 @@ public class Dialog extends Window {
/**
* Sets whether this dialog is resizable by the user.
* @param resizable <code>true</code> if the user can
* resize this dialog; <code>false</code> otherwise.
* @param resizable {@code true} if the user can
* resize this dialog; {@code false} otherwise.
* @see java.awt.Dialog#isResizable
*/
public void setResizable(boolean resizable) {
@ -1283,8 +1283,8 @@ public class Dialog extends Window {
/**
* Indicates whether this dialog is undecorated.
* By default, all dialogs are initially decorated.
* @return <code>true</code> if dialog is undecorated;
* <code>false</code> otherwise.
* @return {@code true} if dialog is undecorated;
* {@code false} otherwise.
* @see java.awt.Dialog#setUndecorated
* @since 1.4
*/
@ -1336,7 +1336,7 @@ public class Dialog extends Window {
* method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this dialog window.
*/
@ -1647,7 +1647,7 @@ public class Dialog extends Window {
/**
* This class implements accessibility support for the
* <code>Dialog</code> class. It provides an implementation of the
* {@code Dialog} class. It provides an implementation of the
* Java Accessibility API appropriate to dialog user-interface elements.
* @since 1.3
*/

68
jdk/src/java.desktop/share/classes/java/awt/Dimension.java
View file

@ -29,19 +29,19 @@ import java.awt.geom.Dimension2D;
import java.beans.Transient;
/**
* The <code>Dimension</code> class encapsulates the width and
* The {@code Dimension} class encapsulates the width and
* height of a component (in integer precision) in a single object.
* The class is
* associated with certain properties of components. Several methods
* defined by the <code>Component</code> class and the
* <code>LayoutManager</code> interface return a
* <code>Dimension</code> object.
* defined by the {@code Component} class and the
* {@code LayoutManager} interface return a
* {@code Dimension} object.
* <p>
* Normally the values of <code>width</code>
* and <code>height</code> are non-negative integers.
* Normally the values of {@code width}
* and {@code height} are non-negative integers.
* The constructors that allow you to create a dimension do
* not prevent you from setting a negative value for these properties.
* If the value of <code>width</code> or <code>height</code> is
* If the value of {@code width} or {@code height} is
* negative, the behavior of some methods defined by other objects is
* undefined.
*
@ -92,7 +92,7 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Creates an instance of <code>Dimension</code> with a width
* Creates an instance of {@code Dimension} with a width
* of zero and a height of zero.
*/
public Dimension() {
@ -100,19 +100,19 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Creates an instance of <code>Dimension</code> whose width
* Creates an instance of {@code Dimension} whose width
* and height are the same as for the specified dimension.
*
* @param d the specified dimension for the
* <code>width</code> and
* <code>height</code> values
* {@code width} and
* {@code height} values
*/
public Dimension(Dimension d) {
this(d.width, d.height);
}
/**
* Constructs a <code>Dimension</code> and initializes
* Constructs a {@code Dimension} and initializes
* it to the specified width and specified height.
*
* @param width the specified width
@ -140,14 +140,14 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Sets the size of this <code>Dimension</code> object to
* Sets the size of this {@code Dimension} object to
* the specified width and height in double precision.
* Note that if <code>width</code> or <code>height</code>
* are larger than <code>Integer.MAX_VALUE</code>, they will
* be reset to <code>Integer.MAX_VALUE</code>.
* Note that if {@code width} or {@code height}
* are larger than {@code Integer.MAX_VALUE}, they will
* be reset to {@code Integer.MAX_VALUE}.
*
* @param width the new width for the <code>Dimension</code> object
* @param height the new height for the <code>Dimension</code> object
* @param width the new width for the {@code Dimension} object
* @param height the new height for the {@code Dimension} object
* @since 1.2
*/
public void setSize(double width, double height) {
@ -156,12 +156,12 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Gets the size of this <code>Dimension</code> object.
* Gets the size of this {@code Dimension} object.
* This method is included for completeness, to parallel the
* <code>getSize</code> method defined by <code>Component</code>.
* {@code getSize} method defined by {@code Component}.
*
* @return the size of this dimension, a new instance of
* <code>Dimension</code> with the same width and height
* {@code Dimension} with the same width and height
* @see java.awt.Dimension#setSize
* @see java.awt.Component#getSize
* @since 1.1
@ -172,10 +172,10 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Sets the size of this <code>Dimension</code> object to the specified size.
* Sets the size of this {@code Dimension} object to the specified size.
* This method is included for completeness, to parallel the
* <code>setSize</code> method defined by <code>Component</code>.
* @param d the new size for this <code>Dimension</code> object
* {@code setSize} method defined by {@code Component}.
* @param d the new size for this {@code Dimension} object
* @see java.awt.Dimension#getSize
* @see java.awt.Component#setSize
* @since 1.1
@ -185,13 +185,13 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Sets the size of this <code>Dimension</code> object
* Sets the size of this {@code Dimension} object
* to the specified width and height.
* This method is included for completeness, to parallel the
* <code>setSize</code> method defined by <code>Component</code>.
* {@code setSize} method defined by {@code Component}.
*
* @param width the new width for this <code>Dimension</code> object
* @param height the new height for this <code>Dimension</code> object
* @param width the new width for this {@code Dimension} object
* @param height the new height for this {@code Dimension} object
* @see java.awt.Dimension#getSize
* @see java.awt.Component#setSize
* @since 1.1
@ -213,9 +213,9 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
}
/**
* Returns the hash code for this <code>Dimension</code>.
* Returns the hash code for this {@code Dimension}.
*
* @return a hash code for this <code>Dimension</code>
* @return a hash code for this {@code Dimension}
*/
public int hashCode() {
int sum = width + height;
@ -224,13 +224,13 @@ public class Dimension extends Dimension2D implements java.io.Serializable {
/**
* Returns a string representation of the values of this
* <code>Dimension</code> object's <code>height</code> and
* <code>width</code> fields. This method is intended to be used only
* {@code Dimension} object's {@code height} and
* {@code width} fields. This method is intended to be used only
* for debugging purposes, and the content and format of the returned
* string may vary between implementations. The returned string may be
* empty but may not be <code>null</code>.
* empty but may not be {@code null}.
*
* @return a string representation of this <code>Dimension</code>
* @return a string representation of this {@code Dimension}
* object
*/
public String toString() {

12
jdk/src/java.desktop/share/classes/java/awt/DisplayMode.java
View file

@ -28,8 +28,8 @@ package java.awt;
import java.lang.annotation.Native;
/**
* The <code>DisplayMode</code> class encapsulates the bit depth, height,
* width, and refresh rate of a <code>GraphicsDevice</code>. The ability to
* The {@code DisplayMode} class encapsulates the bit depth, height,
* width, and refresh rate of a {@code GraphicsDevice}. The ability to
* change graphics device's display mode is platform- and
* configuration-dependent and may not always be available
* (see {@link GraphicsDevice#isDisplayChangeSupported}).
@ -57,10 +57,10 @@ public final class DisplayMode {
* @param width the width of the display, in pixels
* @param height the height of the display, in pixels
* @param bitDepth the bit depth of the display, in bits per
* pixel. This can be <code>BIT_DEPTH_MULTI</code> if multiple
* pixel. This can be {@code BIT_DEPTH_MULTI} if multiple
* bit depths are available.
* @param refreshRate the refresh rate of the display, in hertz.
* This can be <code>REFRESH_RATE_UNKNOWN</code> if the
* This can be {@code REFRESH_RATE_UNKNOWN} if the
* information is not available.
* @see #BIT_DEPTH_MULTI
* @see #REFRESH_RATE_UNKNOWN
@ -96,7 +96,7 @@ public final class DisplayMode {
/**
* Returns the bit depth of the display, in bits per pixel. This may be
* <code>BIT_DEPTH_MULTI</code> if multiple bit depths are supported in
* {@code BIT_DEPTH_MULTI} if multiple bit depths are supported in
* this display mode.
*
* @return the bit depth of the display, in bits per pixel.
@ -114,7 +114,7 @@ public final class DisplayMode {
/**
* Returns the refresh rate of the display, in hertz. This may be
* <code>REFRESH_RATE_UNKNOWN</code> if the information is not available.
* {@code REFRESH_RATE_UNKNOWN} if the information is not available.
*
* @return the refresh rate of the display, in hertz.
* @see #REFRESH_RATE_UNKNOWN

118
jdk/src/java.desktop/share/classes/java/awt/Event.java
View file

@ -28,14 +28,14 @@ import java.awt.event.*;
import java.io.*;
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* <code>Event</code> is a platform-independent class that
* {@code Event} is a platform-independent class that
* encapsulates events from the platform's Graphical User
* Interface in the Java&nbsp;1.0 event model. In Java&nbsp;1.1
* and later versions, the <code>Event</code> class is maintained
* and later versions, the {@code Event} class is maintained
* only for backwards compatibility. The information in this
* class description is provided to assist programmers in
* converting Java&nbsp;1.0 programs to the new event model.
@ -43,18 +43,18 @@ import java.io.*;
* In the Java&nbsp;1.0 event model, an event contains an
* {@link Event#id} field
* that indicates what type of event it is and which other
* <code>Event</code> variables are relevant for the event.
* {@code Event} variables are relevant for the event.
* <p>
* For keyboard events, {@link Event#key}
* contains a value indicating which key was activated, and
* {@link Event#modifiers} contains the
* modifiers for that event. For the KEY_PRESS and KEY_RELEASE
* event ids, the value of <code>key</code> is the unicode
* event ids, the value of {@code key} is the unicode
* character code for the key. For KEY_ACTION and
* KEY_ACTION_RELEASE, the value of <code>key</code> is
* KEY_ACTION_RELEASE, the value of {@code key} is
* one of the defined action-key identifiers in the
* <code>Event</code> class (<code>PGUP</code>,
* <code>PGDN</code>, <code>F1</code>, <code>F2</code>, etc).
* {@code Event} class ({@code PGUP},
* {@code PGDN}, {@code F1}, {@code F2}, etc).
*
* @author Sami Shaio
* @since 1.0
@ -293,7 +293,7 @@ public class Event implements java.io.Serializable {
/**
* The user has pressed a non-ASCII <em>action</em> key.
* The <code>key</code> field contains a value that indicates
* The {@code key} field contains a value that indicates
* that the event occurred on one of the action keys, which
* comprise the 12 function keys, the arrow (cursor) keys,
* Page Up, Page Down, Home, End, Print Screen, Scroll Lock,
@ -303,7 +303,7 @@ public class Event implements java.io.Serializable {
/**
* The user has released a non-ASCII <em>action</em> key.
* The <code>key</code> field contains a value that indicates
* The {@code key} field contains a value that indicates
* that the event occurred on one of the action keys, which
* comprise the 12 function keys, the arrow (cursor) keys,
* Page Up, Page Down, Home, End, Print Screen, Scroll Lock,
@ -315,9 +315,9 @@ public class Event implements java.io.Serializable {
private static final int MOUSE_EVENT = 500;
/**
* The user has pressed the mouse button. The <code>ALT_MASK</code>
* The user has pressed the mouse button. The {@code ALT_MASK}
* flag indicates that the middle button has been pressed.
* The <code>META_MASK</code>flag indicates that the
* The {@code META_MASK} flag indicates that the
* right button has been pressed.
* @see java.awt.Event#ALT_MASK
* @see java.awt.Event#META_MASK
@ -325,9 +325,9 @@ public class Event implements java.io.Serializable {
public static final int MOUSE_DOWN = 1 + MOUSE_EVENT;
/**
* The user has released the mouse button. The <code>ALT_MASK</code>
* The user has released the mouse button. The {@code ALT_MASK}
* flag indicates that the middle button has been released.
* The <code>META_MASK</code>flag indicates that the
* The {@code META_MASK} flag indicates that the
* right button has been released.
* @see java.awt.Event#ALT_MASK
* @see java.awt.Event#META_MASK
@ -351,8 +351,8 @@ public class Event implements java.io.Serializable {
/**
* The user has moved the mouse with a button pressed. The
* <code>ALT_MASK</code> flag indicates that the middle
* button is being pressed. The <code>META_MASK</code> flag indicates
* {@code ALT_MASK} flag indicates that the middle
* button is being pressed. The {@code META_MASK} flag indicates
* that the right button is being pressed.
* @see java.awt.Event#ALT_MASK
* @see java.awt.Event#META_MASK
@ -466,7 +466,7 @@ public class Event implements java.io.Serializable {
/**
* Indicates which type of event the event is, and which
* other <code>Event</code> variables are relevant for the event.
* other {@code Event} variables are relevant for the event.
* This has been replaced by AWTEvent.getID()
*
* @serial
@ -518,9 +518,9 @@ public class Event implements java.io.Serializable {
public int modifiers;
/**
* For <code>MOUSE_DOWN</code> events, this field indicates the
* For {@code MOUSE_DOWN} events, this field indicates the
* number of consecutive clicks. For other events, its value is
* <code>0</code>.
* {@code 0}.
* This field has been replaced by MouseEvent.getClickCount().
*
* @serial
@ -531,7 +531,7 @@ public class Event implements java.io.Serializable {
/**
* An arbitrary argument of the event. The value of this field
* depends on the type of event.
* <code>arg</code> has been replaced by event specific property.
* {@code arg} has been replaced by event specific property.
*
* @serial
*/
@ -608,11 +608,11 @@ public class Event implements java.io.Serializable {
private static native void initIDs();
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Creates an instance of <code>Event</code> with the specified target
* Creates an instance of {@code Event} with the specified target
* component, time stamp, event type, <i>x</i> and <i>y</i>
* coordinates, keyboard key, state of the modifier keys, and
* argument.
@ -659,14 +659,14 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Creates an instance of <code>Event</code>, with the specified target
* Creates an instance of {@code Event}, with the specified target
* component, time stamp, event type, <i>x</i> and <i>y</i>
* coordinates, keyboard key, state of the modifier keys, and an
* argument set to <code>null</code>.
* argument set to {@code null}.
* @param target the target component.
* @param when the time stamp.
* @param id the event type.
@ -680,11 +680,11 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Creates an instance of <code>Event</code> with the specified
* Creates an instance of {@code Event} with the specified
* target component, event type, and argument.
* @param target the target component.
* @param id the event type.
@ -695,9 +695,9 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Translates this event so that its <i>x</i> and <i>y</i>
* coordinates are increased by <i>dx</i> and <i>dy</i>,
@ -716,13 +716,13 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Checks if the Shift key is down.
* @return <code>true</code> if the key is down;
* <code>false</code> otherwise.
* @return {@code true} if the key is down;
* {@code false} otherwise.
* @see java.awt.Event#modifiers
* @see java.awt.Event#controlDown
* @see java.awt.Event#metaDown
@ -732,13 +732,13 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Checks if the Control key is down.
* @return <code>true</code> if the key is down;
* <code>false</code> otherwise.
* @return {@code true} if the key is down;
* {@code false} otherwise.
* @see java.awt.Event#modifiers
* @see java.awt.Event#shiftDown
* @see java.awt.Event#metaDown
@ -748,14 +748,14 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Checks if the Meta key is down.
*
* @return <code>true</code> if the key is down;
* <code>false</code> otherwise.
* @return {@code true} if the key is down;
* {@code false} otherwise.
* @see java.awt.Event#modifiers
* @see java.awt.Event#shiftDown
* @see java.awt.Event#controlDown
@ -765,9 +765,9 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
*/
void consume() {
switch(id) {
@ -783,18 +783,18 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
*/
boolean isConsumed() {
return consumed;
}
/*
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Returns the integer key-code associated with the key in this event,
* as described in java.awt.Event.
@ -810,9 +810,9 @@ public class Event implements java.io.Serializable {
}
/*
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Returns a new KeyEvent char which corresponds to the int key
* of this old event.
@ -827,15 +827,15 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Returns a string representing the state of this <code>Event</code>.
* Returns a string representing the state of this {@code Event}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this event
*/
@ -863,9 +863,9 @@ public class Event implements java.io.Serializable {
}
/**
* <b>NOTE:</b> The <code>Event</code> class is obsolete and is
* <b>NOTE:</b> The {@code Event} class is obsolete and is
* available only for backwards compatibility. It has been replaced
* by the <code>AWTEvent</code> class and its subclasses.
* by the {@code AWTEvent} class and its subclasses.
* <p>
* Returns a representation of this event's values as a string.
* @return a string that represents the event and the values

8
jdk/src/java.desktop/share/classes/java/awt/EventFilter.java
View file

@ -27,27 +27,27 @@ package java.awt;
interface EventFilter {
/**
* Enumeration for possible values for <code>acceptEvent(AWTEvent ev)</code> method.
* Enumeration for possible values for {@code acceptEvent(AWTEvent ev)} method.
* @see EventDispatchThread#pumpEventsForFilter
*/
static enum FilterAction {
/**
* ACCEPT means that this filter do not filter the event and allows other
* active filters to proceed it. If all the active filters accept the event, it
* is dispatched by the <code>EventDispatchThread</code>
* is dispatched by the {@code EventDispatchThread}
* @see EventDispatchThread#pumpEventsForFilter
*/
ACCEPT,
/**
* REJECT means that this filter filter the event. No other filters are queried,
* and the event is not dispatched by the <code>EventDispatchedThread</code>
* and the event is not dispatched by the {@code EventDispatchedThread}
* @see EventDispatchThread#pumpEventsForFilter
*/
REJECT,
/**
* ACCEPT_IMMEDIATELY means that this filter do not filter the event, no other
* filters are queried and to proceed it, and it is dispatched by the
* <code>EventDispatchThread</code>
* {@code EventDispatchThread}
* It is not recommended to use ACCEPT_IMMEDIATELY as there may be some active
* filters not queried yet that do not accept this event. It is primarily used
* by modal filters.

104
jdk/src/java.desktop/share/classes/java/awt/EventQueue.java
View file

@ -51,36 +51,36 @@ import jdk.internal.misc.SharedSecrets;
import jdk.internal.misc.JavaSecurityAccess;
/**
* <code>EventQueue</code> is a platform-independent class
* {@code EventQueue} is a platform-independent class
* that queues events, both from the underlying peer classes
* and from trusted application classes.
* <p>
* It encapsulates asynchronous event dispatch machinery which
* extracts events from the queue and dispatches them by calling
* {@link #dispatchEvent(AWTEvent) dispatchEvent(AWTEvent)} method
* on this <code>EventQueue</code> with the event to be dispatched
* on this {@code EventQueue} with the event to be dispatched
* as an argument. The particular behavior of this machinery is
* implementation-dependent. The only requirements are that events
* which were actually enqueued to this queue (note that events
* being posted to the <code>EventQueue</code> can be coalesced)
* being posted to the {@code EventQueue} can be coalesced)
* are dispatched:
* <dl>
* <dt> Sequentially.
* <dd> That is, it is not permitted that several events from
* this queue are dispatched simultaneously.
* <dt> In the same order as they are enqueued.
* <dd> That is, if <code>AWTEvent</code>&nbsp;A is enqueued
* to the <code>EventQueue</code> before
* <code>AWTEvent</code>&nbsp;B then event B will not be
* <dd> That is, if {@code AWTEvent}&nbsp;A is enqueued
* to the {@code EventQueue} before
* {@code AWTEvent}&nbsp;B then event B will not be
* dispatched before event A.
* </dl>
* <p>
* Some browsers partition applets in different code bases into
* separate contexts, and establish walls between these contexts.
* In such a scenario, there will be one <code>EventQueue</code>
* In such a scenario, there will be one {@code EventQueue}
* per context. Other browsers place all applets into the same
* context, implying that there will be only a single, global
* <code>EventQueue</code> for all applets. This behavior is
* {@code EventQueue} for all applets. This behavior is
* implementation-dependent. Consult your browser's documentation
* for more information.
* <p>
@ -251,14 +251,14 @@ public class EventQueue {
}
/**
* Posts a 1.1-style event to the <code>EventQueue</code>.
* Posts a 1.1-style event to the {@code EventQueue}.
* If there is an existing event on the queue with the same ID
* and event source, the source <code>Component</code>'s
* <code>coalesceEvents</code> method will be called.
* and event source, the source {@code Component}'s
* {@code coalesceEvents} method will be called.
*
* @param theEvent an instance of <code>java.awt.AWTEvent</code>,
* @param theEvent an instance of {@code java.awt.AWTEvent},
* or a subclass of it
* @throws NullPointerException if <code>theEvent</code> is <code>null</code>
* @throws NullPointerException if {@code theEvent} is {@code null}
*/
public void postEvent(AWTEvent theEvent) {
SunToolkit.flushPendingEvents(appContext);
@ -266,12 +266,12 @@ public class EventQueue {
}
/**
* Posts a 1.1-style event to the <code>EventQueue</code>.
* Posts a 1.1-style event to the {@code EventQueue}.
* If there is an existing event on the queue with the same ID
* and event source, the source <code>Component</code>'s
* <code>coalesceEvents</code> method will be called.
* and event source, the source {@code Component}'s
* {@code coalesceEvents} method will be called.
*
* @param theEvent an instance of <code>java.awt.AWTEvent</code>,
* @param theEvent an instance of {@code java.awt.AWTEvent},
* or a subclass of it
*/
private final void postEventPrivate(AWTEvent theEvent) {
@ -320,7 +320,7 @@ public class EventQueue {
* Posts the event to the internal Queue of specified priority,
* coalescing as appropriate.
*
* @param theEvent an instance of <code>java.awt.AWTEvent</code>,
* @param theEvent an instance of {@code java.awt.AWTEvent},
* or a subclass of it
* @param priority the desired priority of the event
*/
@ -532,10 +532,10 @@ public class EventQueue {
}
/**
* Removes an event from the <code>EventQueue</code> and
* Removes an event from the {@code EventQueue} and
* returns it. This method will block until an event has
* been posted by another thread.
* @return the next <code>AWTEvent</code>
* @return the next {@code AWTEvent}
* @exception InterruptedException
* if any thread has interrupted this thread
*/
@ -617,7 +617,7 @@ public class EventQueue {
}
/**
* Returns the first event on the <code>EventQueue</code>
* Returns the first event on the {@code EventQueue}
* without removing it.
* @return the first event
*/
@ -639,7 +639,7 @@ public class EventQueue {
/**
* Returns the first event with the specified id, if any.
* @param id the id of the type of event desired
* @return the first event of the specified id or <code>null</code>
* @return the first event of the specified id or {@code null}
* if there is no such event
*/
public AWTEvent peekEvent(int id) {
@ -696,9 +696,9 @@ public class EventQueue {
* </tr>
* </table>
*
* @param event an instance of <code>java.awt.AWTEvent</code>,
* @param event an instance of {@code java.awt.AWTEvent},
* or a subclass of it
* @throws NullPointerException if <code>event</code> is <code>null</code>
* @throws NullPointerException if {@code event} is {@code null}
* @since 1.2
*/
protected void dispatchEvent(final AWTEvent event) {
@ -777,23 +777,23 @@ public class EventQueue {
/**
* Returns the timestamp of the most recent event that had a timestamp, and
* that was dispatched from the <code>EventQueue</code> associated with the
* that was dispatched from the {@code EventQueue} associated with the
* calling thread. If an event with a timestamp is currently being
* dispatched, its timestamp will be returned. If no events have yet
* been dispatched, the EventQueue's initialization time will be
* returned instead.In the current version of
* the JDK, only <code>InputEvent</code>s,
* <code>ActionEvent</code>s, and <code>InvocationEvent</code>s have
* the JDK, only {@code InputEvent}s,
* {@code ActionEvent}s, and {@code InvocationEvent}s have
* timestamps; however, future versions of the JDK may add timestamps to
* additional event types. Note that this method should only be invoked
* from an application's {@link #isDispatchThread event dispatching thread}.
* If this method is
* invoked from another thread, the current system time (as reported by
* <code>System.currentTimeMillis()</code>) will be returned instead.
* {@code System.currentTimeMillis()}) will be returned instead.
*
* @return the timestamp of the last <code>InputEvent</code>,
* <code>ActionEvent</code>, or <code>InvocationEvent</code> to be
* dispatched, or <code>System.currentTimeMillis()</code> if this
* @return the timestamp of the last {@code InputEvent},
* {@code ActionEvent}, or {@code InvocationEvent} to be
* dispatched, or {@code System.currentTimeMillis()} if this
* method is invoked on a thread other than an event dispatching
* thread
* @see java.awt.event.InputEvent#getWhen
@ -831,7 +831,7 @@ public class EventQueue {
/**
* Returns the event currently being dispatched by the
* <code>EventQueue</code> associated with the calling thread. This is
* {@code EventQueue} associated with the calling thread. This is
* useful if a method needs access to the event, but was not designed to
* receive a reference to it as an argument. Note that this method should
* only be invoked from an application's event dispatching thread. If this
@ -856,14 +856,14 @@ public class EventQueue {
}
/**
* Replaces the existing <code>EventQueue</code> with the specified one.
* Any pending events are transferred to the new <code>EventQueue</code>
* Replaces the existing {@code EventQueue} with the specified one.
* Any pending events are transferred to the new {@code EventQueue}
* for processing by it.
*
* @param newEventQueue an <code>EventQueue</code>
* @param newEventQueue an {@code EventQueue}
* (or subclass thereof) instance to be use
* @see java.awt.EventQueue#pop
* @throws NullPointerException if <code>newEventQueue</code> is <code>null</code>
* @throws NullPointerException if {@code newEventQueue} is {@code null}
* @since 1.2
*/
public void push(EventQueue newEventQueue) {
@ -921,15 +921,15 @@ public class EventQueue {
}
/**
* Stops dispatching events using this <code>EventQueue</code>.
* Stops dispatching events using this {@code EventQueue}.
* Any pending events are transferred to the previous
* <code>EventQueue</code> for processing.
* {@code EventQueue} for processing.
* <p>
* Warning: To avoid deadlock, do not declare this method
* synchronized in a subclass.
*
* @exception EmptyStackException if no previous push was made
* on this <code>EventQueue</code>
* on this {@code EventQueue}
* @see java.awt.EventQueue#push
* @since 1.2
*/
@ -1122,10 +1122,10 @@ public class EventQueue {
}
/*
* Gets the <code>EventDispatchThread</code> for this
* <code>EventQueue</code>.
* Gets the {@code EventDispatchThread} for this
* {@code EventQueue}.
* @return the event dispatch thread associated with this event queue
* or <code>null</code> if this event queue doesn't have a
* or {@code null} if this event queue doesn't have a
* working thread associated with it
* @see java.awt.EventQueue#initDispatchThread
* @see java.awt.EventQueue#detachDispatchThread
@ -1141,15 +1141,15 @@ public class EventQueue {
/*
* Removes any pending events for the specified source object.
* If removeAllEvents parameter is <code>true</code> then all
* If removeAllEvents parameter is {@code true} then all
* events for the specified source object are removed, if it
* is <code>false</code> then <code>SequencedEvent</code>, <code>SentEvent</code>,
* <code>FocusEvent</code>, <code>WindowEvent</code>, <code>KeyEvent</code>,
* and <code>InputMethodEvent</code> are kept in the queue, but all other
* is {@code false} then {@code SequencedEvent}, {@code SentEvent},
* {@code FocusEvent}, {@code WindowEvent}, {@code KeyEvent},
* and {@code InputMethodEvent} are kept in the queue, but all other
* events are removed.
*
* This method is normally called by the source's
* <code>removeNotify</code> method.
* {@code removeNotify} method.
*/
final void removeSourceEvents(Object source, boolean removeAllEvents) {
SunToolkit.flushPendingEvents(appContext);
@ -1249,12 +1249,12 @@ public class EventQueue {
}
/**
* Causes <code>runnable</code> to have its <code>run</code>
* Causes {@code runnable} to have its {@code run}
* method called in the {@link #isDispatchThread dispatch thread} of
* {@link Toolkit#getSystemEventQueue the system EventQueue}.
* This will happen after all pending events are processed.
*
* @param runnable the <code>Runnable</code> whose <code>run</code>
* @param runnable the {@code Runnable} whose {@code run}
* method should be executed
* asynchronously in the
* {@link #isDispatchThread event dispatch thread}
@ -1270,7 +1270,7 @@ public class EventQueue {
}
/**
* Causes <code>runnable</code> to have its <code>run</code>
* Causes {@code runnable} to have its {@code run}
* method called in the {@link #isDispatchThread dispatch thread} of
* {@link Toolkit#getSystemEventQueue the system EventQueue}.
* This will happen after all pending events are processed.
@ -1278,7 +1278,7 @@ public class EventQueue {
* will throw an Error if called from the
* {@link #isDispatchThread event dispatcher thread}.
*
* @param runnable the <code>Runnable</code> whose <code>run</code>
* @param runnable the {@code Runnable} whose {@code run}
* method should be executed
* synchronously in the
* {@link #isDispatchThread event dispatch thread}
@ -1286,7 +1286,7 @@ public class EventQueue {
* @exception InterruptedException if any thread has
* interrupted this thread
* @exception InvocationTargetException if an throwable is thrown
* when running <code>runnable</code>
* when running {@code runnable}
* @see #invokeLater
* @see Toolkit#getSystemEventQueue
* @see #isDispatchThread

122
jdk/src/java.desktop/share/classes/java/awt/FileDialog.java
View file

@ -32,11 +32,11 @@ import java.io.File;
import sun.awt.AWTAccessor;
/**
* The <code>FileDialog</code> class displays a dialog window
* The {@code FileDialog} class displays a dialog window
* from which the user can select a file.
* <p>
* Since it is a modal dialog, when the application calls
* its <code>show</code> method to display the dialog,
* its {@code show} method to display the dialog,
* it blocks the rest of the application until the user has
* chosen a file.
*
@ -61,10 +61,10 @@ public class FileDialog extends Dialog {
public static final int SAVE = 1;
/*
* There are two <code>FileDialog</code> modes: <code>LOAD</code> and
* <code>SAVE</code>.
* There are two {@code FileDialog} modes: {@code LOAD} and
* {@code SAVE}.
* This integer will represent one or the other.
* If the mode is not specified it will default to <code>LOAD</code>.
* If the mode is not specified it will default to {@code LOAD}.
*
* @serial
* @see getMode()
@ -76,7 +76,7 @@ public class FileDialog extends Dialog {
/*
* The string specifying the directory to display
* in the file dialog. This variable may be <code>null</code>.
* in the file dialog. This variable may be {@code null}.
*
* @serial
* @see getDirectory()
@ -87,7 +87,7 @@ public class FileDialog extends Dialog {
/*
* The string specifying the initial value of the
* filename text field in the file dialog.
* This variable may be <code>null</code>.
* This variable may be {@code null}.
*
* @serial
* @see getFile()
@ -118,7 +118,7 @@ public class FileDialog extends Dialog {
* The filter used as the file dialog's filename filter.
* The file dialog will only be displaying files whose
* names are accepted by this filter.
* This variable may be <code>null</code>.
* This variable may be {@code null}.
*
* @serial
* @see #getFilenameFilter()
@ -173,7 +173,7 @@ public class FileDialog extends Dialog {
/**
* Creates a file dialog for loading a file. The title of the
* file dialog is initially empty. This is a convenience method for
* <code>FileDialog(parent, "", LOAD)</code>.
* {@code FileDialog(parent, "", LOAD)}.
* <p>
* <strong>Note:</strong> Some platforms may not support
* showing the user-specified title in a file dialog.
@ -192,7 +192,7 @@ public class FileDialog extends Dialog {
* Creates a file dialog window with the specified title for loading
* a file. The files shown are those in the current directory.
* This is a convenience method for
* <code>FileDialog(parent, title, LOAD)</code>.
* {@code FileDialog(parent, title, LOAD)}.
* <p>
* <strong>Note:</strong> Some platforms may not support
* showing the user-specified title in a file dialog.
@ -211,10 +211,10 @@ public class FileDialog extends Dialog {
* Creates a file dialog window with the specified title for loading
* or saving a file.
* <p>
* If the value of <code>mode</code> is <code>LOAD</code>, then the
* If the value of {@code mode} is {@code LOAD}, then the
* file dialog is finding a file to read, and the files shown are those
* in the current directory. If the value of
* <code>mode</code> is <code>SAVE</code>, the file dialog is finding
* {@code mode} is {@code SAVE}, the file dialog is finding
* a place to write a file.
* <p>
* <strong>Note:</strong> Some platforms may not support
@ -226,7 +226,7 @@ public class FileDialog extends Dialog {
* @param parent the owner of the dialog
* @param title the title of the dialog
* @param mode the mode of the dialog; either
* <code>FileDialog.LOAD</code> or <code>FileDialog.SAVE</code>
* {@code FileDialog.LOAD} or {@code FileDialog.SAVE}
* @exception IllegalArgumentException if an illegal file
* dialog mode is supplied
* @see java.awt.FileDialog#LOAD
@ -241,7 +241,7 @@ public class FileDialog extends Dialog {
/**
* Creates a file dialog for loading a file. The title of the
* file dialog is initially empty. This is a convenience method for
* <code>FileDialog(parent, "", LOAD)</code>.
* {@code FileDialog(parent, "", LOAD)}.
* <p>
* <strong>Note:</strong> Some platforms may not support
* showing the user-specified title in a file dialog.
@ -250,13 +250,13 @@ public class FileDialog extends Dialog {
* displayed.
*
* @param parent the owner of the dialog
* @exception java.lang.IllegalArgumentException if the <code>parent</code>'s
* <code>GraphicsConfiguration</code>
* @exception java.lang.IllegalArgumentException if the {@code parent}'s
* {@code GraphicsConfiguration}
* is not from a screen device;
* @exception java.lang.IllegalArgumentException if <code>parent</code>
* is <code>null</code>; this exception is always thrown when
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* @exception java.lang.IllegalArgumentException if {@code parent}
* is {@code null}; this exception is always thrown when
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.5
*/
@ -268,7 +268,7 @@ public class FileDialog extends Dialog {
* Creates a file dialog window with the specified title for loading
* a file. The files shown are those in the current directory.
* This is a convenience method for
* <code>FileDialog(parent, title, LOAD)</code>.
* {@code FileDialog(parent, title, LOAD)}.
* <p>
* <strong>Note:</strong> Some platforms may not support
* showing the user-specified title in a file dialog.
@ -277,16 +277,16 @@ public class FileDialog extends Dialog {
* displayed.
*
* @param parent the owner of the dialog
* @param title the title of the dialog; a <code>null</code> value
* @param title the title of the dialog; a {@code null} value
* will be accepted without causing a
* <code>NullPointerException</code> to be thrown
* @exception java.lang.IllegalArgumentException if the <code>parent</code>'s
* <code>GraphicsConfiguration</code>
* {@code NullPointerException} to be thrown
* @exception java.lang.IllegalArgumentException if the {@code parent}'s
* {@code GraphicsConfiguration}
* is not from a screen device;
* @exception java.lang.IllegalArgumentException if <code>parent</code>
* is <code>null</code>; this exception is always thrown when
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* @exception java.lang.IllegalArgumentException if {@code parent}
* is {@code null}; this exception is always thrown when
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @since 1.5
*/
@ -298,10 +298,10 @@ public class FileDialog extends Dialog {
* Creates a file dialog window with the specified title for loading
* or saving a file.
* <p>
* If the value of <code>mode</code> is <code>LOAD</code>, then the
* If the value of {@code mode} is {@code LOAD}, then the
* file dialog is finding a file to read, and the files shown are those
* in the current directory. If the value of
* <code>mode</code> is <code>SAVE</code>, the file dialog is finding
* {@code mode} is {@code SAVE}, the file dialog is finding
* a place to write a file.
* <p>
* <strong>Note:</strong> Some platforms may not support
@ -311,20 +311,20 @@ public class FileDialog extends Dialog {
* displayed.
*
* @param parent the owner of the dialog
* @param title the title of the dialog; a <code>null</code> value
* @param title the title of the dialog; a {@code null} value
* will be accepted without causing a
* <code>NullPointerException</code> to be thrown
* {@code NullPointerException} to be thrown
* @param mode the mode of the dialog; either
* <code>FileDialog.LOAD</code> or <code>FileDialog.SAVE</code>
* {@code FileDialog.LOAD} or {@code FileDialog.SAVE}
* @exception java.lang.IllegalArgumentException if an illegal
* file dialog mode is supplied;
* @exception java.lang.IllegalArgumentException if the <code>parent</code>'s
* <code>GraphicsConfiguration</code>
* @exception java.lang.IllegalArgumentException if the {@code parent}'s
* {@code GraphicsConfiguration}
* is not from a screen device;
* @exception java.lang.IllegalArgumentException if <code>parent</code>
* is <code>null</code>; this exception is always thrown when
* <code>GraphicsEnvironment.isHeadless</code>
* returns <code>true</code>
* @exception java.lang.IllegalArgumentException if {@code parent}
* is {@code null}; this exception is always thrown when
* {@code GraphicsEnvironment.isHeadless}
* returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @see java.awt.FileDialog#LOAD
* @see java.awt.FileDialog#SAVE
@ -353,8 +353,8 @@ public class FileDialog extends Dialog {
/**
* Constructs a name for this component. Called by <code>getName()</code>
* when the name is <code>null</code>.
* Constructs a name for this component. Called by {@code getName()}
* when the name is {@code null}.
*/
String constructComponentName() {
synchronized (FileDialog.class) {
@ -382,8 +382,8 @@ public class FileDialog extends Dialog {
* or for saving to a file.
*
* @return the mode of this file dialog window, either
* <code>FileDialog.LOAD</code> or
* <code>FileDialog.SAVE</code>
* {@code FileDialog.LOAD} or
* {@code FileDialog.SAVE}
* @see java.awt.FileDialog#LOAD
* @see java.awt.FileDialog#SAVE
* @see java.awt.FileDialog#setMode
@ -393,13 +393,13 @@ public class FileDialog extends Dialog {
}
/**
* Sets the mode of the file dialog. If <code>mode</code> is not
* a legal value, an exception will be thrown and <code>mode</code>
* Sets the mode of the file dialog. If {@code mode} is not
* a legal value, an exception will be thrown and {@code mode}
* will not be set.
*
* @param mode the mode for this file dialog, either
* <code>FileDialog.LOAD</code> or
* <code>FileDialog.SAVE</code>
* {@code FileDialog.LOAD} or
* {@code FileDialog.SAVE}
* @see java.awt.FileDialog#LOAD
* @see java.awt.FileDialog#SAVE
* @see java.awt.FileDialog#getMode
@ -421,8 +421,8 @@ public class FileDialog extends Dialog {
/**
* Gets the directory of this file dialog.
*
* @return the (potentially <code>null</code> or invalid)
* directory of this <code>FileDialog</code>
* @return the (potentially {@code null} or invalid)
* directory of this {@code FileDialog}
* @see java.awt.FileDialog#setDirectory
*/
public String getDirectory() {
@ -431,14 +431,14 @@ public class FileDialog extends Dialog {
/**
* Sets the directory of this file dialog window to be the
* specified directory. Specifying a <code>null</code> or an
* specified directory. Specifying a {@code null} or an
* invalid directory implies an implementation-defined default.
* This default will not be realized, however, until the user
* has selected a file. Until this point, <code>getDirectory()</code>
* has selected a file. Until this point, {@code getDirectory()}
* will return the value passed into this method.
* <p>
* Specifying "" as the directory is exactly equivalent to
* specifying <code>null</code> as the directory.
* specifying {@code null} as the directory.
*
* @param dir the specified directory
* @see java.awt.FileDialog#getDirectory
@ -453,10 +453,10 @@ public class FileDialog extends Dialog {
/**
* Gets the selected file of this file dialog. If the user
* selected <code>CANCEL</code>, the returned file is <code>null</code>.
* selected {@code CANCEL}, the returned file is {@code null}.
*
* @return the currently selected file of this file dialog window,
* or <code>null</code> if none is selected
* or {@code null} if none is selected
* @see java.awt.FileDialog#setFile
*/
public String getFile() {
@ -592,12 +592,12 @@ public class FileDialog extends Dialog {
}
/**
* Reads the <code>ObjectInputStream</code> and performs
* Reads the {@code ObjectInputStream} and performs
* a backwards compatibility check by converting
* either a <code>dir</code> or a <code>file</code>
* equal to an empty string to <code>null</code>.
* either a {@code dir} or a {@code file}
* equal to an empty string to {@code null}.
*
* @param s the <code>ObjectInputStream</code> to read
* @param s the {@code ObjectInputStream} to read
*/
private void readObject(ObjectInputStream s)
throws ClassNotFoundException, IOException
@ -614,11 +614,11 @@ public class FileDialog extends Dialog {
}
/**
* Returns a string representing the state of this <code>FileDialog</code>
* Returns a string representing the state of this {@code FileDialog}
* window. This method is intended to be used only for debugging purposes,
* and the content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this file dialog window
*/

98
jdk/src/java.desktop/share/classes/java/awt/FlowLayout.java
View file

@ -30,16 +30,16 @@ import java.io.IOException;
/**
* A flow layout arranges components in a directional flow, much
* like lines of text in a paragraph. The flow direction is
* determined by the container's <code>componentOrientation</code>
* determined by the container's {@code componentOrientation}
* property and may be one of two values:
* <ul>
* <li><code>ComponentOrientation.LEFT_TO_RIGHT</code>
* <li><code>ComponentOrientation.RIGHT_TO_LEFT</code>
* <li>{@code ComponentOrientation.LEFT_TO_RIGHT}
* <li>{@code ComponentOrientation.RIGHT_TO_LEFT}
* </ul>
* Flow layouts are typically used
* to arrange buttons in a panel. It arranges buttons
* horizontally until no more buttons fit on the same line.
* The line alignment is determined by the <code>align</code>
* The line alignment is determined by the {@code align}
* property. The possible values are:
* <ul>
* <li>{@link #LEFT LEFT}
@ -125,13 +125,13 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
public static final int TRAILING = 4;
/**
* <code>align</code> is the property that determines
* {@code align} is the property that determines
* how each row distributes empty space.
* It can be one of the following values:
* <ul>
* <li><code>LEFT</code>
* <li><code>RIGHT</code>
* <li><code>CENTER</code>
* <li>{@code LEFT}
* <li>{@code RIGHT}
* <li>{@code CENTER}
* </ul>
*
* @serial
@ -141,16 +141,16 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
int align; // This is for 1.1 serialization compatibility
/**
* <code>newAlign</code> is the property that determines
* {@code newAlign} is the property that determines
* how each row distributes empty space for the Java 2 platform,
* v1.2 and greater.
* It can be one of the following three values:
* <ul>
* <li><code>LEFT</code>
* <li><code>RIGHT</code>
* <li><code>CENTER</code>
* <li><code>LEADING</code>
* <li><code>TRAILING</code>
* <li>{@code LEFT}
* <li>{@code RIGHT}
* <li>{@code CENTER}
* <li>{@code LEADING}
* <li>{@code TRAILING}
* </ul>
*
* @serial
@ -165,7 +165,7 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
* components with gaps. The horizontal gap will
* specify the space between components and between
* the components and the borders of the
* <code>Container</code>.
* {@code Container}.
*
* @serial
* @see #getHgap()
@ -177,7 +177,7 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
* The flow layout manager allows a separation of
* components with gaps. The vertical gap will
* specify the space between rows and between the
* the rows and the borders of the <code>Container</code>.
* the rows and the borders of the {@code Container}.
*
* @serial
* @see #getHgap()
@ -196,7 +196,7 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
private static final long serialVersionUID = -7262534875583282631L;
/**
* Constructs a new <code>FlowLayout</code> with a centered alignment and a
* Constructs a new {@code FlowLayout} with a centered alignment and a
* default 5-unit horizontal and vertical gap.
*/
public FlowLayout() {
@ -204,12 +204,12 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
}
/**
* Constructs a new <code>FlowLayout</code> with the specified
* Constructs a new {@code FlowLayout} with the specified
* alignment and a default 5-unit horizontal and vertical gap.
* The value of the alignment argument must be one of
* <code>FlowLayout.LEFT</code>, <code>FlowLayout.RIGHT</code>,
* <code>FlowLayout.CENTER</code>, <code>FlowLayout.LEADING</code>,
* or <code>FlowLayout.TRAILING</code>.
* {@code FlowLayout.LEFT}, {@code FlowLayout.RIGHT},
* {@code FlowLayout.CENTER}, {@code FlowLayout.LEADING},
* or {@code FlowLayout.TRAILING}.
* @param align the alignment value
*/
public FlowLayout(int align) {
@ -221,16 +221,16 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
* and the indicated horizontal and vertical gaps.
* <p>
* The value of the alignment argument must be one of
* <code>FlowLayout.LEFT</code>, <code>FlowLayout.RIGHT</code>,
* <code>FlowLayout.CENTER</code>, <code>FlowLayout.LEADING</code>,
* or <code>FlowLayout.TRAILING</code>.
* {@code FlowLayout.LEFT}, {@code FlowLayout.RIGHT},
* {@code FlowLayout.CENTER}, {@code FlowLayout.LEADING},
* or {@code FlowLayout.TRAILING}.
* @param align the alignment value
* @param hgap the horizontal gap between components
* and between the components and the
* borders of the <code>Container</code>
* borders of the {@code Container}
* @param vgap the vertical gap between components
* and between the components and the
* borders of the <code>Container</code>
* borders of the {@code Container}
*/
public FlowLayout(int align, int hgap, int vgap) {
this.hgap = hgap;
@ -240,10 +240,10 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
/**
* Gets the alignment for this layout.
* Possible values are <code>FlowLayout.LEFT</code>,
* <code>FlowLayout.RIGHT</code>, <code>FlowLayout.CENTER</code>,
* <code>FlowLayout.LEADING</code>,
* or <code>FlowLayout.TRAILING</code>.
* Possible values are {@code FlowLayout.LEFT},
* {@code FlowLayout.RIGHT}, {@code FlowLayout.CENTER},
* {@code FlowLayout.LEADING},
* or {@code FlowLayout.TRAILING}.
* @return the alignment value for this layout
* @see java.awt.FlowLayout#setAlignment
* @since 1.1
@ -256,11 +256,11 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
* Sets the alignment for this layout.
* Possible values are
* <ul>
* <li><code>FlowLayout.LEFT</code>
* <li><code>FlowLayout.RIGHT</code>
* <li><code>FlowLayout.CENTER</code>
* <li><code>FlowLayout.LEADING</code>
* <li><code>FlowLayout.TRAILING</code>
* <li>{@code FlowLayout.LEFT}
* <li>{@code FlowLayout.RIGHT}
* <li>{@code FlowLayout.CENTER}
* <li>{@code FlowLayout.LEADING}
* <li>{@code FlowLayout.TRAILING}
* </ul>
* @param align one of the alignment values shown above
* @see #getAlignment()
@ -289,11 +289,11 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
/**
* Gets the horizontal gap between components
* and between the components and the borders
* of the <code>Container</code>
* of the {@code Container}
*
* @return the horizontal gap between components
* and between the components and the borders
* of the <code>Container</code>
* of the {@code Container}
* @see java.awt.FlowLayout#setHgap
* @since 1.1
*/
@ -304,11 +304,11 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
/**
* Sets the horizontal gap between components and
* between the components and the borders of the
* <code>Container</code>.
* {@code Container}.
*
* @param hgap the horizontal gap between components
* and between the components and the borders
* of the <code>Container</code>
* of the {@code Container}
* @see java.awt.FlowLayout#getHgap
* @since 1.1
*/
@ -319,11 +319,11 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
/**
* Gets the vertical gap between components and
* between the components and the borders of the
* <code>Container</code>.
* {@code Container}.
*
* @return the vertical gap between components
* and between the components and the borders
* of the <code>Container</code>
* of the {@code Container}
* @see java.awt.FlowLayout#setVgap
* @since 1.1
*/
@ -333,11 +333,11 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
/**
* Sets the vertical gap between components and between
* the components and the borders of the <code>Container</code>.
* the components and the borders of the {@code Container}.
*
* @param vgap the vertical gap between components
* and between the components and the borders
* of the <code>Container</code>
* of the {@code Container}
* @see java.awt.FlowLayout#getVgap
* @since 1.1
*/
@ -578,7 +578,7 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
* <i>visible</i> component take
* its preferred size by reshaping the components in the
* target container in order to satisfy the alignment of
* this <code>FlowLayout</code> object.
* this {@code FlowLayout} object.
*
* @param target the specified component being laid out
* @see Container
@ -648,10 +648,10 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
//
private static final int currentSerialVersion = 1;
/**
* This represent the <code>currentSerialVersion</code>
* which is bein used. It will be one of two values :
* <code>0</code> versions before Java 2 platform v1.2..
* <code>1</code> versions after Java 2 platform v1.2..
* This represent the {@code currentSerialVersion}
* which is bein used. It will be one of two values:
* {@code 0} versions before Java 2 platform v1.2,
* {@code 1} versions after Java 2 platform v1.2.
*
* @serial
* @since 1.2
@ -676,7 +676,7 @@ public class FlowLayout implements LayoutManager, java.io.Serializable {
}
/**
* Returns a string representation of this <code>FlowLayout</code>
* Returns a string representation of this {@code FlowLayout}
* object and its values.
* @return a string representation of this layout
*/

2
jdk/src/java.desktop/share/classes/java/awt/FocusTraversalPolicy.java
View file

@ -147,7 +147,7 @@ public abstract class FocusTraversalPolicy {
/**
* Returns the Component that should receive the focus when a Window is
* made visible for the first time. Once the Window has been made visible
* by a call to <code>show()</code> or <code>setVisible(true)</code>, the
* by a call to {@code show()} or {@code setVisible(true)}, the
* initial Component will not be used again. Instead, if the Window loses
* and subsequently regains focus, or is made invisible or undisplayable
* and subsequently made visible and displayable, the Window's most

750
jdk/src/java.desktop/share/classes/java/awt/Font.java
View file

File diff suppressed because it is too large Load diff

4
jdk/src/java.desktop/share/classes/java/awt/FontFormatException.java
View file

@ -26,7 +26,7 @@
package java.awt;
/**
* Thrown by method createFont in the <code>Font</code> class to indicate
* Thrown by method createFont in the {@code Font} class to indicate
* that the specified font is bad.
*
* @author Parry Kejriwal
@ -42,7 +42,7 @@ class FontFormatException extends Exception {
/**
* Report a FontFormatException for the reason specified.
* @param reason a <code>String</code> message indicating why
* @param reason a {@code String} message indicating why
* the font is not accepted.
*/
public FontFormatException(String reason) {

286
jdk/src/java.desktop/share/classes/java/awt/FontMetrics.java
View file

@ -32,7 +32,7 @@ import java.awt.geom.Rectangle2D;
import java.text.CharacterIterator;
/**
* The <code>FontMetrics</code> class defines a font metrics object, which
* The {@code FontMetrics} class defines a font metrics object, which
* encapsulates information about the rendering of a particular font on a
* particular screen.
* <p>
@ -76,11 +76,11 @@ import java.text.CharacterIterator;
* maximum ascent of any character in the array. The descent is the
* maximum descent of any character in the array. The advance width
* is the sum of the advance widths of each of the characters in the
* character array. The advance of a <code>String</code> is the
* distance along the baseline of the <code>String</code>. This
* character array. The advance of a {@code String} is the
* distance along the baseline of the {@code String}. This
* distance is the width that should be used for centering or
* right-aligning the <code>String</code>.
* <p>Note that the advance of a <code>String</code> is not necessarily
* right-aligning the {@code String}.
* <p>Note that the advance of a {@code String} is not necessarily
* the sum of the advances of its characters measured in isolation
* because the width of a character can vary depending on its context.
* For example, in Arabic text, the shape of a character can change
@ -125,10 +125,10 @@ public abstract class FontMetrics implements java.io.Serializable {
private static final long serialVersionUID = 1681126225205050147L;
/**
* Creates a new <code>FontMetrics</code> object for finding out
* height and width information about the specified <code>Font</code>
* and specific character glyphs in that <code>Font</code>.
* @param font the <code>Font</code>
* Creates a new {@code FontMetrics} object for finding out
* height and width information about the specified {@code Font}
* and specific character glyphs in that {@code Font}.
* @param font the {@code Font}
* @see java.awt.Font
*/
protected FontMetrics(Font font) {
@ -136,25 +136,25 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Gets the <code>Font</code> described by this
* <code>FontMetrics</code> object.
* @return the <code>Font</code> described by this
* <code>FontMetrics</code> object.
* Gets the {@code Font} described by this
* {@code FontMetrics} object.
* @return the {@code Font} described by this
* {@code FontMetrics} object.
*/
public Font getFont() {
return font;
}
/**
* Gets the <code>FontRenderContext</code> used by this
* <code>FontMetrics</code> object to measure text.
* Gets the {@code FontRenderContext} used by this
* {@code FontMetrics} object to measure text.
* <p>
* Note that methods in this class which take a <code>Graphics</code>
* parameter measure text using the <code>FontRenderContext</code>
* of that <code>Graphics</code> object, and not this
* <code>FontRenderContext</code>
* @return the <code>FontRenderContext</code> used by this
* <code>FontMetrics</code> object.
* Note that methods in this class which take a {@code Graphics}
* parameter measure text using the {@code FontRenderContext}
* of that {@code Graphics} object, and not this
* {@code FontRenderContext}
* @return the {@code FontRenderContext} used by this
* {@code FontMetrics} object.
* @since 1.6
*/
public FontRenderContext getFontRenderContext() {
@ -163,12 +163,12 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Determines the <em>standard leading</em> of the
* <code>Font</code> described by this <code>FontMetrics</code>
* {@code Font} described by this {@code FontMetrics}
* object. The standard leading, or
* interline spacing, is the logical amount of space to be reserved
* between the descent of one line of text and the ascent of the next
* line. The height metric is calculated to include this extra space.
* @return the standard leading of the <code>Font</code>.
* @return the standard leading of the {@code Font}.
* @see #getHeight()
* @see #getAscent()
* @see #getDescent()
@ -178,12 +178,12 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Determines the <em>font ascent</em> of the <code>Font</code>
* described by this <code>FontMetrics</code> object. The font ascent
* Determines the <em>font ascent</em> of the {@code Font}
* described by this {@code FontMetrics} object. The font ascent
* is the distance from the font's baseline to the top of most
* alphanumeric characters. Some characters in the <code>Font</code>
* alphanumeric characters. Some characters in the {@code Font}
* might extend above the font ascent line.
* @return the font ascent of the <code>Font</code>.
* @return the font ascent of the {@code Font}.
* @see #getMaxAscent()
*/
public int getAscent() {
@ -191,14 +191,14 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Determines the <em>font descent</em> of the <code>Font</code>
* Determines the <em>font descent</em> of the {@code Font}
* described by this
* <code>FontMetrics</code> object. The font descent is the distance
* {@code FontMetrics} object. The font descent is the distance
* from the font's baseline to the bottom of most alphanumeric
* characters with descenders. Some characters in the
* <code>Font</code> might extend
* {@code Font} might extend
* below the font descent line.
* @return the font descent of the <code>Font</code>.
* @return the font descent of the {@code Font}.
* @see #getMaxDescent()
*/
public int getDescent() {
@ -223,11 +223,11 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Determines the maximum ascent of the <code>Font</code>
* described by this <code>FontMetrics</code> object. No character
* Determines the maximum ascent of the {@code Font}
* described by this {@code FontMetrics} object. No character
* extends further above the font's baseline than this height.
* @return the maximum ascent of any character in the
* <code>Font</code>.
* {@code Font}.
* @see #getAscent()
*/
public int getMaxAscent() {
@ -235,11 +235,11 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Determines the maximum descent of the <code>Font</code>
* described by this <code>FontMetrics</code> object. No character
* Determines the maximum descent of the {@code Font}
* described by this {@code FontMetrics} object. No character
* extends further below the font's baseline than this height.
* @return the maximum descent of any character in the
* <code>Font</code>.
* {@code Font}.
* @see #getDescent()
*/
public int getMaxDescent() {
@ -249,10 +249,10 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* For backward compatibility only.
* @return the maximum descent of any character in the
* <code>Font</code>.
* {@code Font}.
* @see #getMaxDescent()
* @deprecated As of JDK version 1.1.1,
* replaced by <code>getMaxDescent()</code>.
* replaced by {@code getMaxDescent()}.
*/
@Deprecated
public int getMaxDecent() {
@ -261,12 +261,12 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Gets the maximum advance width of any character in this
* <code>Font</code>. The advance is the
* {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* string's baseline. The advance of a <code>String</code> is
* string's baseline. The advance of a {@code String} is
* not necessarily the sum of the advances of its characters.
* @return the maximum advance width of any character
* in the <code>Font</code>, or <code>-1</code> if the
* in the {@code Font}, or {@code -1} if the
* maximum advance width is not known.
*/
public int getMaxAdvance() {
@ -275,10 +275,10 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the advance width of the specified character in this
* <code>Font</code>. The advance is the
* {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* character's baseline. Note that the advance of a
* <code>String</code> is not necessarily the sum of the advances
* {@code String} is not necessarily the sum of the advances
* of its characters.
*
* <p>This method doesn't validate the specified character to be a
@ -289,8 +289,8 @@ public abstract class FontMetrics implements java.io.Serializable {
*
* @param codePoint the character (Unicode code point) to be measured
* @return the advance width of the specified character
* in the <code>Font</code> described by this
* <code>FontMetrics</code> object.
* in the {@code Font} described by this
* {@code FontMetrics} object.
* @see #charsWidth(char[], int, int)
* @see #stringWidth(String)
*/
@ -310,10 +310,10 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the advance width of the specified character in this
* <code>Font</code>. The advance is the
* {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* character's baseline. Note that the advance of a
* <code>String</code> is not necessarily the sum of the advances
* {@code String} is not necessarily the sum of the advances
* of its characters.
*
* <p><b>Note:</b> This method cannot handle <a
@ -323,8 +323,8 @@ public abstract class FontMetrics implements java.io.Serializable {
*
* @param ch the character to be measured
* @return the advance width of the specified character
* in the <code>Font</code> described by this
* <code>FontMetrics</code> object.
* in the {@code Font} described by this
* {@code FontMetrics} object.
* @see #charsWidth(char[], int, int)
* @see #stringWidth(String)
*/
@ -338,16 +338,16 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the total advance width for showing the specified
* <code>String</code> in this <code>Font</code>. The advance
* {@code String} in this {@code Font}. The advance
* is the distance from the leftmost point to the rightmost point
* on the string's baseline.
* <p>
* Note that the advance of a <code>String</code> is
* Note that the advance of a {@code String} is
* not necessarily the sum of the advances of its characters.
* @param str the <code>String</code> to be measured
* @return the advance width of the specified <code>String</code>
* in the <code>Font</code> described by this
* <code>FontMetrics</code>.
* @param str the {@code String} to be measured
* @return the advance width of the specified {@code String}
* in the {@code Font} described by this
* {@code FontMetrics}.
* @throws NullPointerException if str is null.
* @see #bytesWidth(byte[], int, int)
* @see #charsWidth(char[], int, int)
@ -362,22 +362,22 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the total advance width for showing the specified array
* of characters in this <code>Font</code>. The advance is the
* of characters in this {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* string's baseline. The advance of a <code>String</code>
* string's baseline. The advance of a {@code String}
* is not necessarily the sum of the advances of its characters.
* This is equivalent to measuring a <code>String</code> of the
* This is equivalent to measuring a {@code String} of the
* characters in the specified range.
* @param data the array of characters to be measured
* @param off the start offset of the characters in the array
* @param len the number of characters to be measured from the array
* @return the advance width of the subarray of the specified
* <code>char</code> array in the font described by
* this <code>FontMetrics</code> object.
* @throws NullPointerException if <code>data</code> is null.
* @throws IndexOutOfBoundsException if the <code>off</code>
* and <code>len</code> arguments index characters outside
* the bounds of the <code>data</code> array.
* {@code char} array in the font described by
* this {@code FontMetrics} object.
* @throws NullPointerException if {@code data} is null.
* @throws IndexOutOfBoundsException if the {@code off}
* and {@code len} arguments index characters outside
* the bounds of the {@code data} array.
* @see #charWidth(int)
* @see #charWidth(char)
* @see #bytesWidth(byte[], int, int)
@ -389,23 +389,23 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the total advance width for showing the specified array
* of bytes in this <code>Font</code>. The advance is the
* of bytes in this {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* string's baseline. The advance of a <code>String</code>
* string's baseline. The advance of a {@code String}
* is not necessarily the sum of the advances of its characters.
* This is equivalent to measuring a <code>String</code> of the
* This is equivalent to measuring a {@code String} of the
* characters in the specified range.
* @param data the array of bytes to be measured
* @param off the start offset of the bytes in the array
* @param len the number of bytes to be measured from the array
* @return the advance width of the subarray of the specified
* <code>byte</code> array in the <code>Font</code>
* {@code byte} array in the {@code Font}
* described by
* this <code>FontMetrics</code> object.
* @throws NullPointerException if <code>data</code> is null.
* @throws IndexOutOfBoundsException if the <code>off</code>
* and <code>len</code> arguments index bytes outside
* the bounds of the <code>data</code> array.
* this {@code FontMetrics} object.
* @throws NullPointerException if {@code data} is null.
* @throws IndexOutOfBoundsException if the {@code off}
* and {@code len} arguments index bytes outside
* the bounds of the {@code data} array.
* @see #charsWidth(char[], int, int)
* @see #stringWidth(String)
*/
@ -416,14 +416,14 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Gets the advance widths of the first 256 characters in the
* <code>Font</code>. The advance is the
* {@code Font}. The advance is the
* distance from the leftmost point to the rightmost point on the
* character's baseline. Note that the advance of a
* <code>String</code> is not necessarily the sum of the advances
* {@code String} is not necessarily the sum of the advances
* of its characters.
* @return an array storing the advance widths of the
* characters in the <code>Font</code>
* described by this <code>FontMetrics</code> object.
* characters in the {@code Font}
* described by this {@code FontMetrics} object.
*/
public int[] getWidths() {
int widths[] = new int[256];
@ -434,15 +434,15 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Checks to see if the <code>Font</code> has uniform line metrics. A
* Checks to see if the {@code Font} has uniform line metrics. A
* composite font may consist of several different fonts to cover
* various character sets. In such cases, the
* <code>FontLineMetrics</code> objects are not uniform.
* {@code FontLineMetrics} objects are not uniform.
* Different fonts may have a different ascent, descent, metrics and
* so on. This information is sometimes necessary for line
* measuring and line breaking.
* @return <code>true</code> if the font has uniform line metrics;
* <code>false</code> otherwise.
* @return {@code true} if the font has uniform line metrics;
* {@code false} otherwise.
* @see java.awt.Font#hasUniformLineMetrics()
*/
public boolean hasUniformLineMetrics() {
@ -451,11 +451,11 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the {@link LineMetrics} object for the specified
* <code>String</code> in the specified {@link Graphics} context.
* @param str the specified <code>String</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>LineMetrics</code> object created with the
* specified <code>String</code> and <code>Graphics</code> context.
* {@code String} in the specified {@link Graphics} context.
* @param str the specified {@code String}
* @param context the specified {@code Graphics} context
* @return a {@code LineMetrics} object created with the
* specified {@code String} and {@code Graphics} context.
* @see java.awt.Font#getLineMetrics(String, FontRenderContext)
*/
public LineMetrics getLineMetrics( String str, Graphics context) {
@ -464,13 +464,13 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the {@link LineMetrics} object for the specified
* <code>String</code> in the specified {@link Graphics} context.
* @param str the specified <code>String</code>
* @param beginIndex the initial offset of <code>str</code>
* @param limit the end offset of <code>str</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>LineMetrics</code> object created with the
* specified <code>String</code> and <code>Graphics</code> context.
* {@code String} in the specified {@link Graphics} context.
* @param str the specified {@code String}
* @param beginIndex the initial offset of {@code str}
* @param limit the end offset of {@code str}
* @param context the specified {@code Graphics} context
* @return a {@code LineMetrics} object created with the
* specified {@code String} and {@code Graphics} context.
* @see java.awt.Font#getLineMetrics(String, int, int, FontRenderContext)
*/
public LineMetrics getLineMetrics( String str,
@ -483,11 +483,11 @@ public abstract class FontMetrics implements java.io.Serializable {
* Returns the {@link LineMetrics} object for the specified
* character array in the specified {@link Graphics} context.
* @param chars the specified character array
* @param beginIndex the initial offset of <code>chars</code>
* @param limit the end offset of <code>chars</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>LineMetrics</code> object created with the
* specified character array and <code>Graphics</code> context.
* @param beginIndex the initial offset of {@code chars}
* @param limit the end offset of {@code chars}
* @param context the specified {@code Graphics} context
* @return a {@code LineMetrics} object created with the
* specified character array and {@code Graphics} context.
* @see java.awt.Font#getLineMetrics(char[], int, int, FontRenderContext)
*/
public LineMetrics getLineMetrics(char [] chars,
@ -501,11 +501,11 @@ public abstract class FontMetrics implements java.io.Serializable {
* Returns the {@link LineMetrics} object for the specified
* {@link CharacterIterator} in the specified {@link Graphics}
* context.
* @param ci the specified <code>CharacterIterator</code>
* @param beginIndex the initial offset in <code>ci</code>
* @param limit the end index of <code>ci</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>LineMetrics</code> object created with the
* @param ci the specified {@code CharacterIterator}
* @param beginIndex the initial offset in {@code ci}
* @param limit the end index of {@code ci}
* @param context the specified {@code Graphics} context
* @return a {@code LineMetrics} object created with the
* specified arguments.
* @see java.awt.Font#getLineMetrics(CharacterIterator, int, int, FontRenderContext)
*/
@ -516,16 +516,16 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Returns the bounds of the specified <code>String</code> in the
* specified <code>Graphics</code> context. The bounds is used
* to layout the <code>String</code>.
* Returns the bounds of the specified {@code String} in the
* specified {@code Graphics} context. The bounds is used
* to layout the {@code String}.
* <p>Note: The returned bounds is in baseline-relative coordinates
* (see {@link java.awt.FontMetrics class notes}).
* @param str the specified <code>String</code>
* @param context the specified <code>Graphics</code> context
* @param str the specified {@code String}
* @param context the specified {@code Graphics} context
* @return a {@link Rectangle2D} that is the bounding box of the
* specified <code>String</code> in the specified
* <code>Graphics</code> context.
* specified {@code String} in the specified
* {@code Graphics} context.
* @see java.awt.Font#getStringBounds(String, FontRenderContext)
*/
public Rectangle2D getStringBounds( String str, Graphics context) {
@ -533,18 +533,18 @@ public abstract class FontMetrics implements java.io.Serializable {
}
/**
* Returns the bounds of the specified <code>String</code> in the
* specified <code>Graphics</code> context. The bounds is used
* to layout the <code>String</code>.
* Returns the bounds of the specified {@code String} in the
* specified {@code Graphics} context. The bounds is used
* to layout the {@code String}.
* <p>Note: The returned bounds is in baseline-relative coordinates
* (see {@link java.awt.FontMetrics class notes}).
* @param str the specified <code>String</code>
* @param beginIndex the offset of the beginning of <code>str</code>
* @param limit the end offset of <code>str</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>Rectangle2D</code> that is the bounding box of the
* specified <code>String</code> in the specified
* <code>Graphics</code> context.
* @param str the specified {@code String}
* @param beginIndex the offset of the beginning of {@code str}
* @param limit the end offset of {@code str}
* @param context the specified {@code Graphics} context
* @return a {@code Rectangle2D} that is the bounding box of the
* specified {@code String} in the specified
* {@code Graphics} context.
* @see java.awt.Font#getStringBounds(String, int, int, FontRenderContext)
*/
public Rectangle2D getStringBounds( String str,
@ -556,20 +556,20 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the bounds of the specified array of characters
* in the specified <code>Graphics</code> context.
* The bounds is used to layout the <code>String</code>
* in the specified {@code Graphics} context.
* The bounds is used to layout the {@code String}
* created with the specified array of characters,
* <code>beginIndex</code> and <code>limit</code>.
* {@code beginIndex} and {@code limit}.
* <p>Note: The returned bounds is in baseline-relative coordinates
* (see {@link java.awt.FontMetrics class notes}).
* @param chars an array of characters
* @param beginIndex the initial offset of the array of
* characters
* @param limit the end offset of the array of characters
* @param context the specified <code>Graphics</code> context
* @return a <code>Rectangle2D</code> that is the bounding box of the
* @param context the specified {@code Graphics} context
* @return a {@code Rectangle2D} that is the bounding box of the
* specified character array in the specified
* <code>Graphics</code> context.
* {@code Graphics} context.
* @see java.awt.Font#getStringBounds(char[], int, int, FontRenderContext)
*/
public Rectangle2D getStringBounds( char [] chars,
@ -581,17 +581,17 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the bounds of the characters indexed in the specified
* <code>CharacterIterator</code> in the
* specified <code>Graphics</code> context.
* {@code CharacterIterator} in the
* specified {@code Graphics} context.
* <p>Note: The returned bounds is in baseline-relative coordinates
* (see {@link java.awt.FontMetrics class notes}).
* @param ci the specified <code>CharacterIterator</code>
* @param beginIndex the initial offset in <code>ci</code>
* @param limit the end index of <code>ci</code>
* @param context the specified <code>Graphics</code> context
* @return a <code>Rectangle2D</code> that is the bounding box of the
* characters indexed in the specified <code>CharacterIterator</code>
* in the specified <code>Graphics</code> context.
* @param ci the specified {@code CharacterIterator}
* @param beginIndex the initial offset in {@code ci}
* @param limit the end index of {@code ci}
* @param context the specified {@code Graphics} context
* @return a {@code Rectangle2D} that is the bounding box of the
* characters indexed in the specified {@code CharacterIterator}
* in the specified {@code Graphics} context.
* @see java.awt.Font#getStringBounds(CharacterIterator, int, int, FontRenderContext)
*/
public Rectangle2D getStringBounds(CharacterIterator ci,
@ -603,9 +603,9 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns the bounds for the character with the maximum bounds
* in the specified <code>Graphics</code> context.
* @param context the specified <code>Graphics</code> context
* @return a <code>Rectangle2D</code> that is the
* in the specified {@code Graphics} context.
* @param context the specified {@code Graphics} context
* @return a {@code Rectangle2D} that is the
* bounding box for the character with the maximum bounds.
* @see java.awt.Font#getMaxCharBounds(FontRenderContext)
*/
@ -622,10 +622,10 @@ public abstract class FontMetrics implements java.io.Serializable {
/**
* Returns a representation of this <code>FontMetrics</code>
* object's values as a <code>String</code>.
* @return a <code>String</code> representation of this
* <code>FontMetrics</code> object.
* Returns a representation of this {@code FontMetrics}
* object's values as a {@code String}.
* @return a {@code String} representation of this
* {@code FontMetrics} object.
*/
public String toString() {
return getClass().getName() +

254
jdk/src/java.desktop/share/classes/java/awt/Frame.java
View file

@ -43,35 +43,35 @@ import sun.awt.AWTAccessor;
import sun.awt.SunToolkit;
/**
* A <code>Frame</code> is a top-level window with a title and a border.
* A {@code Frame} is a top-level window with a title and a border.
* <p>
* The size of the frame includes any area designated for the
* border. The dimensions of the border area may be obtained
* using the <code>getInsets</code> method, however, since
* using the {@code getInsets} method, however, since
* these dimensions are platform-dependent, a valid insets
* value cannot be obtained until the frame is made displayable
* by either calling <code>pack</code> or <code>show</code>.
* by either calling {@code pack} or {@code show}.
* Since the border area is included in the overall size of the
* frame, the border effectively obscures a portion of the frame,
* constraining the area available for rendering and/or displaying
* subcomponents to the rectangle which has an upper-left corner
* location of <code>(insets.left, insets.top)</code>, and has a size of
* <code>width - (insets.left + insets.right)</code> by
* <code>height - (insets.top + insets.bottom)</code>.
* location of {@code (insets.left, insets.top)}, and has a size of
* {@code width - (insets.left + insets.right)} by
* {@code height - (insets.top + insets.bottom)}.
* <p>
* The default layout for a frame is <code>BorderLayout</code>.
* The default layout for a frame is {@code BorderLayout}.
* <p>
* A frame may have its native decorations (i.e. <code>Frame</code>
* and <code>Titlebar</code>) turned off
* with <code>setUndecorated</code>. This can only be done while the frame
* A frame may have its native decorations (i.e. {@code Frame}
* and {@code Titlebar}) turned off
* with {@code setUndecorated}. This can only be done while the frame
* is not {@link Component#isDisplayable() displayable}.
* <p>
* In a multi-screen environment, you can create a <code>Frame</code>
* on a different screen device by constructing the <code>Frame</code>
* In a multi-screen environment, you can create a {@code Frame}
* on a different screen device by constructing the {@code Frame}
* with {@link #Frame(GraphicsConfiguration)} or
* {@link #Frame(String title, GraphicsConfiguration)}. The
* <code>GraphicsConfiguration</code> object is one of the
* <code>GraphicsConfiguration</code> objects of the target screen
* {@code GraphicsConfiguration} object is one of the
* {@code GraphicsConfiguration} objects of the target screen
* device.
* <p>
* In a virtual device multi-screen environment in which the desktop
@ -87,22 +87,22 @@ import sun.awt.SunToolkit;
* shows (0,0) coords while a different physical screen shows (-80,-100) coords."
* style="float:center; margin: 7px 10px;">
* <p>
* In such an environment, when calling <code>setLocation</code>,
* In such an environment, when calling {@code setLocation},
* you must pass a virtual coordinate to this method. Similarly,
* calling <code>getLocationOnScreen</code> on a <code>Frame</code>
* returns virtual device coordinates. Call the <code>getBounds</code>
* method of a <code>GraphicsConfiguration</code> to find its origin in
* calling {@code getLocationOnScreen} on a {@code Frame}
* returns virtual device coordinates. Call the {@code getBounds}
* method of a {@code GraphicsConfiguration} to find its origin in
* the virtual coordinate system.
* <p>
* The following code sets the
* location of the <code>Frame</code> at (10, 10) relative
* location of the {@code Frame} at (10, 10) relative
* to the origin of the physical screen of the corresponding
* <code>GraphicsConfiguration</code>. If the bounds of the
* <code>GraphicsConfiguration</code> is not taken into account, the
* <code>Frame</code> location would be set at (10, 10) relative to the
* {@code GraphicsConfiguration}. If the bounds of the
* {@code GraphicsConfiguration} is not taken into account, the
* {@code Frame} location would be set at (10, 10) relative to the
* virtual-coordinate system and would appear on the primary physical
* screen, which might be different from the physical screen of the
* specified <code>GraphicsConfiguration</code>.
* specified {@code GraphicsConfiguration}.
*
* <pre>
* Frame f = new Frame(GraphicsConfiguration gc);
@ -112,21 +112,21 @@ import sun.awt.SunToolkit;
*
* <p>
* Frames are capable of generating the following types of
* <code>WindowEvent</code>s:
* {@code WindowEvent}s:
* <ul>
* <li><code>WINDOW_OPENED</code>
* <li><code>WINDOW_CLOSING</code>:
* <li>{@code WINDOW_OPENED}
* <li>{@code WINDOW_CLOSING}:
* <br>If the program doesn't
* explicitly hide or dispose the window while processing
* this event, the window close operation is canceled.
* <li><code>WINDOW_CLOSED</code>
* <li><code>WINDOW_ICONIFIED</code>
* <li><code>WINDOW_DEICONIFIED</code>
* <li><code>WINDOW_ACTIVATED</code>
* <li><code>WINDOW_DEACTIVATED</code>
* <li><code>WINDOW_GAINED_FOCUS</code>
* <li><code>WINDOW_LOST_FOCUS</code>
* <li><code>WINDOW_STATE_CHANGED</code>
* <li>{@code WINDOW_CLOSED}
* <li>{@code WINDOW_ICONIFIED}
* <li>{@code WINDOW_DEICONIFIED}
* <li>{@code WINDOW_ACTIVATED}
* <li>{@code WINDOW_DEACTIVATED}
* <li>{@code WINDOW_GAINED_FOCUS}
* <li>{@code WINDOW_LOST_FOCUS}
* <li>{@code WINDOW_STATE_CHANGED}
* </ul>
*
* @author Sami Shaio
@ -141,86 +141,86 @@ public class Frame extends Window implements MenuContainer {
*/
/**
* @deprecated replaced by <code>Cursor.DEFAULT_CURSOR</code>.
* @deprecated replaced by {@code Cursor.DEFAULT_CURSOR}.
*/
@Deprecated
public static final int DEFAULT_CURSOR = Cursor.DEFAULT_CURSOR;
/**
* @deprecated replaced by <code>Cursor.CROSSHAIR_CURSOR</code>.
* @deprecated replaced by {@code Cursor.CROSSHAIR_CURSOR}.
*/
@Deprecated
public static final int CROSSHAIR_CURSOR = Cursor.CROSSHAIR_CURSOR;
/**
* @deprecated replaced by <code>Cursor.TEXT_CURSOR</code>.
* @deprecated replaced by {@code Cursor.TEXT_CURSOR}.
*/
@Deprecated
public static final int TEXT_CURSOR = Cursor.TEXT_CURSOR;
/**
* @deprecated replaced by <code>Cursor.WAIT_CURSOR</code>.
* @deprecated replaced by {@code Cursor.WAIT_CURSOR}.
*/
@Deprecated
public static final int WAIT_CURSOR = Cursor.WAIT_CURSOR;
/**
* @deprecated replaced by <code>Cursor.SW_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.SW_RESIZE_CURSOR}.
*/
@Deprecated
public static final int SW_RESIZE_CURSOR = Cursor.SW_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.SE_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.SE_RESIZE_CURSOR}.
*/
@Deprecated
public static final int SE_RESIZE_CURSOR = Cursor.SE_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.NW_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.NW_RESIZE_CURSOR}.
*/
@Deprecated
public static final int NW_RESIZE_CURSOR = Cursor.NW_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.NE_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.NE_RESIZE_CURSOR}.
*/
@Deprecated
public static final int NE_RESIZE_CURSOR = Cursor.NE_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.N_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.N_RESIZE_CURSOR}.
*/
@Deprecated
public static final int N_RESIZE_CURSOR = Cursor.N_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.S_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.S_RESIZE_CURSOR}.
*/
@Deprecated
public static final int S_RESIZE_CURSOR = Cursor.S_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.W_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.W_RESIZE_CURSOR}.
*/
@Deprecated
public static final int W_RESIZE_CURSOR = Cursor.W_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.E_RESIZE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.E_RESIZE_CURSOR}.
*/
@Deprecated
public static final int E_RESIZE_CURSOR = Cursor.E_RESIZE_CURSOR;
/**
* @deprecated replaced by <code>Cursor.HAND_CURSOR</code>.
* @deprecated replaced by {@code Cursor.HAND_CURSOR}.
*/
@Deprecated
public static final int HAND_CURSOR = Cursor.HAND_CURSOR;
/**
* @deprecated replaced by <code>Cursor.MOVE_CURSOR</code>.
* @deprecated replaced by {@code Cursor.MOVE_CURSOR}.
*/
@Deprecated
public static final int MOVE_CURSOR = Cursor.MOVE_CURSOR;
@ -293,8 +293,8 @@ public class Frame extends Window implements MenuContainer {
/**
* This is the title of the frame. It can be changed
* at any time. <code>title</code> can be null and if
* this is the case the <code>title</code> = "".
* at any time. {@code title} can be null and if
* this is the case the {@code title} = "".
*
* @serial
* @see #getTitle
@ -303,7 +303,7 @@ public class Frame extends Window implements MenuContainer {
String title = "Untitled";
/**
* The frames menubar. If <code>menuBar</code> = null
* The frames menubar. If {@code menuBar} = null
* the frame will not have a menubar.
*
* @serial
@ -315,7 +315,7 @@ public class Frame extends Window implements MenuContainer {
/**
* This field indicates whether the frame is resizable.
* This property can be changed at any time.
* <code>resizable</code> will be true if the frame is
* {@code resizable} will be true if the frame is
* resizable, otherwise it will be false.
*
* @serial
@ -326,7 +326,7 @@ public class Frame extends Window implements MenuContainer {
/**
* This field indicates whether the frame is undecorated.
* This property can only be changed while the frame is not displayable.
* <code>undecorated</code> will be true if the frame is
* {@code undecorated} will be true if the frame is
* undecorated, otherwise it will be false.
*
* @serial
@ -338,7 +338,7 @@ public class Frame extends Window implements MenuContainer {
boolean undecorated = false;
/**
* <code>mbManagement</code> is only used by the Motif implementation.
* {@code mbManagement} is only used by the Motif implementation.
*
* @serial
*/
@ -374,11 +374,11 @@ public class Frame extends Window implements MenuContainer {
}
/**
* Constructs a new instance of <code>Frame</code> that is
* initially invisible. The title of the <code>Frame</code>
* Constructs a new instance of {@code Frame} that is
* initially invisible. The title of the {@code Frame}
* is empty.
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see Component#setSize
* @see Component#setVisible(boolean)
@ -391,14 +391,14 @@ public class Frame extends Window implements MenuContainer {
* Constructs a new, initially invisible {@code Frame} with the
* specified {@code GraphicsConfiguration}.
*
* @param gc the <code>GraphicsConfiguration</code>
* of the target screen device. If <code>gc</code>
* is <code>null</code>, the system default
* <code>GraphicsConfiguration</code> is assumed.
* @param gc the {@code GraphicsConfiguration}
* of the target screen device. If {@code gc}
* is {@code null}, the system default
* {@code GraphicsConfiguration} is assumed.
* @exception IllegalArgumentException if
* <code>gc</code> is not from a screen device.
* {@code gc} is not from a screen device.
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless()
* @since 1.3
*/
@ -407,13 +407,13 @@ public class Frame extends Window implements MenuContainer {
}
/**
* Constructs a new, initially invisible <code>Frame</code> object
* Constructs a new, initially invisible {@code Frame} object
* with the specified title.
* @param title the title to be displayed in the frame's border.
* A <code>null</code> value
* A {@code null} value
* is treated as an empty string, "".
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see java.awt.Component#setSize
* @see java.awt.Component#setVisible(boolean)
@ -424,20 +424,20 @@ public class Frame extends Window implements MenuContainer {
}
/**
* Constructs a new, initially invisible <code>Frame</code> object
* Constructs a new, initially invisible {@code Frame} object
* with the specified title and a
* <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @param title the title to be displayed in the frame's border.
* A <code>null</code> value
* A {@code null} value
* is treated as an empty string, "".
* @param gc the <code>GraphicsConfiguration</code>
* of the target screen device. If <code>gc</code> is
* <code>null</code>, the system default
* <code>GraphicsConfiguration</code> is assumed.
* @exception IllegalArgumentException if <code>gc</code>
* @param gc the {@code GraphicsConfiguration}
* of the target screen device. If {@code gc} is
* {@code null}, the system default
* {@code GraphicsConfiguration} is assumed.
* @exception IllegalArgumentException if {@code gc}
* is not from a screen device.
* @exception HeadlessException when
* <code>GraphicsEnvironment.isHeadless()</code> returns <code>true</code>
* {@code GraphicsEnvironment.isHeadless()} returns {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see java.awt.Component#setSize
* @see java.awt.Component#setVisible(boolean)
@ -504,7 +504,7 @@ public class Frame extends Window implements MenuContainer {
/**
* Sets the title for this frame to the specified string.
* @param title the title to be displayed in the frame's border.
* A <code>null</code> value
* A {@code null} value
* is treated as an empty string, "".
* @see #getTitle
*/
@ -534,7 +534,7 @@ public class Frame extends Window implements MenuContainer {
* If a list of several images was specified as a Window's icon,
* this method will return the first item of the list.
*
* @return the icon image for this frame, or <code>null</code>
* @return the icon image for this frame, or {@code null}
* if this frame doesn't have an icon image.
* @see #setIconImage(Image)
* @see Window#getIconImages()
@ -559,7 +559,7 @@ public class Frame extends Window implements MenuContainer {
/**
* Gets the menu bar for this frame.
* @return the menu bar for this frame, or <code>null</code>
* @return the menu bar for this frame, or {@code null}
* if this frame doesn't have a menu bar.
* @see #setMenuBar(MenuBar)
*/
@ -570,7 +570,7 @@ public class Frame extends Window implements MenuContainer {
/**
* Sets the menu bar for this frame to the specified menu bar.
* @param mb the menu bar being set.
* If this parameter is <code>null</code> then any
* If this parameter is {@code null} then any
* existing menu bar on this frame is removed.
* @see #getMenuBar
*/
@ -603,8 +603,8 @@ public class Frame extends Window implements MenuContainer {
/**
* Indicates whether this frame is resizable by the user.
* By default, all frames are initially resizable.
* @return <code>true</code> if the user can resize this frame;
* <code>false</code> otherwise.
* @return {@code true} if the user can resize this frame;
* {@code false} otherwise.
* @see java.awt.Frame#setResizable(boolean)
*/
public boolean isResizable() {
@ -613,8 +613,8 @@ public class Frame extends Window implements MenuContainer {
/**
* Sets whether this frame is resizable by the user.
* @param resizable <code>true</code> if this frame is resizable;
* <code>false</code> otherwise.
* @param resizable {@code true} if this frame is resizable;
* {@code false} otherwise.
* @see java.awt.Frame#isResizable
*/
public void setResizable(boolean resizable) {
@ -683,8 +683,8 @@ public class Frame extends Window implements MenuContainer {
* java.awt.event.WindowEvent#WINDOW_STATE_CHANGED}
* events is not guaranteed in this case also.
*
* @param state either <code>Frame.NORMAL</code> or
* <code>Frame.ICONIFIED</code>.
* @param state either {@code Frame.NORMAL} or
* {@code Frame.ICONIFIED}.
* @see #setExtendedState(int)
* @see java.awt.Window#addWindowStateListener
*/
@ -702,14 +702,14 @@ public class Frame extends Window implements MenuContainer {
* Sets the state of this frame. The state is
* represented as a bitwise mask.
* <ul>
* <li><code>NORMAL</code>
* <li>{@code NORMAL}
* <br>Indicates that no state bits are set.
* <li><code>ICONIFIED</code>
* <li><code>MAXIMIZED_HORIZ</code>
* <li><code>MAXIMIZED_VERT</code>
* <li><code>MAXIMIZED_BOTH</code>
* <br>Concatenates <code>MAXIMIZED_HORIZ</code>
* and <code>MAXIMIZED_VERT</code>.
* <li>{@code ICONIFIED}
* <li>{@code MAXIMIZED_HORIZ}
* <li>{@code MAXIMIZED_VERT}
* <li>{@code MAXIMIZED_BOTH}
* <br>Concatenates {@code MAXIMIZED_HORIZ}
* and {@code MAXIMIZED_VERT}.
* </ul>
* <p>Note that if the state is not supported on a
* given platform, neither the state nor the return
@ -780,11 +780,11 @@ public class Frame extends Window implements MenuContainer {
* expanded and frame state is represented as a bitwise mask.
* <p>
* For compatibility with old programs this method still returns
* <code>Frame.NORMAL</code> and <code>Frame.ICONIFIED</code> but
* {@code Frame.NORMAL} and {@code Frame.ICONIFIED} but
* it only reports the iconic state of the frame, other aspects of
* frame state are not reported by this method.
*
* @return <code>Frame.NORMAL</code> or <code>Frame.ICONIFIED</code>.
* @return {@code Frame.NORMAL} or {@code Frame.ICONIFIED}.
* @see #setState(int)
* @see #getExtendedState
*/
@ -797,14 +797,14 @@ public class Frame extends Window implements MenuContainer {
* Gets the state of this frame. The state is
* represented as a bitwise mask.
* <ul>
* <li><code>NORMAL</code>
* <li>{@code NORMAL}
* <br>Indicates that no state bits are set.
* <li><code>ICONIFIED</code>
* <li><code>MAXIMIZED_HORIZ</code>
* <li><code>MAXIMIZED_VERT</code>
* <li><code>MAXIMIZED_BOTH</code>
* <br>Concatenates <code>MAXIMIZED_HORIZ</code>
* and <code>MAXIMIZED_VERT</code>.
* <li>{@code ICONIFIED}
* <li>{@code MAXIMIZED_HORIZ}
* <li>{@code MAXIMIZED_VERT}
* <li>{@code MAXIMIZED_BOTH}
* <br>Concatenates {@code MAXIMIZED_HORIZ}
* and {@code MAXIMIZED_VERT}.
* </ul>
*
* @return a bitwise mask of frame state constants
@ -846,11 +846,11 @@ public class Frame extends Window implements MenuContainer {
* defaults bounds. This method allows some or all of those
* system supplied values to be overridden.
* <p>
* If <code>bounds</code> is <code>null</code>, accept bounds
* supplied by the system. If non-<code>null</code> you can
* If {@code bounds} is {@code null}, accept bounds
* supplied by the system. If non-{@code null} you can
* override some of the system supplied values while accepting
* others by setting those fields you want to accept from system
* to <code>Integer.MAX_VALUE</code>.
* to {@code Integer.MAX_VALUE}.
* <p>
* Note, the given maximized bounds are used as a hint for the native
* system, because the underlying platform may not support setting the
@ -874,10 +874,10 @@ public class Frame extends Window implements MenuContainer {
/**
* Gets maximized bounds for this frame.
* Some fields may contain <code>Integer.MAX_VALUE</code> to indicate
* Some fields may contain {@code Integer.MAX_VALUE} to indicate
* that system supplied values for this field must be used.
*
* @return maximized bounds for this frame; may be <code>null</code>
* @return maximized bounds for this frame; may be {@code null}
* @see #setMaximizedBounds(Rectangle)
* @since 1.4
*/
@ -943,8 +943,8 @@ public class Frame extends Window implements MenuContainer {
/**
* Indicates whether this frame is undecorated.
* By default, all frames are initially decorated.
* @return <code>true</code> if frame is undecorated;
* <code>false</code> otherwise.
* @return {@code true} if frame is undecorated;
* {@code false} otherwise.
* @see java.awt.Frame#setUndecorated(boolean)
* @since 1.4
*/
@ -994,7 +994,7 @@ public class Frame extends Window implements MenuContainer {
/**
* Removes the specified menu bar from this frame.
* @param m the menu component to remove.
* If <code>m</code> is <code>null</code>, then
* If {@code m} is {@code null}, then
* no action is taken
*/
public void remove(MenuComponent m) {
@ -1053,11 +1053,11 @@ public class Frame extends Window implements MenuContainer {
}
/**
* Returns a string representing the state of this <code>Frame</code>.
* Returns a string representing the state of this {@code Frame}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* <code>null</code>.
* {@code null}.
*
* @return the parameter string of this frame
*/
@ -1095,7 +1095,7 @@ public class Frame extends Window implements MenuContainer {
*
* @param cursorType the cursor type
* @deprecated As of JDK version 1.1,
* replaced by <code>Component.setCursor(Cursor)</code>.
* replaced by {@code Component.setCursor(Cursor)}.
*/
@Deprecated
public void setCursor(int cursorType) {
@ -1107,7 +1107,7 @@ public class Frame extends Window implements MenuContainer {
/**
* @deprecated As of JDK version 1.1,
* replaced by <code>Component.getCursor()</code>.
* replaced by {@code Component.getCursor()}.
* @return the cursor type for this frame
*/
@Deprecated
@ -1124,7 +1124,7 @@ public class Frame extends Window implements MenuContainer {
* as a shared, hidden frame which is used by Swing. Applications
* should not assume the existence of these frames, nor should an
* application assume anything about these frames such as component
* positions, <code>LayoutManager</code>s or serialization.
* positions, {@code LayoutManager}s or serialization.
* <p>
* <b>Note</b>: To obtain a list of all ownerless windows, including
* ownerless {@code Dialog}s (introduced in release 1.6), use {@link
@ -1164,7 +1164,7 @@ public class Frame extends Window implements MenuContainer {
*/
/**
* <code>Frame</code>'s Serialized Data Version.
* {@code Frame}'s Serialized Data Version.
*
* @serial
*/
@ -1172,11 +1172,11 @@ public class Frame extends Window implements MenuContainer {
/**
* Writes default serializable fields to stream. Writes
* an optional serializable icon <code>Image</code>, which is
* an optional serializable icon {@code Image}, which is
* available as of 1.4.
*
* @param s the <code>ObjectOutputStream</code> to write
* @serialData an optional icon <code>Image</code>
* @param s the {@code ObjectOutputStream} to write
* @serialData an optional icon {@code Image}
* @see java.awt.Image
* @see #getIconImage
* @see #setIconImage(Image)
@ -1197,21 +1197,21 @@ public class Frame extends Window implements MenuContainer {
}
/**
* Reads the <code>ObjectInputStream</code>. Tries
* to read an icon <code>Image</code>, which is optional
* data available as of 1.4. If an icon <code>Image</code>
* Reads the {@code ObjectInputStream}. Tries
* to read an icon {@code Image}, which is optional
* data available as of 1.4. If an icon {@code Image}
* is not available, but anything other than an EOF
* is detected, an <code>OptionalDataException</code>
* is detected, an {@code OptionalDataException}
* will be thrown.
* Unrecognized keys or values will be ignored.
*
* @param s the <code>ObjectInputStream</code> to read
* @exception java.io.OptionalDataException if an icon <code>Image</code>
* @param s the {@code ObjectInputStream} to read
* @exception java.io.OptionalDataException if an icon {@code Image}
* is not available, but anything other than an EOF
* is detected
* @exception HeadlessException if
* <code>GraphicsEnvironment.isHeadless</code> returns
* <code>true</code>
* {@code GraphicsEnvironment.isHeadless} returns
* {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see java.awt.Image
* @see #getIconImage
@ -1285,7 +1285,7 @@ public class Frame extends Window implements MenuContainer {
/**
* This class implements accessibility support for the
* <code>Frame</code> class. It provides an implementation of the
* {@code Frame} class. It provides an implementation of the
* Java Accessibility API appropriate to frame user-interface elements.
* @since 1.3
*/

106
jdk/src/java.desktop/share/classes/java/awt/GradientPaint.java
View file

@ -32,11 +32,11 @@ import java.awt.image.ColorModel;
import java.beans.ConstructorProperties;
/**
* The <code>GradientPaint</code> class provides a way to fill
* The {@code GradientPaint} class provides a way to fill
* a {@link Shape} with a linear color gradient pattern.
* If {@link Point} P1 with {@link Color} C1 and <code>Point</code> P2 with
* <code>Color</code> C2 are specified in user space, the
* <code>Color</code> on the P1, P2 connecting line is proportionally
* If {@link Point} P1 with {@link Color} C1 and {@code Point} P2 with
* {@code Color} C2 are specified in user space, the
* {@code Color} on the P1, P2 connecting line is proportionally
* changed from C1 to C2. Any point P not on the extended P1, P2
* connecting line has the color of the point P' that is the perpendicular
* projection of P on the extended P1, P2 connecting line.
@ -48,8 +48,8 @@ import java.beans.ConstructorProperties;
* connecting line cycle back and forth between the colors C1 and C2.
* <li>
* If the gradient is acyclic then points on the P1 side of the segment
* have the constant <code>Color</code> C1 while points on the P2 side
* have the constant <code>Color</code> C2.
* have the constant {@code Color} C1 while points on the P2 side
* have the constant {@code Color} C2.
* </ul>
*
* @see Paint
@ -65,19 +65,19 @@ public class GradientPaint implements Paint {
boolean cyclic;
/**
* Constructs a simple acyclic <code>GradientPaint</code> object.
* Constructs a simple acyclic {@code GradientPaint} object.
* @param x1 x coordinate of the first specified
* <code>Point</code> in user space
* {@code Point} in user space
* @param y1 y coordinate of the first specified
* <code>Point</code> in user space
* @param color1 <code>Color</code> at the first specified
* <code>Point</code>
* {@code Point} in user space
* @param color1 {@code Color} at the first specified
* {@code Point}
* @param x2 x coordinate of the second specified
* <code>Point</code> in user space
* {@code Point} in user space
* @param y2 y coordinate of the second specified
* <code>Point</code> in user space
* @param color2 <code>Color</code> at the second specified
* <code>Point</code>
* {@code Point} in user space
* @param color2 {@code Color} at the second specified
* {@code Point}
* @throws NullPointerException if either one of colors is null
*/
public GradientPaint(float x1,
@ -97,13 +97,13 @@ public class GradientPaint implements Paint {
}
/**
* Constructs a simple acyclic <code>GradientPaint</code> object.
* @param pt1 the first specified <code>Point</code> in user space
* @param color1 <code>Color</code> at the first specified
* <code>Point</code>
* @param pt2 the second specified <code>Point</code> in user space
* @param color2 <code>Color</code> at the second specified
* <code>Point</code>
* Constructs a simple acyclic {@code GradientPaint} object.
* @param pt1 the first specified {@code Point} in user space
* @param color1 {@code Color} at the first specified
* {@code Point}
* @param pt2 the second specified {@code Point} in user space
* @param color2 {@code Color} at the second specified
* {@code Point}
* @throws NullPointerException if either one of colors or points
* is null
*/
@ -123,22 +123,22 @@ public class GradientPaint implements Paint {
}
/**
* Constructs either a cyclic or acyclic <code>GradientPaint</code>
* object depending on the <code>boolean</code> parameter.
* Constructs either a cyclic or acyclic {@code GradientPaint}
* object depending on the {@code boolean} parameter.
* @param x1 x coordinate of the first specified
* <code>Point</code> in user space
* {@code Point} in user space
* @param y1 y coordinate of the first specified
* <code>Point</code> in user space
* @param color1 <code>Color</code> at the first specified
* <code>Point</code>
* {@code Point} in user space
* @param color1 {@code Color} at the first specified
* {@code Point}
* @param x2 x coordinate of the second specified
* <code>Point</code> in user space
* {@code Point} in user space
* @param y2 y coordinate of the second specified
* <code>Point</code> in user space
* @param color2 <code>Color</code> at the second specified
* <code>Point</code>
* @param cyclic <code>true</code> if the gradient pattern should cycle
* repeatedly between the two colors; <code>false</code> otherwise
* {@code Point} in user space
* @param color2 {@code Color} at the second specified
* {@code Point}
* @param cyclic {@code true} if the gradient pattern should cycle
* repeatedly between the two colors; {@code false} otherwise
*/
public GradientPaint(float x1,
float y1,
@ -152,18 +152,18 @@ public class GradientPaint implements Paint {
}
/**
* Constructs either a cyclic or acyclic <code>GradientPaint</code>
* object depending on the <code>boolean</code> parameter.
* @param pt1 the first specified <code>Point</code>
* Constructs either a cyclic or acyclic {@code GradientPaint}
* object depending on the {@code boolean} parameter.
* @param pt1 the first specified {@code Point}
* in user space
* @param color1 <code>Color</code> at the first specified
* <code>Point</code>
* @param pt2 the second specified <code>Point</code>
* @param color1 {@code Color} at the first specified
* {@code Point}
* @param pt2 the second specified {@code Point}
* in user space
* @param color2 <code>Color</code> at the second specified
* <code>Point</code>
* @param cyclic <code>true</code> if the gradient pattern should cycle
* repeatedly between the two colors; <code>false</code> otherwise
* @param color2 {@code Color} at the second specified
* {@code Point}
* @param cyclic {@code true} if the gradient pattern should cycle
* repeatedly between the two colors; {@code false} otherwise
* @throws NullPointerException if either one of colors or points
* is null
*/
@ -181,7 +181,7 @@ public class GradientPaint implements Paint {
* Returns a copy of the point P1 that anchors the first color.
* @return a {@link Point2D} object that is a copy of the point
* that anchors the first color of this
* <code>GradientPaint</code>.
* {@code GradientPaint}.
*/
public Point2D getPoint1() {
return new Point2D.Float(p1.x, p1.y);
@ -189,7 +189,7 @@ public class GradientPaint implements Paint {
/**
* Returns the color C1 anchored by the point P1.
* @return a <code>Color</code> object that is the color
* @return a {@code Color} object that is the color
* anchored by P1.
*/
public Color getColor1() {
@ -200,7 +200,7 @@ public class GradientPaint implements Paint {
* Returns a copy of the point P2 which anchors the second color.
* @return a {@link Point2D} object that is a copy of the point
* that anchors the second color of this
* <code>GradientPaint</code>.
* {@code GradientPaint}.
*/
public Point2D getPoint2() {
return new Point2D.Float(p2.x, p2.y);
@ -208,7 +208,7 @@ public class GradientPaint implements Paint {
/**
* Returns the color C2 anchored by the point P2.
* @return a <code>Color</code> object that is the color
* @return a {@code Color} object that is the color
* anchored by P2.
*/
public Color getColor2() {
@ -216,10 +216,10 @@ public class GradientPaint implements Paint {
}
/**
* Returns <code>true</code> if the gradient cycles repeatedly
* Returns {@code true} if the gradient cycles repeatedly
* between the two colors C1 and C2.
* @return <code>true</code> if the gradient cycles repeatedly
* between the two colors; <code>false</code> otherwise.
* @return {@code true} if the gradient cycles repeatedly
* between the two colors; {@code false} otherwise.
*/
public boolean isCyclic() {
return cyclic;
@ -264,8 +264,8 @@ public class GradientPaint implements Paint {
}
/**
* Returns the transparency mode for this <code>GradientPaint</code>.
* @return an integer value representing this <code>GradientPaint</code>
* Returns the transparency mode for this {@code GradientPaint}.
* @return an integer value representing this {@code GradientPaint}
* object's transparency mode.
* @see Transparency
*/

240
jdk/src/java.desktop/share/classes/java/awt/Graphics.java
View file

@ -31,17 +31,17 @@ import java.awt.image.ImageObserver;
import java.text.AttributedCharacterIterator;
/**
* The <code>Graphics</code> class is the abstract base class for
* The {@code Graphics} class is the abstract base class for
* all graphics contexts that allow an application to draw onto
* components that are realized on various devices, as well as
* onto off-screen images.
* <p>
* A <code>Graphics</code> object encapsulates state information needed
* A {@code Graphics} object encapsulates state information needed
* for the basic rendering operations that Java supports. This
* state information includes the following properties:
*
* <ul>
* <li>The <code>Component</code> object on which to draw.
* <li>The {@code Component} object on which to draw.
* <li>A translation origin for rendering and clipping coordinates.
* <li>The current clip.
* <li>The current color.
@ -72,21 +72,21 @@ import java.text.AttributedCharacterIterator;
* the text, except for any descenders.
* </ul><p>
* All coordinates that appear as arguments to the methods of this
* <code>Graphics</code> object are considered relative to the
* translation origin of this <code>Graphics</code> object prior to
* {@code Graphics} object are considered relative to the
* translation origin of this {@code Graphics} object prior to
* the invocation of the method.
* <p>
* All rendering operations modify only pixels which lie within the
* area bounded by the current clip, which is specified by a {@link Shape}
* in user space and is controlled by the program using the
* <code>Graphics</code> object. This <i>user clip</i>
* {@code Graphics} object. This <i>user clip</i>
* is transformed into device space and combined with the
* <i>device clip</i>, which is defined by the visibility of windows and
* device extents. The combination of the user clip and device clip
* defines the <i>composite clip</i>, which determines the final clipping
* region. The user clip cannot be modified by the rendering
* system to reflect the resulting composite clip. The user clip can only
* be changed through the <code>setClip</code> or <code>clipRect</code>
* be changed through the {@code setClip} or {@code clipRect}
* methods.
* All drawing or writing is done in the current color,
* using the current paint mode, and in the current font.
@ -104,14 +104,14 @@ import java.text.AttributedCharacterIterator;
public abstract class Graphics {
/**
* Constructs a new <code>Graphics</code> object.
* Constructs a new {@code Graphics} object.
* This constructor is the default constructor for a graphics
* context.
* <p>
* Since <code>Graphics</code> is an abstract class, applications
* Since {@code Graphics} is an abstract class, applications
* cannot call this constructor directly. Graphics contexts are
* obtained from other graphics contexts or are created by calling
* <code>getGraphics</code> on a component.
* {@code getGraphics} on a component.
* @see java.awt.Graphics#create()
* @see java.awt.Component#getGraphics
*/
@ -119,36 +119,36 @@ public abstract class Graphics {
}
/**
* Creates a new <code>Graphics</code> object that is
* a copy of this <code>Graphics</code> object.
* Creates a new {@code Graphics} object that is
* a copy of this {@code Graphics} object.
* @return a new graphics context that is a copy of
* this graphics context.
*/
public abstract Graphics create();
/**
* Creates a new <code>Graphics</code> object based on this
* <code>Graphics</code> object, but with a new translation and clip area.
* The new <code>Graphics</code> object has its origin
* Creates a new {@code Graphics} object based on this
* {@code Graphics} object, but with a new translation and clip area.
* The new {@code Graphics} object has its origin
* translated to the specified point (<i>x</i>,&nbsp;<i>y</i>).
* Its clip area is determined by the intersection of the original
* clip area with the specified rectangle. The arguments are all
* interpreted in the coordinate system of the original
* <code>Graphics</code> object. The new graphics context is
* {@code Graphics} object. The new graphics context is
* identical to the original, except in two respects:
*
* <ul>
* <li>
* The new graphics context is translated by (<i>x</i>,&nbsp;<i>y</i>).
* That is to say, the point (<code>0</code>,&nbsp;<code>0</code>) in the
* That is to say, the point ({@code 0},&nbsp;{@code 0}) in the
* new graphics context is the same as (<i>x</i>,&nbsp;<i>y</i>) in
* the original graphics context.
* <li>
* The new graphics context has an additional clipping rectangle, in
* addition to whatever (translated) clipping rectangle it inherited
* from the original graphics context. The origin of the new clipping
* rectangle is at (<code>0</code>,&nbsp;<code>0</code>), and its size
* is specified by the <code>width</code> and <code>height</code>
* rectangle is at ({@code 0},&nbsp;{@code 0}), and its size
* is specified by the {@code width} and {@code height}
* arguments.
* </ul>
*
@ -273,12 +273,12 @@ public abstract class Graphics {
* This method refers to the user clip, which is independent of the
* clipping associated with device bounds and window visibility.
* If no clip has previously been set, or if the clip has been
* cleared using <code>setClip(null)</code>, this method returns
* <code>null</code>.
* cleared using {@code setClip(null)}, this method returns
* {@code null}.
* The coordinates in the rectangle are relative to the coordinate
* system origin of this graphics context.
* @return the bounding rectangle of the current clipping area,
* or <code>null</code> if no clip is set.
* or {@code null} if no clip is set.
* @see java.awt.Graphics#getClip
* @see java.awt.Graphics#clipRect
* @see java.awt.Graphics#setClip(int, int, int, int)
@ -292,7 +292,7 @@ public abstract class Graphics {
* The resulting clipping area is the intersection of the current
* clipping area and the specified rectangle. If there is no
* current clipping area, either because the clip has never been
* set, or the clip has been cleared using <code>setClip(null)</code>,
* set, or the clip has been cleared using {@code setClip(null)},
* the specified rectangle becomes the new clip.
* This method sets the user clip, which is independent of the
* clipping associated with device bounds and window visibility.
@ -330,10 +330,10 @@ public abstract class Graphics {
* This method returns the user clip, which is independent of the
* clipping associated with device bounds and window visibility.
* If no clip has previously been set, or if the clip has been
* cleared using <code>setClip(null)</code>, this method returns
* <code>null</code>.
* @return a <code>Shape</code> object representing the
* current clipping area, or <code>null</code> if
* cleared using {@code setClip(null)}, this method returns
* {@code null}.
* @return a {@code Shape} object representing the
* current clipping area, or {@code null} if
* no clip is set.
* @see java.awt.Graphics#getClipBounds
* @see java.awt.Graphics#clipRect
@ -345,15 +345,15 @@ public abstract class Graphics {
/**
* Sets the current clipping area to an arbitrary clip shape.
* Not all objects that implement the <code>Shape</code>
* Not all objects that implement the {@code Shape}
* interface can be used to set the clip. The only
* <code>Shape</code> objects that are guaranteed to be
* supported are <code>Shape</code> objects that are
* obtained via the <code>getClip</code> method and via
* <code>Rectangle</code> objects. This method sets the
* {@code Shape} objects that are guaranteed to be
* supported are {@code Shape} objects that are
* obtained via the {@code getClip} method and via
* {@code Rectangle} objects. This method sets the
* user clip, which is independent of the clipping associated
* with device bounds and window visibility.
* @param clip the <code>Shape</code> to use to set the clip
* @param clip the {@code Shape} to use to set the clip
* @see java.awt.Graphics#getClip()
* @see java.awt.Graphics#clipRect
* @see java.awt.Graphics#setClip(int, int, int, int)
@ -363,16 +363,16 @@ public abstract class Graphics {
/**
* Copies an area of the component by a distance specified by
* <code>dx</code> and <code>dy</code>. From the point specified
* by <code>x</code> and <code>y</code>, this method
* {@code dx} and {@code dy}. From the point specified
* by {@code x} and {@code y}, this method
* copies downwards and to the right. To copy an area of the
* component to the left or upwards, specify a negative value for
* <code>dx</code> or <code>dy</code>.
* {@code dx} or {@code dy}.
* If a portion of the source rectangle lies outside the bounds
* of the component, or is obscured by another window or component,
* <code>copyArea</code> will be unable to copy the associated
* {@code copyArea} will be unable to copy the associated
* pixels. The area that is omitted can be refreshed by calling
* the component's <code>paint</code> method.
* the component's {@code paint} method.
* @param x the <i>x</i> coordinate of the source rectangle.
* @param y the <i>y</i> coordinate of the source rectangle.
* @param width the width of the source rectangle.
@ -397,12 +397,12 @@ public abstract class Graphics {
/**
* Fills the specified rectangle.
* The left and right edges of the rectangle are at
* <code>x</code> and <code>x&nbsp;+&nbsp;width&nbsp;-&nbsp;1</code>.
* {@code x} and <code>x&nbsp;+&nbsp;width&nbsp;-&nbsp;1</code>.
* The top and bottom edges are at
* <code>y</code> and <code>y&nbsp;+&nbsp;height&nbsp;-&nbsp;1</code>.
* {@code y} and <code>y&nbsp;+&nbsp;height&nbsp;-&nbsp;1</code>.
* The resulting rectangle covers an area
* <code>width</code> pixels wide by
* <code>height</code> pixels tall.
* {@code width} pixels wide by
* {@code height} pixels tall.
* The rectangle is filled using the graphics context's current color.
* @param x the <i>x</i> coordinate
* of the rectangle to be filled.
@ -418,9 +418,9 @@ public abstract class Graphics {
/**
* Draws the outline of the specified rectangle.
* The left and right edges of the rectangle are at
* <code>x</code> and <code>x&nbsp;+&nbsp;width</code>.
* {@code x} and <code>x&nbsp;+&nbsp;width</code>.
* The top and bottom edges are at
* <code>y</code> and <code>y&nbsp;+&nbsp;height</code>.
* {@code y} and <code>y&nbsp;+&nbsp;height</code>.
* The rectangle is drawn using the graphics context's current color.
* @param x the <i>x</i> coordinate
* of the rectangle to be drawn.
@ -453,7 +453,7 @@ public abstract class Graphics {
* <p>
* Beginning with Java&nbsp;1.1, the background color
* of offscreen images may be system dependent. Applications should
* use <code>setColor</code> followed by <code>fillRect</code> to
* use {@code setColor} followed by {@code fillRect} to
* ensure that an offscreen image is cleared to a specific color.
* @param x the <i>x</i> coordinate of the rectangle to clear.
* @param y the <i>y</i> coordinate of the rectangle to clear.
@ -470,9 +470,9 @@ public abstract class Graphics {
/**
* Draws an outlined round-cornered rectangle using this graphics
* context's current color. The left and right edges of the rectangle
* are at <code>x</code> and <code>x&nbsp;+&nbsp;width</code>,
* are at {@code x} and <code>x&nbsp;+&nbsp;width</code>,
* respectively. The top and bottom edges of the rectangle are at
* <code>y</code> and <code>y&nbsp;+&nbsp;height</code>.
* {@code y} and <code>y&nbsp;+&nbsp;height</code>.
* @param x the <i>x</i> coordinate of the rectangle to be drawn.
* @param y the <i>y</i> coordinate of the rectangle to be drawn.
* @param width the width of the rectangle to be drawn.
@ -489,9 +489,9 @@ public abstract class Graphics {
/**
* Fills the specified rounded corner rectangle with the current color.
* The left and right edges of the rectangle
* are at <code>x</code> and <code>x&nbsp;+&nbsp;width&nbsp;-&nbsp;1</code>,
* are at {@code x} and <code>x&nbsp;+&nbsp;width&nbsp;-&nbsp;1</code>,
* respectively. The top and bottom edges of the rectangle are at
* <code>y</code> and <code>y&nbsp;+&nbsp;height&nbsp;-&nbsp;1</code>.
* {@code y} and <code>y&nbsp;+&nbsp;height&nbsp;-&nbsp;1</code>.
* @param x the <i>x</i> coordinate of the rectangle to be filled.
* @param y the <i>y</i> coordinate of the rectangle to be filled.
* @param width the width of the rectangle to be filled.
@ -576,8 +576,8 @@ public abstract class Graphics {
/**
* Draws the outline of an oval.
* The result is a circle or ellipse that fits within the
* rectangle specified by the <code>x</code>, <code>y</code>,
* <code>width</code>, and <code>height</code> arguments.
* rectangle specified by the {@code x}, {@code y},
* {@code width}, and {@code height} arguments.
* <p>
* The oval covers an area that is
* <code>width&nbsp;+&nbsp;1</code> pixels wide
@ -609,8 +609,8 @@ public abstract class Graphics {
* Draws the outline of a circular or elliptical arc
* covering the specified rectangle.
* <p>
* The resulting arc begins at <code>startAngle</code> and extends
* for <code>arcAngle</code> degrees, using the current color.
* The resulting arc begins at {@code startAngle} and extends
* for {@code arcAngle} degrees, using the current color.
* Angles are interpreted such that 0&nbsp;degrees
* is at the 3&nbsp;o'clock position.
* A positive value indicates a counter-clockwise rotation
@ -618,7 +618,7 @@ public abstract class Graphics {
* <p>
* The center of the arc is the center of the rectangle whose origin
* is (<i>x</i>,&nbsp;<i>y</i>) and whose size is specified by the
* <code>width</code> and <code>height</code> arguments.
* {@code width} and {@code height} arguments.
* <p>
* The resulting arc covers an area
* <code>width&nbsp;+&nbsp;1</code> pixels wide
@ -648,8 +648,8 @@ public abstract class Graphics {
/**
* Fills a circular or elliptical arc covering the specified rectangle.
* <p>
* The resulting arc begins at <code>startAngle</code> and extends
* for <code>arcAngle</code> degrees.
* The resulting arc begins at {@code startAngle} and extends
* for {@code arcAngle} degrees.
* Angles are interpreted such that 0&nbsp;degrees
* is at the 3&nbsp;o'clock position.
* A positive value indicates a counter-clockwise rotation
@ -657,7 +657,7 @@ public abstract class Graphics {
* <p>
* The center of the arc is the center of the rectangle whose origin
* is (<i>x</i>,&nbsp;<i>y</i>) and whose size is specified by the
* <code>width</code> and <code>height</code> arguments.
* {@code width} and {@code height} arguments.
* <p>
* The resulting arc covers an area
* <code>width&nbsp;+&nbsp;1</code> pixels wide
@ -704,16 +704,16 @@ public abstract class Graphics {
* arrays of <i>x</i> and <i>y</i> coordinates.
* Each pair of (<i>x</i>,&nbsp;<i>y</i>) coordinates defines a point.
* <p>
* This method draws the polygon defined by <code>nPoint</code> line
* This method draws the polygon defined by {@code nPoint} line
* segments, where the first <code>nPoint&nbsp;-&nbsp;1</code>
* line segments are line segments from
* <code>(xPoints[i&nbsp;-&nbsp;1],&nbsp;yPoints[i&nbsp;-&nbsp;1])</code>
* to <code>(xPoints[i],&nbsp;yPoints[i])</code>, for
* 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;<code>nPoints</code>.
* 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;{@code nPoints}.
* The figure is automatically closed by drawing a line connecting
* the final point to the first point, if those points are different.
* @param xPoints a an array of <code>x</code> coordinates.
* @param yPoints a an array of <code>y</code> coordinates.
* @param xPoints a an array of {@code x} coordinates.
* @param yPoints a an array of {@code y} coordinates.
* @param nPoints a the total number of points.
* @see java.awt.Graphics#fillPolygon
* @see java.awt.Graphics#drawPolyline
@ -723,7 +723,7 @@ public abstract class Graphics {
/**
* Draws the outline of a polygon defined by the specified
* <code>Polygon</code> object.
* {@code Polygon} object.
* @param p the polygon to draw.
* @see java.awt.Graphics#fillPolygon
* @see java.awt.Graphics#drawPolyline
@ -736,19 +736,19 @@ public abstract class Graphics {
* Fills a closed polygon defined by
* arrays of <i>x</i> and <i>y</i> coordinates.
* <p>
* This method draws the polygon defined by <code>nPoint</code> line
* This method draws the polygon defined by {@code nPoint} line
* segments, where the first <code>nPoint&nbsp;-&nbsp;1</code>
* line segments are line segments from
* <code>(xPoints[i&nbsp;-&nbsp;1],&nbsp;yPoints[i&nbsp;-&nbsp;1])</code>
* to <code>(xPoints[i],&nbsp;yPoints[i])</code>, for
* 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;<code>nPoints</code>.
* 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;{@code nPoints}.
* The figure is automatically closed by drawing a line connecting
* the final point to the first point, if those points are different.
* <p>
* The area inside the polygon is defined using an
* even-odd fill rule, also known as the alternating rule.
* @param xPoints a an array of <code>x</code> coordinates.
* @param yPoints a an array of <code>y</code> coordinates.
* @param xPoints a an array of {@code x} coordinates.
* @param yPoints a an array of {@code y} coordinates.
* @param nPoints a the total number of points.
* @see java.awt.Graphics#drawPolygon(int[], int[], int)
*/
@ -776,7 +776,7 @@ public abstract class Graphics {
* @param str the string to be drawn.
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @throws NullPointerException if <code>str</code> is <code>null</code>.
* @throws NullPointerException if {@code str} is {@code null}.
* @see java.awt.Graphics#drawBytes
* @see java.awt.Graphics#drawChars
*/
@ -792,8 +792,8 @@ public abstract class Graphics {
* @param iterator the iterator whose text is to be drawn
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @throws NullPointerException if <code>iterator</code> is
* <code>null</code>.
* @throws NullPointerException if {@code iterator} is
* {@code null}.
* @see java.awt.Graphics#drawBytes
* @see java.awt.Graphics#drawChars
*/
@ -810,11 +810,11 @@ public abstract class Graphics {
* @param length the number of characters to be drawn
* @param x the <i>x</i> coordinate of the baseline of the text
* @param y the <i>y</i> coordinate of the baseline of the text
* @throws NullPointerException if <code>data</code> is <code>null</code>.
* @throws IndexOutOfBoundsException if <code>offset</code> or
* <code>length</code>is less than zero, or
* <code>offset+length</code> is greater than the length of the
* <code>data</code> array.
* @throws NullPointerException if {@code data} is {@code null}.
* @throws IndexOutOfBoundsException if {@code offset} or
* {@code length} is less than zero, or
* {@code offset+length} is greater than the length of the
* {@code data} array.
* @see java.awt.Graphics#drawBytes
* @see java.awt.Graphics#drawString
*/
@ -836,10 +836,10 @@ public abstract class Graphics {
* @param length the number of bytes that are drawn
* @param x the <i>x</i> coordinate of the baseline of the text
* @param y the <i>y</i> coordinate of the baseline of the text
* @throws NullPointerException if <code>data</code> is <code>null</code>.
* @throws IndexOutOfBoundsException if <code>offset</code> or
* <code>length</code>is less than zero, or <code>offset+length</code>
* is greater than the length of the <code>data</code> array.
* @throws NullPointerException if {@code data} is {@code null}.
* @throws IndexOutOfBoundsException if {@code offset} or
* {@code length} is less than zero, or {@code offset+length}
* is greater than the length of the {@code data} array.
* @see java.awt.Graphics#drawChars
* @see java.awt.Graphics#drawString
*/
@ -861,21 +861,21 @@ public abstract class Graphics {
* <p>
* If the image has completely loaded and its pixels are
* no longer being changed, then
* <code>drawImage</code> returns <code>true</code>.
* Otherwise, <code>drawImage</code> returns <code>false</code>
* {@code drawImage} returns {@code true}.
* Otherwise, {@code drawImage} returns {@code false}
* and as more of
* the image becomes available
* or it is time to draw another frame of animation,
* the process that loads the image notifies
* the specified image observer.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @param observer object to be notified as more of
* the image is converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -896,9 +896,9 @@ public abstract class Graphics {
* entire image has not yet been scaled, dithered, and converted
* for the current output device.
* If the current output representation is not yet complete, then
* <code>drawImage</code> returns <code>false</code>. As more of
* {@code drawImage} returns {@code false}. As more of
* the image becomes available, the process that loads the image notifies
* the image observer by calling its <code>imageUpdate</code> method.
* the image observer by calling its {@code imageUpdate} method.
* <p>
* A scaled version of an image will not necessarily be
* available immediately just because an unscaled version of the
@ -906,15 +906,15 @@ public abstract class Graphics {
* the image may be cached separately and generated from the original
* data in a separate image production sequence.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @param width the width of the rectangle.
* @param height the height of the rectangle.
* @param observer object to be notified as more of
* the image is converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -940,23 +940,23 @@ public abstract class Graphics {
* <p>
* If the image has completely loaded and its pixels are
* no longer being changed, then
* <code>drawImage</code> returns <code>true</code>.
* Otherwise, <code>drawImage</code> returns <code>false</code>
* {@code drawImage} returns {@code true}.
* Otherwise, {@code drawImage} returns {@code false}
* and as more of
* the image becomes available
* or it is time to draw another frame of animation,
* the process that loads the image notifies
* the specified image observer.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @param bgcolor the background color to paint under the
* non-opaque portions of the image.
* @param observer object to be notified as more of
* the image is converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -981,7 +981,7 @@ public abstract class Graphics {
* entire image has not yet been scaled, dithered, and converted
* for the current output device.
* If the current output representation is not yet complete then
* <code>drawImage</code> returns <code>false</code>. As more of
* {@code drawImage} returns {@code false}. As more of
* the image becomes available, the process that loads the image notifies
* the specified image observer.
* <p>
@ -991,7 +991,7 @@ public abstract class Graphics {
* the image may be cached separately and generated from the original
* data in a separate image production sequence.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param x the <i>x</i> coordinate.
* @param y the <i>y</i> coordinate.
* @param width the width of the rectangle.
@ -1000,8 +1000,8 @@ public abstract class Graphics {
* non-opaque portions of the image.
* @param observer object to be notified as more of
* the image is converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -1021,7 +1021,7 @@ public abstract class Graphics {
* image area to be drawn has not yet been scaled, dithered, and converted
* for the current output device.
* If the current output representation is not yet complete then
* <code>drawImage</code> returns <code>false</code>. As more of
* {@code drawImage} returns {@code false}. As more of
* the image becomes available, the process that loads the image notifies
* the specified image observer.
* <p>
@ -1035,7 +1035,7 @@ public abstract class Graphics {
* mapped to the second destination coordinate. The subimage is
* scaled and flipped as needed to preserve those mappings.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param dx1 the <i>x</i> coordinate of the first corner of the
* destination rectangle.
* @param dy1 the <i>y</i> coordinate of the first corner of the
@ -1054,8 +1054,8 @@ public abstract class Graphics {
* source rectangle.
* @param observer object to be notified as more of the image is
* scaled and converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -1080,7 +1080,7 @@ public abstract class Graphics {
* image area to be drawn has not yet been scaled, dithered, and converted
* for the current output device.
* If the current output representation is not yet complete then
* <code>drawImage</code> returns <code>false</code>. As more of
* {@code drawImage} returns {@code false}. As more of
* the image becomes available, the process that loads the image notifies
* the specified image observer.
* <p>
@ -1094,7 +1094,7 @@ public abstract class Graphics {
* mapped to the second destination coordinate. The subimage is
* scaled and flipped as needed to preserve those mappings.
* @param img the specified image to be drawn. This method does
* nothing if <code>img</code> is null.
* nothing if {@code img} is null.
* @param dx1 the <i>x</i> coordinate of the first corner of the
* destination rectangle.
* @param dy1 the <i>y</i> coordinate of the first corner of the
@ -1115,8 +1115,8 @@ public abstract class Graphics {
* non-opaque portions of the image.
* @param observer object to be notified as more of the image is
* scaled and converted.
* @return <code>false</code> if the image pixels are still changing;
* <code>true</code> otherwise.
* @return {@code false} if the image pixels are still changing;
* {@code true} otherwise.
* @see java.awt.Image
* @see java.awt.image.ImageObserver
* @see java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
@ -1131,10 +1131,10 @@ public abstract class Graphics {
/**
* Disposes of this graphics context and releases
* any system resources that it is using.
* A <code>Graphics</code> object cannot be used after
* <code>dispose</code>has been called.
* A {@code Graphics} object cannot be used after
* {@code dispose} has been called.
* <p>
* When a Java program runs, a large number of <code>Graphics</code>
* When a Java program runs, a large number of {@code Graphics}
* objects can be created within a short time frame.
* Although the finalization process of the garbage collector
* also disposes of the same system resources, it is preferable
@ -1143,12 +1143,12 @@ public abstract class Graphics {
* may not run to completion for a long period of time.
* <p>
* Graphics objects which are provided as arguments to the
* <code>paint</code> and <code>update</code> methods
* {@code paint} and {@code update} methods
* of components are automatically released by the system when
* those methods return. For efficiency, programmers should
* call <code>dispose</code> when finished using
* a <code>Graphics</code> object only if it was created
* directly from a component or another <code>Graphics</code> object.
* call {@code dispose} when finished using
* a {@code Graphics} object only if it was created
* directly from a component or another {@code Graphics} object.
* @see java.awt.Graphics#finalize
* @see java.awt.Component#paint
* @see java.awt.Component#update
@ -1166,8 +1166,8 @@ public abstract class Graphics {
}
/**
* Returns a <code>String</code> object representing this
* <code>Graphics</code> object's value.
* Returns a {@code String} object representing this
* {@code Graphics} object's value.
* @return a string representation of this graphics context.
*/
public String toString() {
@ -1177,9 +1177,9 @@ public abstract class Graphics {
/**
* Returns the bounding rectangle of the current clipping area.
* @return the bounding rectangle of the current clipping area
* or <code>null</code> if no clip is set.
* or {@code null} if no clip is set.
* @deprecated As of JDK version 1.1,
* replaced by <code>getClipBounds()</code>.
* replaced by {@code getClipBounds()}.
*/
@Deprecated
public Rectangle getClipRect() {
@ -1208,8 +1208,8 @@ public abstract class Graphics {
* @param y the y coordinate of the rectangle to test against the clip
* @param width the width of the rectangle to test against the clip
* @param height the height of the rectangle to test against the clip
* @return <code>true</code> if the specified rectangle intersects
* the bounds of the current clip; <code>false</code>
* @return {@code true} if the specified rectangle intersects
* the bounds of the current clip; {@code false}
* otherwise.
*/
public boolean hitClip(int x, int y, int width, int height) {
@ -1232,8 +1232,8 @@ public abstract class Graphics {
* This method refers to the user clip, which is independent of the
* clipping associated with device bounds and window visibility.
* If no clip has previously been set, or if the clip has been
* cleared using <code>setClip(null)</code>, this method returns the
* specified <code>Rectangle</code>.
* cleared using {@code setClip(null)}, this method returns the
* specified {@code Rectangle}.
* @param r the rectangle where the current clipping area is
* copied to. Any current values in this rectangle are
* overwritten.

616
jdk/src/java.desktop/share/classes/java/awt/Graphics2D.java
View file

File diff suppressed because it is too large Load diff

34
jdk/src/java.desktop/share/classes/java/awt/GraphicsConfigTemplate.java
View file

@ -28,14 +28,14 @@ package java.awt;
import java.io.*;
/**
* The <code>GraphicsConfigTemplate</code> class is used to obtain a valid
* The {@code GraphicsConfigTemplate} class is used to obtain a valid
* {@link GraphicsConfiguration}. A user instantiates one of these
* objects and then sets all non-default attributes as desired. The
* {@link GraphicsDevice#getBestConfiguration} method found in the
* {@link GraphicsDevice} class is then called with this
* <code>GraphicsConfigTemplate</code>. A valid
* <code>GraphicsConfiguration</code> is returned that meets or exceeds
* what was requested in the <code>GraphicsConfigTemplate</code>.
* {@code GraphicsConfigTemplate}. A valid
* {@code GraphicsConfiguration} is returned that meets or exceeds
* what was requested in the {@code GraphicsConfigTemplate}.
* @see GraphicsDevice
* @see GraphicsConfiguration
*
@ -56,15 +56,15 @@ public abstract class GraphicsConfigTemplate implements Serializable {
/**
* Value used for "Enum" (Integer) type. States that this
* feature is required for the <code>GraphicsConfiguration</code>
* feature is required for the {@code GraphicsConfiguration}
* object. If this feature is not available, do not select the
* <code>GraphicsConfiguration</code> object.
* {@code GraphicsConfiguration} object.
*/
public static final int REQUIRED = 1;
/**
* Value used for "Enum" (Integer) type. States that this
* feature is desired for the <code>GraphicsConfiguration</code>
* feature is desired for the {@code GraphicsConfiguration}
* object. A selection with this feature is preferred over a
* selection that does not include this feature, although both
* selections can be considered valid matches.
@ -74,7 +74,7 @@ public abstract class GraphicsConfigTemplate implements Serializable {
/**
* Value used for "Enum" (Integer) type. States that this
* feature is not necessary for the selection of the
* <code>GraphicsConfiguration</code> object. A selection
* {@code GraphicsConfiguration} object. A selection
* without this feature is preferred over a selection that
* includes this feature since it is not used.
*/
@ -82,10 +82,10 @@ public abstract class GraphicsConfigTemplate implements Serializable {
/**
* Returns the "best" configuration possible that passes the
* criteria defined in the <code>GraphicsConfigTemplate</code>.
* @param gc the array of <code>GraphicsConfiguration</code>
* criteria defined in the {@code GraphicsConfigTemplate}.
* @param gc the array of {@code GraphicsConfiguration}
* objects to choose from.
* @return a <code>GraphicsConfiguration</code> object that is
* @return a {@code GraphicsConfiguration} object that is
* the best configuration possible.
* @see GraphicsConfiguration
*/
@ -93,15 +93,15 @@ public abstract class GraphicsConfigTemplate implements Serializable {
getBestConfiguration(GraphicsConfiguration[] gc);
/**
* Returns a <code>boolean</code> indicating whether or
* not the specified <code>GraphicsConfiguration</code> can be
* Returns a {@code boolean} indicating whether or
* not the specified {@code GraphicsConfiguration} can be
* used to create a drawing surface that supports the indicated
* features.
* @param gc the <code>GraphicsConfiguration</code> object to test
* @return <code>true</code> if this
* <code>GraphicsConfiguration</code> object can be used to create
* @param gc the {@code GraphicsConfiguration} object to test
* @return {@code true} if this
* {@code GraphicsConfiguration} object can be used to create
* surfaces that support the indicated features;
* <code>false</code> if the <code>GraphicsConfiguration</code> can
* {@code false} if the {@code GraphicsConfiguration} can
* not be used to create a drawing surface usable by this Java(tm)
* API.
*/

172
jdk/src/java.desktop/share/classes/java/awt/GraphicsConfiguration.java
View file

@ -34,23 +34,23 @@ import java.awt.image.WritableRaster;
import sun.awt.image.SunVolatileImage;
/**
* The <code>GraphicsConfiguration</code> class describes the
* The {@code GraphicsConfiguration} class describes the
* characteristics of a graphics destination such as a printer or monitor.
* There can be many <code>GraphicsConfiguration</code> objects associated
* There can be many {@code GraphicsConfiguration} objects associated
* with a single graphics device, representing different drawing modes or
* capabilities. The corresponding native structure will vary from platform
* to platform. For example, on X11 windowing systems,
* each visual is a different <code>GraphicsConfiguration</code>.
* On Microsoft Windows, <code>GraphicsConfiguration</code>s represent
* each visual is a different {@code GraphicsConfiguration}.
* On Microsoft Windows, {@code GraphicsConfiguration}s represent
* PixelFormats available in the current resolution and color depth.
* <p>
* In a virtual device multi-screen environment in which the desktop
* area could span multiple physical screen devices, the bounds of the
* <code>GraphicsConfiguration</code> objects are relative to the
* {@code GraphicsConfiguration} objects are relative to the
* virtual coordinate system. When setting the location of a
* component, use {@link #getBounds() getBounds} to get the bounds of
* the desired <code>GraphicsConfiguration</code> and offset the location
* with the coordinates of the <code>GraphicsConfiguration</code>,
* the desired {@code GraphicsConfiguration} and offset the location
* with the coordinates of the {@code GraphicsConfiguration},
* as the following code sample illustrates:
* </p>
*
@ -61,17 +61,17 @@ import sun.awt.image.SunVolatileImage;
*
* <p>
* To determine if your environment is a virtual device
* environment, call <code>getBounds</code> on all of the
* <code>GraphicsConfiguration</code> objects in your system. If
* environment, call {@code getBounds} on all of the
* {@code GraphicsConfiguration} objects in your system. If
* any of the origins of the returned bounds is not (0,&nbsp;0),
* your environment is a virtual device environment.
*
* <p>
* You can also use <code>getBounds</code> to determine the bounds
* of the virtual device. To do this, first call <code>getBounds</code> on all
* of the <code>GraphicsConfiguration</code> objects in your
* You can also use {@code getBounds} to determine the bounds
* of the virtual device. To do this, first call {@code getBounds} on all
* of the {@code GraphicsConfiguration} objects in your
* system. Then calculate the union of all of the bounds returned
* from the calls to <code>getBounds</code>. The union is the
* from the calls to {@code getBounds}. The union is the
* bounds of the virtual device. The following code sample
* calculates the bounds of the virtual device.
*
@ -125,24 +125,24 @@ public abstract class GraphicsConfiguration {
/**
* Returns the {@link GraphicsDevice} associated with this
* <code>GraphicsConfiguration</code>.
* @return a <code>GraphicsDevice</code> object that is
* associated with this <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return a {@code GraphicsDevice} object that is
* associated with this {@code GraphicsConfiguration}.
*/
public abstract GraphicsDevice getDevice();
/**
* Returns a {@link BufferedImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>. This
* compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
* a device. The returned <code>BufferedImage</code> has
* a device. The returned {@code BufferedImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
* @param width the width of the returned <code>BufferedImage</code>
* @param height the height of the returned <code>BufferedImage</code>
* @return a <code>BufferedImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned {@code BufferedImage}
* @param height the height of the returned {@code BufferedImage}
* @return a {@code BufferedImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
*/
public BufferedImage createCompatibleImage(int width, int height) {
ColorModel model = getColorModel();
@ -153,18 +153,18 @@ public abstract class GraphicsConfiguration {
}
/**
* Returns a <code>BufferedImage</code> that supports the specified
* Returns a {@code BufferedImage} that supports the specified
* transparency and has a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>. This
* compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
* a device. The returned <code>BufferedImage</code> has a layout and
* a device. The returned {@code BufferedImage} has a layout and
* color model that can be optimally blitted to a device
* with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned <code>BufferedImage</code>
* @param height the height of the returned <code>BufferedImage</code>
* with this {@code GraphicsConfiguration}.
* @param width the width of the returned {@code BufferedImage}
* @param height the height of the returned {@code BufferedImage}
* @param transparency the specified transparency mode
* @return a <code>BufferedImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>
* @return a {@code BufferedImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}
* and also supports the specified transparency.
* @throws IllegalArgumentException if the transparency is not a valid value
* @see Transparency#OPAQUE
@ -190,15 +190,15 @@ public abstract class GraphicsConfiguration {
/**
* Returns a {@link VolatileImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>.
* The returned <code>VolatileImage</code>
* compatible with this {@code GraphicsConfiguration}.
* The returned {@code VolatileImage}
* may have data that is stored optimally for the underlying graphics
* device and may therefore benefit from platform-specific rendering
* acceleration.
* @param width the width of the returned <code>VolatileImage</code>
* @param height the height of the returned <code>VolatileImage</code>
* @return a <code>VolatileImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned {@code VolatileImage}
* @param height the height of the returned {@code VolatileImage}
* @return a {@code VolatileImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
* @see Component#createVolatileImage(int, int)
* @since 1.4
*/
@ -216,16 +216,16 @@ public abstract class GraphicsConfiguration {
/**
* Returns a {@link VolatileImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>.
* The returned <code>VolatileImage</code>
* compatible with this {@code GraphicsConfiguration}.
* The returned {@code VolatileImage}
* may have data that is stored optimally for the underlying graphics
* device and may therefore benefit from platform-specific rendering
* acceleration.
* @param width the width of the returned <code>VolatileImage</code>
* @param height the height of the returned <code>VolatileImage</code>
* @param width the width of the returned {@code VolatileImage}
* @param height the height of the returned {@code VolatileImage}
* @param transparency the specified transparency mode
* @return a <code>VolatileImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @return a {@code VolatileImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
* @throws IllegalArgumentException if the transparency is not a valid value
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
@ -248,20 +248,20 @@ public abstract class GraphicsConfiguration {
/**
* Returns a {@link VolatileImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>, using
* compatible with this {@code GraphicsConfiguration}, using
* the specified image capabilities.
* If the <code>caps</code> parameter is null, it is effectively ignored
* If the {@code caps} parameter is null, it is effectively ignored
* and this method will create a VolatileImage without regard to
* <code>ImageCapabilities</code> constraints.
* {@code ImageCapabilities} constraints.
*
* The returned <code>VolatileImage</code> has
* The returned {@code VolatileImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
* @return a <code>VolatileImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @param width the width of the returned <code>VolatileImage</code>
* @param height the height of the returned <code>VolatileImage</code>
* @return a {@code VolatileImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
* @param width the width of the returned {@code VolatileImage}
* @param height the height of the returned {@code VolatileImage}
* @param caps the image capabilities
* @exception AWTException if the supplied image capabilities could not
* be met by this graphics configuration
@ -276,22 +276,22 @@ public abstract class GraphicsConfiguration {
/**
* Returns a {@link VolatileImage} with a data layout and color model
* compatible with this <code>GraphicsConfiguration</code>, using
* compatible with this {@code GraphicsConfiguration}, using
* the specified image capabilities and transparency value.
* If the <code>caps</code> parameter is null, it is effectively ignored
* If the {@code caps} parameter is null, it is effectively ignored
* and this method will create a VolatileImage without regard to
* <code>ImageCapabilities</code> constraints.
* {@code ImageCapabilities} constraints.
*
* The returned <code>VolatileImage</code> has
* The returned {@code VolatileImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
* @param width the width of the returned <code>VolatileImage</code>
* @param height the height of the returned <code>VolatileImage</code>
* @param width the width of the returned {@code VolatileImage}
* @param height the height of the returned {@code VolatileImage}
* @param caps the image capabilities
* @param transparency the specified transparency mode
* @return a <code>VolatileImage</code> whose data layout and color
* model is compatible with this <code>GraphicsConfiguration</code>.
* @return a {@code VolatileImage} whose data layout and color
* model is compatible with this {@code GraphicsConfiguration}.
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
* @see Transparency#TRANSLUCENT
@ -317,19 +317,19 @@ public abstract class GraphicsConfiguration {
/**
* Returns the {@link ColorModel} associated with this
* <code>GraphicsConfiguration</code>.
* @return a <code>ColorModel</code> object that is associated with
* this <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return a {@code ColorModel} object that is associated with
* this {@code GraphicsConfiguration}.
*/
public abstract ColorModel getColorModel();
/**
* Returns the <code>ColorModel</code> associated with this
* <code>GraphicsConfiguration</code> that supports the specified
* Returns the {@code ColorModel} associated with this
* {@code GraphicsConfiguration} that supports the specified
* transparency.
* @param transparency the specified transparency mode
* @return a <code>ColorModel</code> object that is associated with
* this <code>GraphicsConfiguration</code> and supports the
* @return a {@code ColorModel} object that is associated with
* this {@code GraphicsConfiguration} and supports the
* specified transparency or null if the transparency is not a valid
* value.
* @see Transparency#OPAQUE
@ -340,30 +340,30 @@ public abstract class GraphicsConfiguration {
/**
* Returns the default {@link AffineTransform} for this
* <code>GraphicsConfiguration</code>. This
* <code>AffineTransform</code> is typically the Identity transform
* for most normal screens. The default <code>AffineTransform</code>
* {@code GraphicsConfiguration}. This
* {@code AffineTransform} is typically the Identity transform
* for most normal screens. The default {@code AffineTransform}
* maps coordinates onto the device such that 72 user space
* coordinate units measure approximately 1 inch in device
* space. The normalizing transform can be used to make
* this mapping more exact. Coordinates in the coordinate space
* defined by the default <code>AffineTransform</code> for screen and
* defined by the default {@code AffineTransform} for screen and
* printer devices have the origin in the upper left-hand corner of
* the target region of the device, with X coordinates
* increasing to the right and Y coordinates increasing downwards.
* For image buffers not associated with a device, such as those not
* created by <code>createCompatibleImage</code>,
* this <code>AffineTransform</code> is the Identity transform.
* @return the default <code>AffineTransform</code> for this
* <code>GraphicsConfiguration</code>.
* created by {@code createCompatibleImage},
* this {@code AffineTransform} is the Identity transform.
* @return the default {@code AffineTransform} for this
* {@code GraphicsConfiguration}.
*/
public abstract AffineTransform getDefaultTransform();
/**
*
* Returns a <code>AffineTransform</code> that can be concatenated
* with the default <code>AffineTransform</code>
* of a <code>GraphicsConfiguration</code> so that 72 units in user
* Returns a {@code AffineTransform} that can be concatenated
* with the default {@code AffineTransform}
* of a {@code GraphicsConfiguration} so that 72 units in user
* space equals 1 inch in device space.
* <p>
* For a particular {@link Graphics2D}, g, one
@ -375,27 +375,27 @@ public abstract class GraphicsConfiguration {
* g.setTransform(gc.getDefaultTransform());
* g.transform(gc.getNormalizingTransform());
* </pre>
* Note that sometimes this <code>AffineTransform</code> is identity,
* Note that sometimes this {@code AffineTransform} is identity,
* such as for printers or metafile output, and that this
* <code>AffineTransform</code> is only as accurate as the information
* {@code AffineTransform} is only as accurate as the information
* supplied by the underlying system. For image buffers not
* associated with a device, such as those not created by
* <code>createCompatibleImage</code>, this
* <code>AffineTransform</code> is the Identity transform
* {@code createCompatibleImage}, this
* {@code AffineTransform} is the Identity transform
* since there is no valid distance measurement.
* @return an <code>AffineTransform</code> to concatenate to the
* default <code>AffineTransform</code> so that 72 units in user
* @return an {@code AffineTransform} to concatenate to the
* default {@code AffineTransform} so that 72 units in user
* space is mapped to 1 inch in device space.
*/
public abstract AffineTransform getNormalizingTransform();
/**
* Returns the bounds of the <code>GraphicsConfiguration</code>
* Returns the bounds of the {@code GraphicsConfiguration}
* in the device coordinates. In a multi-screen environment
* with a virtual device, the bounds can have negative X
* or Y origins.
* @return the bounds of the area covered by this
* <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @since 1.3
*/
public abstract Rectangle getBounds();
@ -408,7 +408,7 @@ public abstract class GraphicsConfiguration {
/**
* Returns the buffering capabilities of this
* <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return the buffering capabilities of this graphics
* configuration object
* @since 1.4
@ -423,7 +423,7 @@ public abstract class GraphicsConfiguration {
/**
* Returns the image capabilities of this
* <code>GraphicsConfiguration</code>.
* {@code GraphicsConfiguration}.
* @return the image capabilities of this graphics
* configuration object
* @since 1.4

94
jdk/src/java.desktop/share/classes/java/awt/GraphicsDevice.java
View file

@ -33,19 +33,19 @@ import sun.awt.AppContext;
import sun.awt.SunToolkit;
/**
* The <code>GraphicsDevice</code> class describes the graphics devices
* The {@code GraphicsDevice} class describes the graphics devices
* that might be available in a particular graphics environment. These
* include screen and printer devices. Note that there can be many screens
* and many printers in an instance of {@link GraphicsEnvironment}. Each
* graphics device has one or more {@link GraphicsConfiguration} objects
* associated with it. These objects specify the different configurations
* in which the <code>GraphicsDevice</code> can be used.
* in which the {@code GraphicsDevice} can be used.
* <p>
* In a multi-screen environment, the <code>GraphicsConfiguration</code>
* In a multi-screen environment, the {@code GraphicsConfiguration}
* objects can be used to render components on multiple screens. The
* following code sample demonstrates how to create a <code>JFrame</code>
* object for each <code>GraphicsConfiguration</code> on each screen
* device in the <code>GraphicsEnvironment</code>:
* following code sample demonstrates how to create a {@code JFrame}
* object for each {@code GraphicsConfiguration} on each screen
* device in the {@code GraphicsEnvironment}:
* <pre>{@code
* GraphicsEnvironment ge = GraphicsEnvironment.
* getLocalGraphicsEnvironment();
@ -142,8 +142,8 @@ public abstract class GraphicsDevice {
}
/**
* Returns the type of this <code>GraphicsDevice</code>.
* @return the type of this <code>GraphicsDevice</code>, which can
* Returns the type of this {@code GraphicsDevice}.
* @return the type of this {@code GraphicsDevice}, which can
* either be TYPE_RASTER_SCREEN, TYPE_PRINTER or TYPE_IMAGE_BUFFER.
* @see #TYPE_RASTER_SCREEN
* @see #TYPE_PRINTER
@ -153,52 +153,52 @@ public abstract class GraphicsDevice {
/**
* Returns the identification string associated with this
* <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
* <p>
* A particular program might use more than one
* <code>GraphicsDevice</code> in a <code>GraphicsEnvironment</code>.
* This method returns a <code>String</code> identifying a
* particular <code>GraphicsDevice</code> in the local
* <code>GraphicsEnvironment</code>. Although there is
* no public method to set this <code>String</code>, a programmer can
* use the <code>String</code> for debugging purposes. Vendors of
* {@code GraphicsDevice} in a {@code GraphicsEnvironment}.
* This method returns a {@code String} identifying a
* particular {@code GraphicsDevice} in the local
* {@code GraphicsEnvironment}. Although there is
* no public method to set this {@code String}, a programmer can
* use the {@code String} for debugging purposes. Vendors of
* the Java&trade; Runtime Environment can
* format the return value of the <code>String</code>. To determine
* how to interpret the value of the <code>String</code>, contact the
* format the return value of the {@code String}. To determine
* how to interpret the value of the {@code String}, contact the
* vendor of your Java Runtime. To find out who the vendor is, from
* your program, call the
* {@link System#getProperty(String) getProperty} method of the
* System class with "java.vendor".
* @return a <code>String</code> that is the identification
* of this <code>GraphicsDevice</code>.
* @return a {@code String} that is the identification
* of this {@code GraphicsDevice}.
*/
public abstract String getIDstring();
/**
* Returns all of the <code>GraphicsConfiguration</code>
* objects associated with this <code>GraphicsDevice</code>.
* @return an array of <code>GraphicsConfiguration</code>
* Returns all of the {@code GraphicsConfiguration}
* objects associated with this {@code GraphicsDevice}.
* @return an array of {@code GraphicsConfiguration}
* objects that are associated with this
* <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
*/
public abstract GraphicsConfiguration[] getConfigurations();
/**
* Returns the default <code>GraphicsConfiguration</code>
* associated with this <code>GraphicsDevice</code>.
* @return the default <code>GraphicsConfiguration</code>
* of this <code>GraphicsDevice</code>.
* Returns the default {@code GraphicsConfiguration}
* associated with this {@code GraphicsDevice}.
* @return the default {@code GraphicsConfiguration}
* of this {@code GraphicsDevice}.
*/
public abstract GraphicsConfiguration getDefaultConfiguration();
/**
* Returns the "best" configuration possible that passes the
* criteria defined in the {@link GraphicsConfigTemplate}.
* @param gct the <code>GraphicsConfigTemplate</code> object
* used to obtain a valid <code>GraphicsConfiguration</code>
* @return a <code>GraphicsConfiguration</code> that passes
* @param gct the {@code GraphicsConfigTemplate} object
* used to obtain a valid {@code GraphicsConfiguration}
* @return a {@code GraphicsConfiguration} that passes
* the criteria defined in the specified
* <code>GraphicsConfigTemplate</code>.
* {@code GraphicsConfigTemplate}.
* @see GraphicsConfigTemplate
*/
public GraphicsConfiguration
@ -208,12 +208,12 @@ public abstract class GraphicsDevice {
}
/**
* Returns <code>true</code> if this <code>GraphicsDevice</code>
* Returns {@code true} if this {@code GraphicsDevice}
* supports full-screen exclusive mode.
* If a SecurityManager is installed, its
* <code>checkPermission</code> method will be called
* with <code>AWTPermission("fullScreenExclusive")</code>.
* <code>isFullScreenSupported</code> returns true only if
* {@code checkPermission} method will be called
* with {@code AWTPermission("fullScreenExclusive")}.
* {@code isFullScreenSupported} returns true only if
* that permission is granted.
* @return whether full-screen exclusive mode is available for
* this graphics device
@ -227,8 +227,8 @@ public abstract class GraphicsDevice {
/**
* Enter full-screen mode, or return to windowed mode. The entered
* full-screen mode may be either exclusive or simulated. Exclusive
* mode is only available if <code>isFullScreenSupported</code>
* returns <code>true</code>.
* mode is only available if {@code isFullScreenSupported}
* returns {@code true}.
* <p>
* Exclusive mode implies:
* <ul>
@ -239,7 +239,7 @@ public abstract class GraphicsDevice {
* will cause the existing full-screen window to
* return to windowed mode.
* <li>Input method windows are disabled. It is advisable to call
* <code>Component.enableInputMethods(false)</code> to make a component
* {@code Component.enableInputMethods(false)} to make a component
* a non-client of the input method framework.
* </ul>
* <p>
@ -341,10 +341,10 @@ public abstract class GraphicsDevice {
}
/**
* Returns the <code>Window</code> object representing the
* Returns the {@code Window} object representing the
* full-screen window if the device is in full-screen mode.
*
* @return the full-screen window, or <code>null</code> if the device is
* @return the full-screen window, or {@code null} if the device is
* not in full-screen mode.
* @see #setFullScreenWindow(Window)
* @since 1.4
@ -362,7 +362,7 @@ public abstract class GraphicsDevice {
}
/**
* Returns <code>true</code> if this <code>GraphicsDevice</code>
* Returns {@code true} if this {@code GraphicsDevice}
* supports low-level display changes.
* On some platforms low-level display changes may only be allowed in
* full-screen exclusive mode (i.e., if {@link #isFullScreenSupported()}
@ -420,11 +420,11 @@ public abstract class GraphicsDevice {
* </code></pre>
*
* @param dm The new display mode of this graphics device.
* @exception IllegalArgumentException if the <code>DisplayMode</code>
* supplied is <code>null</code>, or is not available in the array returned
* by <code>getDisplayModes</code>
* @exception IllegalArgumentException if the {@code DisplayMode}
* supplied is {@code null}, or is not available in the array returned
* by {@code getDisplayModes}
* @exception UnsupportedOperationException if
* <code>isDisplayChangeSupported</code> returns <code>false</code>
* {@code isDisplayChangeSupported} returns {@code false}
* @see #getDisplayMode
* @see #getDisplayModes
* @see #isDisplayChangeSupported
@ -436,7 +436,7 @@ public abstract class GraphicsDevice {
/**
* Returns the current display mode of this
* <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
* The returned display mode is allowed to have a refresh rate
* {@link DisplayMode#REFRESH_RATE_UNKNOWN} if it is indeterminate.
* Likewise, the returned display mode is allowed to have a bit depth
@ -455,7 +455,7 @@ public abstract class GraphicsDevice {
/**
* Returns all display modes available for this
* <code>GraphicsDevice</code>.
* {@code GraphicsDevice}.
* The returned display modes are allowed to have a refresh rate
* {@link DisplayMode#REFRESH_RATE_UNKNOWN} if it is indeterminate.
* Likewise, the returned display modes are allowed to have a bit depth

96
jdk/src/java.desktop/share/classes/java/awt/GraphicsEnvironment.java
View file

@ -39,16 +39,16 @@ import sun.security.action.GetPropertyAction;
/**
*
* The <code>GraphicsEnvironment</code> class describes the collection
* The {@code GraphicsEnvironment} class describes the collection
* of {@link GraphicsDevice} objects and {@link java.awt.Font} objects
* available to a Java(tm) application on a particular platform.
* The resources in this <code>GraphicsEnvironment</code> might be local
* or on a remote machine. <code>GraphicsDevice</code> objects can be
* The resources in this {@code GraphicsEnvironment} might be local
* or on a remote machine. {@code GraphicsDevice} objects can be
* screens, printers or image buffers and are the destination of
* {@link Graphics2D} drawing methods. Each <code>GraphicsDevice</code>
* {@link Graphics2D} drawing methods. Each {@code GraphicsDevice}
* has a number of {@link GraphicsConfiguration} objects associated with
* it. These objects specify the different configurations in which the
* <code>GraphicsDevice</code> can be used.
* {@code GraphicsDevice} can be used.
* @see GraphicsDevice
* @see GraphicsConfiguration
*/
@ -74,8 +74,8 @@ public abstract class GraphicsEnvironment {
}
/**
* Returns the local <code>GraphicsEnvironment</code>.
* @return the local <code>GraphicsEnvironment</code>
* Returns the local {@code GraphicsEnvironment}.
* @return the local {@code GraphicsEnvironment}
*/
public static synchronized GraphicsEnvironment getLocalGraphicsEnvironment() {
if (localEnv == null) {
@ -132,8 +132,8 @@ public abstract class GraphicsEnvironment {
* a HeadlessException is thrown from areas of the Toolkit
* and GraphicsEnvironment that are dependent on a display,
* keyboard, or mouse.
* @return <code>true</code> if this environment cannot support
* a display, keyboard, and mouse; <code>false</code>
* @return {@code true} if this environment cannot support
* a display, keyboard, and mouse; {@code false}
* otherwise
* @see java.awt.HeadlessException
* @since 1.4
@ -209,11 +209,11 @@ public abstract class GraphicsEnvironment {
/**
* Returns whether or not a display, keyboard, and mouse can be
* supported in this graphics environment. If this returns true,
* <code>HeadlessException</code> will be thrown from areas of the
* {@code HeadlessException} will be thrown from areas of the
* graphics environment that are dependent on a display, keyboard, or
* mouse.
* @return <code>true</code> if a display, keyboard, and mouse
* can be supported in this environment; <code>false</code>
* @return {@code true} if a display, keyboard, and mouse
* can be supported in this environment; {@code false}
* otherwise
* @see java.awt.HeadlessException
* @see #isHeadless
@ -226,9 +226,9 @@ public abstract class GraphicsEnvironment {
}
/**
* Returns an array of all of the screen <code>GraphicsDevice</code>
* Returns an array of all of the screen {@code GraphicsDevice}
* objects.
* @return an array containing all the <code>GraphicsDevice</code>
* @return an array containing all the {@code GraphicsDevice}
* objects that represent screen devices
* @exception HeadlessException if isHeadless() returns true
* @see #isHeadless()
@ -237,8 +237,8 @@ public abstract class GraphicsEnvironment {
throws HeadlessException;
/**
* Returns the default screen <code>GraphicsDevice</code>.
* @return the <code>GraphicsDevice</code> that represents the
* Returns the default screen {@code GraphicsDevice}.
* @return the {@code GraphicsDevice} that represents the
* default screen device
* @exception HeadlessException if isHeadless() returns true
* @see #isHeadless()
@ -247,35 +247,35 @@ public abstract class GraphicsEnvironment {
throws HeadlessException;
/**
* Returns a <code>Graphics2D</code> object for rendering into the
* Returns a {@code Graphics2D} object for rendering into the
* specified {@link BufferedImage}.
* @param img the specified <code>BufferedImage</code>
* @return a <code>Graphics2D</code> to be used for rendering into
* the specified <code>BufferedImage</code>
* @throws NullPointerException if <code>img</code> is null
* @param img the specified {@code BufferedImage}
* @return a {@code Graphics2D} to be used for rendering into
* the specified {@code BufferedImage}
* @throws NullPointerException if {@code img} is null
*/
public abstract Graphics2D createGraphics(BufferedImage img);
/**
* Returns an array containing a one-point size instance of all fonts
* available in this <code>GraphicsEnvironment</code>. Typical usage
* available in this {@code GraphicsEnvironment}. Typical usage
* would be to allow a user to select a particular font. Then, the
* application can size the font and set various font attributes by
* calling the <code>deriveFont</code> method on the chosen instance.
* calling the {@code deriveFont} method on the chosen instance.
* <p>
* This method provides for the application the most precise control
* over which <code>Font</code> instance is used to render text.
* If a font in this <code>GraphicsEnvironment</code> has multiple
* over which {@code Font} instance is used to render text.
* If a font in this {@code GraphicsEnvironment} has multiple
* programmable variations, only one
* instance of that <code>Font</code> is returned in the array, and
* instance of that {@code Font} is returned in the array, and
* other variations must be derived by the application.
* <p>
* If a font in this environment has multiple programmable variations,
* such as Multiple-Master fonts, only one instance of that font is
* returned in the <code>Font</code> array. The other variations
* returned in the {@code Font} array. The other variations
* must be derived by the application.
*
* @return an array of <code>Font</code> objects
* @return an array of {@code Font} objects
* @see #getAvailableFontFamilyNames
* @see java.awt.Font
* @see java.awt.Font#deriveFont
@ -286,8 +286,8 @@ public abstract class GraphicsEnvironment {
/**
* Returns an array containing the names of all font families in this
* <code>GraphicsEnvironment</code> localized for the default locale,
* as returned by <code>Locale.getDefault()</code>.
* {@code GraphicsEnvironment} localized for the default locale,
* as returned by {@code Locale.getDefault()}.
* <p>
* Typical usage would be for presentation to a user for selection of
* a particular family name. An application can then specify this name
@ -295,7 +295,7 @@ public abstract class GraphicsEnvironment {
* italic, giving the font system flexibility in choosing its own best
* match among multiple fonts in the same font family.
*
* @return an array of <code>String</code> containing font family names
* @return an array of {@code String} containing font family names
* localized for the default locale, or a suitable alternative
* name if no name exists for this locale.
* @see #getAllFonts
@ -307,7 +307,7 @@ public abstract class GraphicsEnvironment {
/**
* Returns an array containing the names of all font families in this
* <code>GraphicsEnvironment</code> localized for the specified locale.
* {@code GraphicsEnvironment} localized for the specified locale.
* <p>
* Typical usage would be for presentation to a user for selection of
* a particular family name. An application can then specify this name
@ -317,10 +317,10 @@ public abstract class GraphicsEnvironment {
*
* @param l a {@link Locale} object that represents a
* particular geographical, political, or cultural region.
* Specifying <code>null</code> is equivalent to
* specifying <code>Locale.getDefault()</code>.
* @return an array of <code>String</code> containing font family names
* localized for the specified <code>Locale</code>, or a
* Specifying {@code null} is equivalent to
* specifying {@code Locale.getDefault()}.
* @return an array of {@code String} containing font family names
* localized for the specified {@code Locale}, or a
* suitable alternative name if no name exists for the specified locale.
* @see #getAllFonts
* @see java.awt.Font
@ -330,24 +330,24 @@ public abstract class GraphicsEnvironment {
public abstract String[] getAvailableFontFamilyNames(Locale l);
/**
* Registers a <i>created</i> <code>Font</code>in this
* <code>GraphicsEnvironment</code>.
* Registers a <i>created</i> {@code Font} in this
* {@code GraphicsEnvironment}.
* A created font is one that was returned from calling
* {@link Font#createFont}, or derived from a created font by
* calling {@link Font#deriveFont}.
* After calling this method for such a font, it is available to
* be used in constructing new <code>Font</code>s by name or family name,
* be used in constructing new {@code Font}s by name or family name,
* and is enumerated by {@link #getAvailableFontFamilyNames} and
* {@link #getAllFonts} within the execution context of this
* application or applet. This means applets cannot register fonts in
* a way that they are visible to other applets.
* <p>
* Reasons that this method might not register the font and therefore
* return <code>false</code> are:
* return {@code false} are:
* <ul>
* <li>The font is not a <i>created</i> <code>Font</code>.
* <li>The font conflicts with a non-created <code>Font</code> already
* in this <code>GraphicsEnvironment</code>. For example if the name
* <li>The font is not a <i>created</i> {@code Font}.
* <li>The font conflicts with a non-created {@code Font} already
* in this {@code GraphicsEnvironment}. For example if the name
* is that of a system font, or a logical font as described in the
* documentation of the {@link Font} class. It is implementation dependent
* whether a font may also conflict if it has the same family name
@ -357,9 +357,9 @@ public abstract class GraphicsEnvironment {
* </ul>
*
* @param font the font to be registered
* @return true if the <code>font</code> is successfully
* registered in this <code>GraphicsEnvironment</code>.
* @throws NullPointerException if <code>font</code> is null
* @return true if the {@code font} is successfully
* registered in this {@code GraphicsEnvironment}.
* @throws NullPointerException if {@code font} is null
* @since 1.6
*/
public boolean registerFont(Font font) {
@ -444,8 +444,8 @@ public abstract class GraphicsEnvironment {
* entire display area.
* <p>
* To get the usable bounds of a single display, use
* <code>GraphicsConfiguration.getBounds()</code> and
* <code>Toolkit.getScreenInsets()</code>.
* {@code GraphicsConfiguration.getBounds()} and
* {@code Toolkit.getScreenInsets()}.
* @return the maximum bounds for centered Windows
*
* @exception HeadlessException if isHeadless() returns true

Some files were not shown because too many files have changed in this diff Show more