---

java.awt
Class Toolkit

java.lang.Object
 |
 +--java.awt.Toolkit

---

public abstract class Toolkit

extends Object

Unsafe: This class is the abstract superclass of all actual implementations of the Abstract Window Toolkit. Subclasses of Toolkit are used to bind the various components to particular native toolkit implementations.

Most applications should not call any of the methods in this class directly. The methods defined by Toolkit are the "glue" that joins the platform-independent classes in the java.awt package with their counterparts in java.awt.peer. Some methods defined by Toolkit query the native operating system directly.

Since:

JDK1.0

Version:

1.184, 04/02/02

Author:

Sami Shaio, Arthur van Hoff, Fred Ecks

---

lightweightMarker

private static java.awt.peer.LightweightPeer lightweightMarker

---

toolkit

private static Toolkit toolkit

The default toolkit.

---

resources

private static ResourceBundle resources

Support for I18N: any visible strings should be stored in sun.awt.resources.awt.properties. The ResourceBundle is stored here, so that only one copy is maintained.

---

loaded

private static boolean loaded

WARNING: This is a temporary workaround for a problem in the way the AWT loads native libraries. A number of classes in the AWT package have a native method, initIDs(), which initializes the JNI field and method ids used in the native portion of their implementation. Since the use and storage of these ids is done by the implementation libraries, the implementation of these method is provided by the particular AWT implementations (for example, "Toolkit"s/Peer), such as Motif, Microsoft Windows, or Tiny. The problem is that this means that the native libraries must be loaded by the java.* classes, which do not necessarily know the names of the libraries to load. A better way of doing this would be to provide a separate library which defines java.awt.* initIDs, and exports the relevant symbols out to the implementation libraries. For now, we know it's done by the implementation, and we assume that the name of the library is "awt". -br. If you change loadLibraries(), please add the change to java.awt.image.ColorModel.loadLibraries(). Unfortunately, classes can be loaded in java.awt.image that depend on libawt and there is no way to call Toolkit.loadLibraries() directly. -hung

---

desktopProperties

protected final Map desktopProperties

---

desktopPropsSupport

protected final java.beans.PropertyChangeSupport desktopPropsSupport

---

dbg

private static final sun.awt.DebugHelper dbg

---

LONG_BITS

private static final int LONG_BITS

---

calls

private int[] calls

---

eventListener

private AWTEventListener eventListener

---

listener2SelectiveListener

private WeakHashMap listener2SelectiveListener

---

listenToAllAWTEventsPermission

private AWTPermission listenToAllAWTEventsPermission

Toolkit

public Toolkit()

Suppressed:

createButton

protected abstract java.awt.peer.ButtonPeer createButton(Button target)
 throws HeadlessException

Creates this toolkit's implementation of Button using the specified peer interface.

Parameters:

target - the button to be implemented.

Returns:

this toolkit's implementation of Button.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Button, java.awt.peer.ButtonPeer

---

createTextField

protected abstract java.awt.peer.TextFieldPeer createTextField(TextField target)
 throws HeadlessException

Creates this toolkit's implementation of TextField using the specified peer interface.

Parameters:

target - the text field to be implemented.

Returns:

this toolkit's implementation of TextField.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.TextField, java.awt.peer.TextFieldPeer

---

createLabel

protected abstract java.awt.peer.LabelPeer createLabel(Label target)
 throws HeadlessException

Creates this toolkit's implementation of Label using the specified peer interface.

Parameters:

target - the label to be implemented.

Returns:

this toolkit's implementation of Label.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Label, java.awt.peer.LabelPeer

---

createList

protected abstract java.awt.peer.ListPeer createList(List target)
 throws HeadlessException

Creates this toolkit's implementation of List using the specified peer interface.

Parameters:

target - the list to be implemented.

Returns:

this toolkit's implementation of List.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.List, java.awt.peer.ListPeer

---

createCheckbox

protected abstract java.awt.peer.CheckboxPeer createCheckbox(Checkbox target)
 throws HeadlessException

Creates this toolkit's implementation of Checkbox using the specified peer interface.

Parameters:

target - the check box to be implemented.

Returns:

this toolkit's implementation of Checkbox.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Checkbox, java.awt.peer.CheckboxPeer

---

createScrollbar

protected abstract java.awt.peer.ScrollbarPeer createScrollbar(Scrollbar target)
 throws HeadlessException

Creates this toolkit's implementation of Scrollbar using the specified peer interface.

Parameters:

target - the scroll bar to be implemented.

Returns:

this toolkit's implementation of Scrollbar.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Scrollbar, java.awt.peer.ScrollbarPeer

---

createScrollPane

protected abstract java.awt.peer.ScrollPanePeer createScrollPane(ScrollPane target)
 throws HeadlessException

Creates this toolkit's implementation of ScrollPane using the specified peer interface.

Parameters:

target - the scroll pane to be implemented.

Returns:

this toolkit's implementation of ScrollPane.

HeadlessException

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.ScrollPane, java.awt.peer.ScrollPanePeer

---

createTextArea

protected abstract java.awt.peer.TextAreaPeer createTextArea(TextArea target)
 throws HeadlessException

Creates this toolkit's implementation of TextArea using the specified peer interface.

Parameters:

target - the text area to be implemented.

Returns:

this toolkit's implementation of TextArea.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.TextArea, java.awt.peer.TextAreaPeer

---

createChoice

protected abstract java.awt.peer.ChoicePeer createChoice(Choice target)
 throws HeadlessException

Creates this toolkit's implementation of Choice using the specified peer interface.

Parameters:

target - the choice to be implemented.

Returns:

this toolkit's implementation of Choice.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Choice, java.awt.peer.ChoicePeer

---

createFrame

protected abstract java.awt.peer.FramePeer createFrame(Frame target)
 throws HeadlessException

Creates this toolkit's implementation of Frame using the specified peer interface.

Parameters:

target - the frame to be implemented.

Returns:

this toolkit's implementation of Frame.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Frame, java.awt.peer.FramePeer

---

createCanvas

protected abstract java.awt.peer.CanvasPeer createCanvas(Canvas target)

Creates this toolkit's implementation of Canvas using the specified peer interface.

Parameters:

target - the canvas to be implemented.

Returns:

this toolkit's implementation of Canvas.

See Also:

java.awt.Canvas, java.awt.peer.CanvasPeer

---

createPanel

protected abstract java.awt.peer.PanelPeer createPanel(Panel target)

Creates this toolkit's implementation of Panel using the specified peer interface.

Parameters:

target - the panel to be implemented.

Returns:

this toolkit's implementation of Panel.

See Also:

java.awt.Panel, java.awt.peer.PanelPeer

---

createWindow

protected abstract java.awt.peer.WindowPeer createWindow(Window target)
 throws HeadlessException

Creates this toolkit's implementation of Window using the specified peer interface.

Parameters:

target - the window to be implemented.

Returns:

this toolkit's implementation of Window.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Window, java.awt.peer.WindowPeer

---

createDialog

protected abstract java.awt.peer.DialogPeer createDialog(Dialog target)
 throws HeadlessException

Creates this toolkit's implementation of Dialog using the specified peer interface.

Parameters:

target - the dialog to be implemented.

Returns:

this toolkit's implementation of Dialog.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Dialog, java.awt.peer.DialogPeer

---

createMenuBar

protected abstract java.awt.peer.MenuBarPeer createMenuBar(MenuBar target)
 throws HeadlessException

Creates this toolkit's implementation of MenuBar using the specified peer interface.

Parameters:

target - the menu bar to be implemented.

Returns:

this toolkit's implementation of MenuBar.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.MenuBar, java.awt.peer.MenuBarPeer

---

createMenu

protected abstract java.awt.peer.MenuPeer createMenu(Menu target)
 throws HeadlessException

Creates this toolkit's implementation of Menu using the specified peer interface.

Parameters:

target - the menu to be implemented.

Returns:

this toolkit's implementation of Menu.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.Menu, java.awt.peer.MenuPeer

---

createPopupMenu

protected abstract java.awt.peer.PopupMenuPeer createPopupMenu(PopupMenu target)
 throws HeadlessException

Creates this toolkit's implementation of PopupMenu using the specified peer interface.

Parameters:

target - the popup menu to be implemented.

Returns:

this toolkit's implementation of PopupMenu.

HeadlessException

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.PopupMenu, java.awt.peer.PopupMenuPeer

---

createMenuItem

protected abstract java.awt.peer.MenuItemPeer createMenuItem(MenuItem target)
 throws HeadlessException

Creates this toolkit's implementation of MenuItem using the specified peer interface.

Parameters:

target - the menu item to be implemented.

Returns:

this toolkit's implementation of MenuItem.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.MenuItem, java.awt.peer.MenuItemPeer

---

createFileDialog

protected abstract java.awt.peer.FileDialogPeer createFileDialog(FileDialog target)
 throws HeadlessException

Creates this toolkit's implementation of FileDialog using the specified peer interface.

Parameters:

target - the file dialog to be implemented.

Returns:

this toolkit's implementation of FileDialog.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.FileDialog, java.awt.peer.FileDialogPeer

---

createCheckboxMenuItem

protected abstract java.awt.peer.CheckboxMenuItemPeer createCheckboxMenuItem(CheckboxMenuItem target)
 throws HeadlessException

Creates this toolkit's implementation of CheckboxMenuItem using the specified peer interface.

Parameters:

target - the checkbox menu item to be implemented.

Returns:

this toolkit's implementation of CheckboxMenuItem.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.CheckboxMenuItem, java.awt.peer.CheckboxMenuItemPeer

---

createComponent

protected java.awt.peer.LightweightPeer createComponent(Component target)

Creates a peer for a component or container. This peer is windowless and allows the Component and Container classes to be extended directly to create windowless components that are defined entirely in java.

Parameters:

target - The Component to be created.

---

getFontPeer

protected abstract java.awt.peer.FontPeer getFontPeer(String name,
 int style)

Deprecated. see java.awt.GraphicsEnvironment#getAllFonts

Creates this toolkit's implementation of Font using the specified peer interface.

Parameters:

name - the font to be implemented

style - the style of the font, such as PLAIN, BOLD, ITALIC, or a combination

Returns:

this toolkit's implementation of Font

See Also:

java.awt.Font, java.awt.peer.FontPeer, java.awt.GraphicsEnvironment#getAllFonts

---

loadSystemColors

protected void loadSystemColors(int[] systemColors)
 throws HeadlessException

Fills in the integer array that is supplied as an argument with the current system color values.

HeadlessException

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

setDynamicLayout

public void setDynamicLayout(boolean dynamic)
 throws HeadlessException

Enabled: Controls whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete. Note that this feature is not supported on all platforms, and conversely, that this feature cannot be turned off on some platforms. On platforms where dynamic layout during resize is not supported (or is always supported), setting this property has no effect. Note that this feature can be set or unset as a property of the operating system or window manager on some platforms. On such platforms, the dynamic resize property must be set at the operating system or window manager level before this method can take effect. This method does not change the underlying operating system or window manager support or settings. The OS/WM support can be queried using getDesktopProperty("awt.dynamicLayoutSupported").

Parameters:

dynamic - If true, Containers should re-layout their components as the Container is being resized. If false, the layout will be validated after resizing is finished.

HeadlessException

Since:

1.4

See Also:

isDynamicLayoutSet(), isDynamicLayoutActive(), getDesktopProperty(String propertyName), java.awt.GraphicsEnvironment#isHeadless

---

isDynamicLayoutSet

protected boolean isDynamicLayoutSet()
 throws HeadlessException

Returns whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete. Note: this method returns the value that was set programmatically; it does not reflect support at the level of the operating system or window manager for dynamic layout on resizing, or the current operating system or window manager settings. The OS/WM support can be queried using getDesktopProperty("awt.dynamicLayoutSupported").

Returns:

true if validation of Containers is done dynamically, false if validation is done after resizing is finished.

HeadlessException

Since:

1.4

See Also:

setDynamicLayout(boolean dynamic), isDynamicLayoutActive(), getDesktopProperty(String propertyName), java.awt.GraphicsEnvironment#isHeadless

---

isDynamicLayoutActive

public boolean isDynamicLayoutActive()
 throws HeadlessException

Enabled: Returns whether dynamic layout of Containers on resize is currently active (both set programmatically, and supported by the underlying operating system and/or window manager). The OS/WM support can be queried using getDesktopProperty("awt.dynamicLayoutSupported").

Returns:

true if dynamic layout of Containers on resize is currently active, false otherwise.

HeadlessException

Since:

1.4

See Also:

setDynamicLayout(boolean dynamic), isDynamicLayoutSet(), getDesktopProperty(String propertyName), java.awt.GraphicsEnvironment#isHeadless

---

getScreenSize

public abstract Dimension getScreenSize()
 throws HeadlessException

Enabled: Gets the size of the screen. On systems with multiple displays, the primary display is used. Multi-screen aware display dimensions are available from GraphicsConfiguration and GraphicsDevice.

Returns:

the size of this toolkit's screen, in pixels.

HeadlessException

See Also:

java.awt.GraphicsConfiguration#getBounds, java.awt.GraphicsDevice#getDisplayMode, java.awt.GraphicsEnvironment#isHeadless

---

getScreenResolution

public abstract int getScreenResolution()
 throws HeadlessException

Enabled: Returns the screen resolution in dots-per-inch.

Returns:

this toolkit's screen resolution, in dots-per-inch.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getScreenInsets

public Insets getScreenInsets(GraphicsConfiguration gc)
 throws HeadlessException

Enabled: Gets the insets of the screen.

Returns:

the insets of this toolkit's screen, in pixels.

HeadlessException

Since:

1.4

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getColorModel

public abstract java.awt.image.ColorModel getColorModel()
 throws HeadlessException

Enabled: Determines the color model of this toolkit's screen.

ColorModel is an abstract class that encapsulates the ability to translate between the pixel values of an image and its red, green, blue, and alpha components.

This toolkit method is called by the getColorModel method of the Component class.

Returns:

the color model of this toolkit's screen.

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.image.ColorModel, java.awt.Component#getColorModel

---

getFontList

public abstract String[] getFontList()

Deprecated. see java.awt.GraphicsEnvironment#getAvailableFontFamilyNames()

Enabled: Returns the names of the available fonts in this toolkit.

For 1.1, the following font names are deprecated (the replacement name follows):

• TimesRoman (use Serif)
• Helvetica (use SansSerif)
• Courier (use Monospaced)

The ZapfDingbats fontname is also deprecated in 1.1 but the characters are defined in Unicode starting at 0x2700, and as of 1.1 Java supports those characters.

Returns:

the names of the available fonts in this toolkit.

See Also:

java.awt.GraphicsEnvironment#getAvailableFontFamilyNames()

---

getFontMetrics

public abstract FontMetrics getFontMetrics(Font font)

Deprecated. As of JDK version 1.2, replaced by the Font method getLineMetrics.

Enabled: Gets the screen device metrics for rendering of the font.

Parameters:

font - a font

Returns:

the screen metrics of the specified font in this toolkit

See Also:

java.awt.font.LineMetrics, java.awt.Font#getLineMetrics, java.awt.GraphicsEnvironment#getScreenDevices

---

sync

public abstract void sync()

Enabled: Synchronizes this toolkit's graphics state. Some window systems may do buffering of graphics events.

This method ensures that the display is up-to-date. It is useful for animation.

---

loadAssistiveTechnologies

private static void loadAssistiveTechnologies()

Loads additional classes into the VM, using the property 'assistive_technologies' specified in the Sun reference implementation by a line in the 'accessibility.properties' file. The form is "assistive_technologies=..." where the "..." is a comma-separated list of assistive technology classes to load. Each class is loaded in the order given and a single instance of each is created using Class.forName(class).newInstance(). All errors are handled via an AWTError exception.

The assumption is made that assistive technology classes are supplied as part of INSTALLED (as opposed to: BUNDLED) extensions or specified on the class path (and therefore can be loaded using the class loader returned by a call to ClassLoader.getSystemClassLoader, whose delegation parent is the extension class loader for installed extensions).

---

getDefaultToolkit

public static Toolkit getDefaultToolkit()

Enabled: Gets the default toolkit.

If there is a system property named "awt.toolkit", that property is treated as the name of a class that is a subclass of Toolkit.

If the system property does not exist, then the default toolkit used is the class named "sun.awt.motif.MToolkit", which is a motif implementation of the Abstract Window Toolkit.

Also loads additional classes into the VM, using the property 'assistive_technologies' specified in the Sun reference implementation by a line in the 'accessibility.properties' file. The form is "assistive_technologies=..." where the "..." is a comma-separated list of assistive technology classes to load. Each class is loaded in the order given and a single instance of each is created using Class.forName(class).newInstance(). This is done just after the AWT toolkit is created. All errors are handled via an AWTError exception.

Returns:

the default toolkit.

---

getImage

public abstract Image getImage(String filename)

Suppressed: Returns an image which gets pixel data from the specified file, whose format can be either GIF, JPEG or PNG. The underlying toolkit attempts to resolve multiple requests with the same filename to the same returned Image. Since the mechanism required to facilitate this sharing of Image objects may continue to hold onto images that are no longer of use for an indefinite period of time, developers are encouraged to implement their own caching of images by using the createImage variant wherever available.

Parameters:

filename - the name of a file containing pixel data in a recognized file format.

Returns:

an image which gets its pixel data from the specified file.

See Also:

createImage(java.lang.String)

---

getImage

public abstract Image getImage(URL url)

Enabled: Returns an image which gets pixel data from the specified URL. The pixel data referenced by the specified URL must be in one of the following formats: GIF, JPEG or PNG. The underlying toolkit attempts to resolve multiple requests with the same URL to the same returned Image. Since the mechanism required to facilitate this sharing of Image objects may continue to hold onto images that are no longer of use for an indefinite period of time, developers are encouraged to implement their own caching of images by using the createImage variant wherever available.

Parameters:

url - the URL to use in fetching the pixel data.

Returns:

an image which gets its pixel data from the specified URL.

See Also:

createImage(java.net.URL)

---

createImage

public abstract Image createImage(String filename)

Suppressed: Returns an image which gets pixel data from the specified file. The returned Image is a new object which will not be shared with any other caller of this method or its getImage variant.

Parameters:

filename - the name of a file containing pixel data in a recognized file format.

Returns:

an image which gets its pixel data from the specified file.

See Also:

getImage(java.lang.String)

---

createImage

public abstract Image createImage(URL url)

Enabled: Returns an image which gets pixel data from the specified URL. The returned Image is a new object which will not be shared with any other caller of this method or its getImage variant.

Parameters:

url - the URL to use in fetching the pixel data.

Returns:

an image which gets its pixel data from the specified URL.

See Also:

getImage(java.net.URL)

---

prepareImage

public abstract boolean prepareImage(Image image,
 int width,
 int height,
 java.awt.image.ImageObserver observer)

Enabled: Prepares an image for rendering.

If the values of the width and height arguments are both -1, this method prepares the image for rendering on the default screen; otherwise, this method prepares an image for rendering on the default screen at the specified width and height.

The image data is downloaded asynchronously in another thread, and an appropriately scaled screen representation of the image is generated.

This method is called by components prepareImage methods.

Information on the flags returned by this method can be found with the definition of the ImageObserver interface.

Parameters:

image - the image for which to prepare a screen representation.

width - the width of the desired screen representation, or -1.

height - the height of the desired screen representation, or -1.

observer - the ImageObserver object to be notified as the image is being prepared.

Returns:

true if the image has already been fully prepared; false otherwise.

See Also:

java.awt.Component#prepareImage(java.awt.Image, java.awt.image.ImageObserver), java.awt.Component#prepareImage(java.awt.Image, int, int, java.awt.image.ImageObserver), java.awt.image.ImageObserver

---

checkImage

public abstract int checkImage(Image image,
 int width,
 int height,
 java.awt.image.ImageObserver observer)

Enabled: Indicates the construction status of a specified image that is being prepared for display.

If the values of the width and height arguments are both -1, this method returns the construction status of a screen representation of the specified image in this toolkit. Otherwise, this method returns the construction status of a scaled representation of the image at the specified width and height.

This method does not cause the image to begin loading. An application must call prepareImage to force the loading of an image.

This method is called by the component's checkImage methods.

Information on the flags returned by this method can be found with the definition of the ImageObserver interface.

Parameters:

image - the image whose status is being checked.

width - the width of the scaled version whose status is being checked, or -1.

height - the height of the scaled version whose status is being checked, or -1.

observer - the ImageObserver object to be notified as the image is being prepared.

Returns:

the bitwise inclusive OR of the ImageObserver flags for the image data that is currently available.

See Also:

java.awt.Toolkit#prepareImage(java.awt.Image, int, int, java.awt.image.ImageObserver), java.awt.Component#checkImage(java.awt.Image, java.awt.image.ImageObserver), java.awt.Component#checkImage(java.awt.Image, int, int, java.awt.image.ImageObserver), java.awt.image.ImageObserver

---

createImage

public abstract Image createImage(java.awt.image.ImageProducer producer)

Enabled: Creates an image with the specified image producer.

Parameters:

producer - the image producer to be used.

Returns:

an image with the specified image producer.

See Also:

java.awt.Image, java.awt.image.ImageProducer, java.awt.Component#createImage(java.awt.image.ImageProducer)

---

createImage

public Image createImage(byte[] imagedata)

Enabled: Creates an image which decodes the image stored in the specified byte array.

The data must be in some image format, such as GIF or JPEG, that is supported by this toolkit.

Parameters:

imagedata - an array of bytes, representing image data in a supported image format.

Returns:

an image.

Since:

JDK1.1

---

createImage

public abstract Image createImage(byte[] imagedata,
 int imageoffset,
 int imagelength)

Enabled: Creates an image which decodes the image stored in the specified byte array, and at the specified offset and length. The data must be in some image format, such as GIF or JPEG, that is supported by this toolkit.

Parameters:

imagedata - an array of bytes, representing image data in a supported image format.

imageoffset - the offset of the beginning of the data in the array.

imagelength - the length of the data in the array.

Returns:

an image.

Since:

JDK1.1

---

getPrintJob

public abstract PrintJob getPrintJob(Frame frame,
 String jobtitle,
 Properties props)

Enabled: Gets a PrintJob object which is the result of initiating a print operation on the toolkit's platform.

Each actual implementation of this method should first check if there is a security manager installed. If there is, the method should call the security manager's checkPrintJobAccess method to ensure initiation of a print operation is allowed. If the default implementation of checkPrintJobAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a RuntimePermission("queuePrintJob") permission.

Parameters:

frame - the parent of the print dialog. May not be null.

jobtitle - the title of the PrintJob. A null title is equivalent to "".

props - a Properties object containing zero or more properties. Properties are not standardized and are not consistent across implementations. Because of this, PrintJobs which require job and page control should use the version of this function which takes JobAttributes and PageAttributes objects. This object may be updated to reflect the user's job choices on exit. May be null.

Returns:

a PrintJob object, or null if the user cancelled the print job.

Throws:

NullPointerException - if frame is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

SecurityException - if this thread is not allowed to initiate a print job request

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.PrintJob, java.lang.RuntimePermission

---

getPrintJob

public PrintJob getPrintJob(Frame frame,
 String jobtitle,
 JobAttributes jobAttributes,
 PageAttributes pageAttributes)

Enabled: Gets a PrintJob object which is the result of initiating a print operation on the toolkit's platform.

Each actual implementation of this method should first check if there is a security manager installed. If there is, the method should call the security manager's checkPrintJobAccess method to ensure initiation of a print operation is allowed. If the default implementation of checkPrintJobAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a RuntimePermission("queuePrintJob") permission.

Parameters:

frame - the parent of the print dialog. May be null if and only if jobAttributes is not null and jobAttributes.getDialog() returns JobAttributes.DialogType.NONE or JobAttributes.DialogType.COMMON.

jobtitle - the title of the PrintJob. A null title is equivalent to "".

jobAttributes - a set of job attributes which will control the PrintJob. The attributes will be updated to reflect the user's choices as outlined in the JobAttributes documentation. May be null.

pageAttributes - a set of page attributes which will control the PrintJob. The attributes will be applied to every page in the job. The attributes will be updated to reflect the user's choices as outlined in the PageAttributes documentation. May be null.

Returns:

a PrintJob object, or null if the user cancelled the print job.

Throws:

NullPointerException - if frame is null and either jobAttributes is null or jobAttributes.getDialog() returns JobAttributes.DialogType.NATIVE.

IllegalArgumentException - if pageAttributes specifies differing cross feed and feed resolutions. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

SecurityException - if this thread is not allowed to initiate a print job request, or if jobAttributes specifies print to file, and this thread is not allowed to access the file system

Since:

1.3

See Also:

java.awt.PrintJob, java.awt.GraphicsEnvironment#isHeadless, java.lang.RuntimePermission, java.awt.JobAttributes, java.awt.PageAttributes

---

beep

public abstract void beep()

Enabled: Emits an audio beep.

Since:

JDK1.1

---

getSystemClipboard

public abstract Clipboard getSystemClipboard()
 throws HeadlessException

Enabled: Gets the singleton instance of the system Clipboard which interfaces with clipboard facilities provided by the native platform. This clipboard enables data transfer between Java programs and native applications which use native clipboard facilities.

In addition to any and all formats specified in the flavormap.properties file, or other file specified by the AWT.DnD.flavorMapFileURL Toolkit property, text returned by the system Clipboard's getTransferData() method is available in the following flavors:

• DataFlavor.stringFlavor
• DataFlavor.plainTextFlavor (deprecated)

As with java.awt.datatransfer.StringSelection, if the requested flavor is DataFlavor.plainTextFlavor, or an equivalent flavor, a Reader is returned. Note: The behavior of the system Clipboard's getTransferData() method for DataFlavor.plainTextFlavor, and equivalent DataFlavors, is inconsistent with the definition of DataFlavor.plainTextFlavor . Because of this, support for DataFlavor.plainTextFlavor, and equivalent flavors, is deprecated.

Each actual implementation of this method should first check if there is a security manager installed. If there is, the method should call the security manager's checkSystemClipboardAccess method to ensure it's ok to to access the system clipboard. If the default implementation of checkSystemClipboardAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with an AWTPermission("accessClipboard") permission.

Returns:

the system Clipboard

HeadlessException

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.datatransfer.Clipboard, java.awt.datatransfer.StringSelection, java.awt.datatransfer.DataFlavor.stringFlavor, java.awt.datatransfer.DataFlavor.plainTextFlavor, java.io.Reader, java.awt.AWTPermission

---

getSystemSelection

public Clipboard getSystemSelection()
 throws HeadlessException

Suppressed: Gets the singleton instance of the system selection as a Clipboard object. This allows an application to read and modify the current, system-wide selection.

An application is responsible for updating the system selection whenever the user selects text, using either the mouse or the keyboard. Typically, this is implemented by installing a FocusListener on all Components which support text selection, and, between FOCUS_GAINED and FOCUS_LOST events delivered to that Component, updating the system selection Clipboard when the selection changes inside the Component. Properly updating the system selection ensures that a Java application will interact correctly with native applications and other Java applications running simultaneously on the system. Note that java.awt.TextComponent and javax.swing.text.JTextComponent already adhere to this policy. When using these classes, and their subclasses, developers need not write any additional code.

Some platforms do not support a system selection Clipboard. On those platforms, this method will return null. In such a case, an application is absolved from its responsibility to update the system selection Clipboard as described above.

Each actual implementation of this method should first check if there is a SecurityManager installed. If there is, the method should call the SecurityManager's checkSystemClipboardAccess method to ensure that client code has access the system selection. If the default implementation of checkSystemClipboardAccess is used (that is, if the method is not overridden), then this results in a call to the SecurityManager's checkPermission method with an AWTPermission("accessClipboard") permission.

Returns:

the system selection as a Clipboard, or null if the native platform does not support a system selection Clipboard

HeadlessException

Since:

1.4

See Also:

java.awt.datatransfer.Clipboard, java.awt.event.FocusListener, java.awt.event.FocusEvent#FOCUS_GAINED, java.awt.event.FocusEvent#FOCUS_LOST, TextComponent, javax.swing.text.JTextComponent, AWTPermission, GraphicsEnvironment.isHeadless()

---

getMenuShortcutKeyMask

public int getMenuShortcutKeyMask()
 throws HeadlessException

Enabled: Determines which modifier key is the appropriate accelerator key for menu shortcuts.

Menu shortcuts, which are embodied in the MenuShortcut class, are handled by the MenuBar class.

By default, this method returns Event.CTRL_MASK. Toolkit implementations should override this method if the Control key isn't the correct key for accelerators.

Returns:

the modifier mask on the Event class that is used for menu shortcuts on this toolkit.

HeadlessException

Since:

JDK1.1

See Also:

java.awt.GraphicsEnvironment#isHeadless, java.awt.MenuBar, java.awt.MenuShortcut

---

getLockingKeyState

public boolean getLockingKeyState(int keyCode)
 throws UnsupportedOperationException

Enabled: Returns whether the given locking key on the keyboard is currently in its "on" state. Valid key codes are VK_CAPS_LOCK, VK_NUM_LOCK, VK_SCROLL_LOCK, and VK_KANA_LOCK.

UnsupportedOperationException

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

setLockingKeyState

public void setLockingKeyState(int keyCode,
 boolean on)
 throws UnsupportedOperationException

Suppressed: Sets the state of the given locking key on the keyboard. Valid key codes are VK_CAPS_LOCK, VK_NUM_LOCK, VK_SCROLL_LOCK, and VK_KANA_LOCK.

Depending on the platform, setting the state of a locking key may involve event processing and therefore may not be immediately observable through getLockingKeyState.

UnsupportedOperationException

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getNativeContainer

protected static Container getNativeContainer(Component c)

Give native peers the ability to query the native container given a native component (eg the direct parent may be lightweight).

---

createCustomCursor

public Cursor createCustomCursor(Image cursor,
 Point hotSpot,
 String name)
 throws IndexOutOfBoundsException,
 HeadlessException

Enabled: Creates a new custom cursor object. If the image to display is invalid, the cursor will be hidden (made completely transparent), and the hotspot will be set to (0, 0).

Note that multi-frame images are invalid and may cause this method to hang.

Parameters:

hotSpot - the X and Y of the large cursor's hot spot; the hotSpot values must be less than the Dimension returned by getBestCursorSize

name - a localized description of the cursor, for Java Accessibility use

IndexOutOfBoundsException

HeadlessException

Since:

1.2

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getBestCursorSize

public Dimension getBestCursorSize(int preferredWidth,
 int preferredHeight)
 throws HeadlessException

Enabled: Returns the supported cursor dimension which is closest to the desired sizes. Systems which only support a single cursor size will return that size regardless of the desired sizes. Systems which don't support custom cursors will return a dimension of 0, 0.

Note: if an image is used whose dimensions don't match a supported size (as returned by this method), the Toolkit implementation will attempt to resize the image to a supported size. Since converting low-resolution images is difficult, no guarantees are made as to the quality of a cursor image which isn't a supported size. It is therefore recommended that this method be called and an appropriate image used so no image conversion is made.

Returns:

the closest matching supported cursor size, or a dimension of 0,0 if the Toolkit implementation doesn't support custom cursors.

HeadlessException

Since:

1.2

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getMaximumCursorColors

public int getMaximumCursorColors()
 throws HeadlessException

Enabled: Returns the maximum number of colors the Toolkit supports in a custom cursor palette.

Note: if an image is used which has more colors in its palette than the supported maximum, the Toolkit implementation will attempt to flatten the palette to the maximum. Since converting low-resolution images is difficult, no guarantees are made as to the quality of a cursor image which has more colors than the system supports. It is therefore recommended that this method be called and an appropriate image used so no image conversion is made.

Returns:

the maximum number of colors, or zero if custom cursors are not supported by this Toolkit implementation.

HeadlessException

Since:

1.2

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

isFrameStateSupported

public boolean isFrameStateSupported(int state)
 throws HeadlessException

Enabled: Returns whether Toolkit supports this state for Frames. This method tells whether the UI concept of, say, maximization or iconification is supported. It will always return false for "compound" states like Frame.ICONIFIED|Frame.MAXIMIZED_VERT. In other words, the rule of thumb is that only queries with a single frame state constant as an argument are meaningful.

Parameters:

state - one of named frame state constants.

Returns:

true is this frame state is supported by this Toolkit implementation, false otherwise.

HeadlessException

Since:

1.4

See Also:

java.awt.Frame#setExtendedState

---

initIDs

private static void initIDs()

Initialize JNI field and method ids

---

loadLibraries

static void loadLibraries()

---

getProperty

public static String getProperty(String key,
 String defaultValue)

Suppressed: Gets a property with the specified key and default. This method returns defaultValue if the property is not found.

---

getSystemEventQueue

public final EventQueue getSystemEventQueue()

Suppressed: Get the application's or applet's EventQueue instance. Depending on the Toolkit implementation, different EventQueues may be returned for different applets. Applets should therefore not assume that the EventQueue instance returned by this method will be shared by other applets or the system.

First, if there is a security manager, its checkAwtEventQueueAccess method is called. If the default implementation of checkAwtEventQueueAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with an AWTPermission("accessEventQueue") permission.

Returns:

the EventQueue object.

Throws:

SecurityException - if a security manager exists and its java.lang.SecurityManager#checkAwtEventQueueAccess method denies access to the EventQueue.

See Also:

java.awt.AWTPermission

---

getSystemEventQueueImpl

protected abstract EventQueue getSystemEventQueueImpl()

---

getEventQueue

static EventQueue getEventQueue()

---

createDragSourceContextPeer

public abstract java.awt.dnd.peer.DragSourceContextPeer createDragSourceContextPeer(DragGestureEvent dge)
 throws InvalidDnDOperationException

Suppressed: Creates the peer for a DragSourceContext. Always throws InvalidDndOperationException if GraphicsEnvironment.isHeadless() returns true.

InvalidDnDOperationException

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

createDragGestureRecognizer

public DragGestureRecognizer createDragGestureRecognizer(Class abstractRecognizerClass,
 DragSource ds,
 Component c,
 int srcActions,
 DragGestureListener dgl)

Enabled: Creates a concrete, platform dependent, subclass of the abstract DragGestureRecognizer class requested, and associates it with the DragSource, Component and DragGestureListener specified. subclasses should override this to provide their own implementation

Parameters:

abstractRecognizerClass - The abstract class of the required recognizer

ds - The DragSource

c - The Component target for the DragGestureRecognizer

srcActions - The actions permitted for the gesture

dgl - The DragGestureListener

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

getDesktopProperty

public final Object getDesktopProperty(String propertyName)

Enabled: Obtains a value for the specified desktop property. A desktop property is a uniquely named value for a resource that is Toolkit global in nature. Usually it also is an abstract representation for an underlying platform dependent desktop setting.

---

setDesktopProperty

protected final void setDesktopProperty(String name,
 Object newValue)

Sets the named desktop property to the specified value and fires a property change event to notify any listeners that the value has changed.

---

lazilyLoadDesktopProperty

protected Object lazilyLoadDesktopProperty(String name)

an opportunity to lazily evaluate desktop property values.

---

initializeDesktopProperties

protected void initializeDesktopProperties()

initializeDesktopProperties

---

addPropertyChangeListener

public void addPropertyChangeListener(String name,
 java.beans.PropertyChangeListener pcl)

Suppressed: Adds the specified property change listener for the named desktop property. If pcl is null, no exception is thrown and no action is performed.

Parameters:

name - The name of the property to listen for

pcl - The property change listener

Since:

1.2

---

removePropertyChangeListener

public void removePropertyChangeListener(String name,
 java.beans.PropertyChangeListener pcl)

Suppressed: Removes the specified property change listener for the named desktop property. If pcl is null, no exception is thrown and no action is performed.

Parameters:

name - The name of the property to remove

pcl - The property change listener

Since:

1.2

---

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners()

Suppressed: Returns an array of all the property change listeners registered on this toolkit.

Returns:

all of this toolkit's PropertyChangeListeners or an empty array if no property change listeners are currently registered

Since:

1.4

---

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Suppressed: Returns an array of all the PropertyChangeListeners associated with the named property.

Parameters:

propertyName - the named property

Returns:

all of the PropertyChangeListeners associated with the named property or an empty array if no such listeners have been added

Since:

1.4

---

deProxyAWTEventListener

private static AWTEventListener deProxyAWTEventListener(AWTEventListener l)

---

addAWTEventListener

public void addAWTEventListener(AWTEventListener listener,
 long eventMask)

Suppressed: Adds an AWTEventListener to receive all AWTEvents dispatched system-wide that conform to the given eventMask.

First, if there is a security manager, its checkPermission method is called with an AWTPermission("listenToAllAWTEvents") permission. This may result in a SecurityException.

eventMask is a bitmask of event types to receive. It is constructed by bitwise OR-ing together the event masks defined in AWTEvent.

Note: event listener use is not recommended for normal application use, but are intended solely to support special purpose facilities including support for accessibility, event record/playback, and diagnostic tracing. If listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the event listener.

eventMask - the bitmask of event types to receive

Throws:

SecurityException - if a security manager exists and its checkPermission method doesn't allow the operation.

Since:

1.2

See Also:

removeAWTEventListener(java.awt.event.AWTEventListener), getAWTEventListeners(), SecurityManager.checkPermission(java.security.Permission), java.awt.AWTEvent, java.awt.AWTPermission, java.awt.event.AWTEventListener, java.awt.event.AWTEventListenerProxy

---

removeAWTEventListener

public void removeAWTEventListener(AWTEventListener listener)

Suppressed: Removes an AWTEventListener from receiving dispatched AWTEvents.

First, if there is a security manager, its checkPermission method is called with an AWTPermission("listenToAllAWTEvents") permission. This may result in a SecurityException.

Note: event listener use is not recommended for normal application use, but are intended solely to support special purpose facilities including support for accessibility, event record/playback, and diagnostic tracing. If listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the event listener.

Throws:

SecurityException - if a security manager exists and its checkPermission method doesn't allow the operation.

Since:

1.2

See Also:

addAWTEventListener(java.awt.event.AWTEventListener, long), getAWTEventListeners(), SecurityManager.checkPermission(java.security.Permission), java.awt.AWTEvent, java.awt.AWTPermission, java.awt.event.AWTEventListener, java.awt.event.AWTEventListenerProxy

---

enabledOnToolkit

static boolean enabledOnToolkit(long eventMask)

---

countAWTEventListeners

int countAWTEventListeners(long eventMask)

---

getAWTEventListeners

public AWTEventListener[] getAWTEventListeners()

Suppressed: Returns an array of all the AWTEventListeners registered on this toolkit. Listeners can be returned within AWTEventListenerProxy objects, which also contain the event mask for the given listener. Note that listener objects added multiple times appear only once in the returned array.

Returns:

all of the AWTEventListeners or an empty array if no listeners are currently registered

Throws:

SecurityException - if a security manager exists and its checkPermission method doesn't allow the operation.

Since:

1.4

See Also:

addAWTEventListener(java.awt.event.AWTEventListener, long), removeAWTEventListener(java.awt.event.AWTEventListener), SecurityManager.checkPermission(java.security.Permission), java.awt.AWTEvent, java.awt.AWTPermission, java.awt.event.AWTEventListener, java.awt.event.AWTEventListenerProxy

---

getAWTEventListeners

public AWTEventListener[] getAWTEventListeners(long eventMask)

Suppressed: Returns an array of all the AWTEventListeners registered on this toolkit which listen to all of the event types indicates in the eventMask argument. Listeners can be returned within AWTEventListenerProxy objects, which also contain the event mask for the given listener. Note that listener objects added multiple times appear only once in the returned array.

Returns:

all of the AWTEventListeners registered on this toolkit for the specified event types, or an empty array if no such listeners are currently registered

Throws:

SecurityException - if a security manager exists and its checkPermission method doesn't allow the operation.

Since:

1.4

See Also:

addAWTEventListener(java.awt.event.AWTEventListener, long), removeAWTEventListener(java.awt.event.AWTEventListener), SecurityManager.checkPermission(java.security.Permission), java.awt.AWTEvent, java.awt.AWTPermission, java.awt.event.AWTEventListener, java.awt.event.AWTEventListenerProxy

---

notifyAWTEventListeners

void notifyAWTEventListeners(AWTEvent theEvent)

---

mapInputMethodHighlight

public abstract Map mapInputMethodHighlight(java.awt.im.InputMethodHighlight highlight)
 throws HeadlessException

Suppressed: Returns a map of visual attributes for the abstract level description of the given input method highlight, or null if no mapping is found. The style field of the input method highlight is ignored. The map returned is unmodifiable.

Parameters:

highlight - input method highlight

Returns:

style attribute map, or null

HeadlessException

Since:

1.3

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

---