Class Toolkit

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

Many GUI events may be delivered to user asynchronously, if the opposite is not specified explicitly. As well as many GUI operations may be performed asynchronously. This fact means that if the state of a component is set, and then the state immediately queried, the returned value may not yet reflect the requested change. This behavior includes, but is not limited to:

• Scrolling to a specified position.
  For example, calling ScrollPane.setScrollPosition and then getScrollPosition may return an incorrect value if the original request has not yet been processed.
• Moving the focus from one component to another.
  For more information, see Timing Focus Transfers, a section in The Swing Tutorial.
• Making a top-level container visible.
  Calling setVisible(true) on a Window, Frame or Dialog may occur asynchronously.
• Setting the size or location of a top-level container.
  Calls to setSize, setBounds or setLocation on a Window, Frame or Dialog are forwarded to the underlying window management system and may be ignored or modified. See Window for more information.

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.

Fields

desktopProperties

protected final Map<String,Object> desktopProperties

desktopPropsSupport

protected final PropertyChangeSupport desktopPropsSupport

Constructors

Toolkit

public Toolkit()

Methods

createDesktopPeer

protected abstract java.awt.peer.DesktopPeer createDesktopPeer(Desktop target)
                                                        throws HeadlessException

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

Parameters:

target - the desktop to be implemented

Returns:

this toolkit's implementation of the Desktop

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.6

See Also:

GraphicsEnvironment.isHeadless(), Desktop, DesktopPeer

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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Button, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), TextField, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Label, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), List, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Checkbox, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Scrollbar, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless(), ScrollPane, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), TextArea, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Choice, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Frame, 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:

Canvas, 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:

Panel, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Window, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Dialog, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), MenuBar, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), Menu, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless(), PopupMenu, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), MenuItem, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), FileDialog, 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), CheckboxMenuItem, CheckboxMenuItemPeer

getMouseInfoPeer

protected java.awt.peer.MouseInfoPeer getMouseInfoPeer()

Obtains this toolkit's implementation of helper class for MouseInfo operations.

Returns:

this toolkit's implementation of helper for MouseInfo

Throws:

UnsupportedOperationException - if this operation is not implemented

Since:

1.5

See Also:

MouseInfoPeer, MouseInfo

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

@Deprecated
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:

Font, FontPeer, 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.

Parameters:

systemColors - an integer array.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless()

setDynamicLayout

public void setDynamicLayout(boolean dynamic)
                      throws HeadlessException

Controls whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete. Use isDynamicLayoutActive() to detect if this feature enabled in this program and is supported by this operating system and/or window manager. Note that this feature is supported not on all platforms, and conversely, that this feature cannot be turned off on some platforms. On these platforms where dynamic layout during resizing 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 support or settings of the underlying operating system or window manager. The OS/WM support can be queried using getDesktopProperty("awt.dynamicLayoutSupported") method.

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.4

See Also:

isDynamicLayoutSet(), isDynamicLayoutActive(), getDesktopProperty(String propertyName), 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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.4

See Also:

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

isDynamicLayoutActive

public boolean isDynamicLayoutActive()
                              throws HeadlessException

Returns whether dynamic layout of Containers on resize is currently active (both set in program ( isDynamicLayoutSet() ) , and supported by the underlying operating system and/or window manager). If dynamic layout is currently inactive then Containers re-layout their components when resizing is completed. As a result the Component.validate() method will be invoked only once per resize. If dynamic layout is currently active then Containers re-layout their components on every native resize event and the validate() method will be invoked each time. The OS/WM support can be queried using the getDesktopProperty("awt.dynamicLayoutSupported") method.

Returns:

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

Throws:

HeadlessException - if the GraphicsEnvironment.isHeadless() method returns true

Since:

1.4

See Also:

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

getScreenSize

public abstract Dimension getScreenSize()
                                 throws HeadlessException

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.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsConfiguration.getBounds(), GraphicsDevice.getDisplayMode(), GraphicsEnvironment.isHeadless()

getScreenResolution

public abstract int getScreenResolution()
                                 throws HeadlessException

Returns the screen resolution in dots-per-inch.

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless()

getScreenInsets

public Insets getScreenInsets(GraphicsConfiguration gc)
                       throws HeadlessException

Gets the insets of the screen.

Parameters:

gc - a GraphicsConfiguration

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.4

See Also:

GraphicsEnvironment.isHeadless()

getColorModel

public abstract ColorModel getColorModel()
                                  throws HeadlessException

Returns:

the color model of this toolkit's screen.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

See Also:

GraphicsEnvironment.isHeadless(), ColorModel, Component.getColorModel()

getFontList

@Deprecated
public abstract String[] getFontList()

Deprecated. see GraphicsEnvironment.getAvailableFontFamilyNames()

Returns:

the names of the available fonts in this toolkit.

See Also:

GraphicsEnvironment.getAvailableFontFamilyNames()

getFontMetrics

@Deprecated
public abstract FontMetrics getFontMetrics(Font font)

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

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:

LineMetrics, Font.getLineMetrics(java.lang.String, java.awt.font.FontRenderContext), GraphicsEnvironment.getScreenDevices()

sync

public abstract void sync()

getDefaultToolkit

public static Toolkit getDefaultToolkit()

Returns:

the default toolkit.

Throws:

AWTError - if a toolkit could not be found, or if one could not be accessed or instantiated.

getImage

public abstract Image getImage(String filename)

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.

Throws:

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

See Also:

createImage(java.lang.String)

getImage

public abstract Image getImage(URL url)

Parameters:

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

Returns:

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

Throws:

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

See Also:

createImage(java.net.URL)

createImage

public abstract Image createImage(String filename)

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.

Throws:

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

See Also:

getImage(java.lang.String)

createImage

public abstract Image createImage(URL url)

Parameters:

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

Returns:

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

Throws:

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

See Also:

getImage(java.net.URL)

prepareImage

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

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:

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

checkImage

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

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:

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

createImage

public abstract Image createImage(ImageProducer producer)

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:

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

createImage

public Image createImage(byte[] imagedata)

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)

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)

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

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

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless(), PrintJob, RuntimePermission

getPrintJob

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

Parameters:

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

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

IllegalArgumentException - if pageAttributes specifies differing cross feed and feed resolutions. Also if this thread has access to the file system and jobAttributes specifies print to file, and the specified destination file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason. However in the case of print to file, if a dialog is also requested to be displayed then the user will be given an opportunity to select a file and proceed with printing. The dialog will ensure that the selected output file is valid before returning from this method.

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:

PrintJob, GraphicsEnvironment.isHeadless(), RuntimePermission, JobAttributes, PageAttributes

beep

public abstract void beep()

Emits an audio beep depending on native system settings and hardware capabilities.

Since:

JDK1.1

getSystemClipboard

public abstract Clipboard getSystemClipboard()
                                      throws HeadlessException

Returns:

the system Clipboard

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless(), Clipboard, StringSelection, DataFlavor.stringFlavor, DataFlavor.plainTextFlavor, Reader, AWTPermission

getSystemSelection

public Clipboard getSystemSelection()
                             throws HeadlessException

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.4

See Also:

Clipboard, FocusListener, FocusEvent.FOCUS_GAINED, FocusEvent.FOCUS_LOST, TextComponent, JTextComponent, AWTPermission, GraphicsEnvironment.isHeadless()

getMenuShortcutKeyMask

public int getMenuShortcutKeyMask()
                           throws HeadlessException

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

JDK1.1

See Also:

GraphicsEnvironment.isHeadless(), MenuBar, MenuShortcut

getLockingKeyState

public boolean getLockingKeyState(int keyCode)
                           throws UnsupportedOperationException

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.

Throws:

IllegalArgumentException - if keyCode is not one of the valid key codes

UnsupportedOperationException - if the host system doesn't allow getting the state of this key programmatically, or if the keyboard doesn't have this key

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.3

See Also:

GraphicsEnvironment.isHeadless()

setLockingKeyState

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

Throws:

IllegalArgumentException - if keyCode is not one of the valid key codes

UnsupportedOperationException - if the host system doesn't allow setting the state of this key programmatically, or if the keyboard doesn't have this key

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.3

See Also:

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

Parameters:

cursor - the image to display when the cursor is activated

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

Throws:

IndexOutOfBoundsException - if the hotSpot values are outside the bounds of the cursor

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

getBestCursorSize

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

Parameters:

preferredWidth - the preferred cursor width the component would like to use.

preferredHeight - the preferred cursor height the component would like to use.

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

getMaximumCursorColors

public int getMaximumCursorColors()
                           throws HeadlessException

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

isFrameStateSupported

public boolean isFrameStateSupported(int state)
                              throws HeadlessException

Parameters:

state - one of named frame state constants.

Returns:

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

Since:

1.4

See Also:

Window.addWindowStateListener(java.awt.event.WindowStateListener)

getProperty

public static String getProperty(String key,
                                 String defaultValue)

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

getSystemEventQueue

public final EventQueue getSystemEventQueue()

Returns:

the EventQueue object

Throws:

SecurityException - if a security manager is set and it denies access to the EventQueue

See Also:

AWTPermission

getSystemEventQueueImpl

protected abstract EventQueue getSystemEventQueueImpl()

Gets the application's or applet's EventQueue instance, without checking access. For security reasons, this can only be called from a Toolkit subclass.

Returns:

the EventQueue object

createDragSourceContextPeer

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

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

Throws:

InvalidDnDOperationException

See Also:

GraphicsEnvironment.isHeadless()

createDragGestureRecognizer

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

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

Returns:

the new object or null. Always returns null if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

getDesktopProperty

public final Object getDesktopProperty(String propertyName)

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. For more information on desktop properties supported by the AWT see AWT Desktop Properties.

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,
                                      PropertyChangeListener pcl)

Adds the specified property change listener for the named desktop property. When a PropertyChangeListenerProxy object is added, its property name is ignored, and the wrapped listener is added. If name is null or 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

See Also:

PropertyChangeSupport.addPropertyChangeListener(String, PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String name,
                                         PropertyChangeListener pcl)

Removes the specified property change listener for the named desktop property. When a PropertyChangeListenerProxy object is removed, its property name is ignored, and the wrapped listener is removed. If name is null or 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

See Also:

PropertyChangeSupport.removePropertyChangeListener(String, PropertyChangeListener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Returns an array of all the property change listeners registered on this toolkit. The returned array contains PropertyChangeListenerProxy objects that associate listeners with the names of desktop properties.

Returns:

all of this toolkit's PropertyChangeListener objects wrapped in java.beans.PropertyChangeListenerProxy objects or an empty array if no listeners are added

Since:

1.4

See Also:

PropertyChangeSupport.getPropertyChangeListeners()

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Returns an array of all property change listeners associated with the specified name of a desktop property.

Parameters:

propertyName - the named property

Returns:

all of the PropertyChangeListener objects associated with the specified name of a desktop property or an empty array if no such listeners are added

Since:

1.4

See Also:

PropertyChangeSupport.getPropertyChangeListeners(String)

isAlwaysOnTopSupported

public boolean isAlwaysOnTopSupported()

Returns whether the always-on-top mode is supported by this toolkit. To detect whether the always-on-top mode is supported for a particular Window, use Window.isAlwaysOnTopSupported().

Returns:

true, if current toolkit supports the always-on-top mode, otherwise returns false

Since:

1.6

See Also:

Window.isAlwaysOnTopSupported(), Window.setAlwaysOnTop(boolean)

isModalityTypeSupported

public abstract boolean isModalityTypeSupported(Dialog.ModalityType modalityType)

Returns whether the given modality type is supported by this toolkit. If a dialog with unsupported modality type is created, then Dialog.ModalityType.MODELESS is used instead.

Parameters:

modalityType - modality type to be checked for support by this toolkit

Returns:

true, if current toolkit supports given modality type, false otherwise

Since:

1.6

See Also:

Dialog.ModalityType, Dialog.getModalityType(), Dialog.setModalityType(java.awt.Dialog.ModalityType)

isModalExclusionTypeSupported

public abstract boolean isModalExclusionTypeSupported(Dialog.ModalExclusionType modalExclusionType)

Returns whether the given modal exclusion type is supported by this toolkit. If an unsupported modal exclusion type property is set on a window, then Dialog.ModalExclusionType.NO_EXCLUDE is used instead.

Parameters:

modalExclusionType - modal exclusion type to be checked for support by this toolkit

Returns:

true, if current toolkit supports given modal exclusion type, false otherwise

Since:

1.6

See Also:

Dialog.ModalExclusionType, Window.getModalExclusionType(), Window.setModalExclusionType(java.awt.Dialog.ModalExclusionType)

addAWTEventListener

public void addAWTEventListener(AWTEventListener listener,
                                long eventMask)

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), AWTEvent, AWTPermission, AWTEventListener, AWTEventListenerProxy

removeAWTEventListener

public void removeAWTEventListener(AWTEventListener listener)

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), AWTEvent, AWTPermission, AWTEventListener, AWTEventListenerProxy

getAWTEventListeners

public AWTEventListener[] getAWTEventListeners()

Returns an array of all the AWTEventListeners registered on this toolkit. If there is a security manager, its checkPermission method is called with an AWTPermission("listenToAllAWTEvents") permission. This may result in a SecurityException. 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), AWTEvent, AWTPermission, AWTEventListener, AWTEventListenerProxy

getAWTEventListeners

public AWTEventListener[] getAWTEventListeners(long eventMask)

Returns an array of all the AWTEventListeners registered on this toolkit which listen to all of the event types specified in the eventMask argument. If there is a security manager, its checkPermission method is called with an AWTPermission("listenToAllAWTEvents") permission. This may result in a SecurityException. 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.

Parameters:

eventMask - the bitmask of event types to listen for

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), AWTEvent, AWTPermission, AWTEventListener, AWTEventListenerProxy

mapInputMethodHighlight

public abstract Map<TextAttribute,?> mapInputMethodHighlight(InputMethodHighlight highlight)
                                                      throws HeadlessException

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

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

Since:

1.3

See Also:

GraphicsEnvironment.isHeadless()

areExtraMouseButtonsEnabled

public boolean areExtraMouseButtonsEnabled()
                                    throws HeadlessException

java -Dsun.awt.enableExtraMouseButtons=false Application

System.setProperty("sun.awt.enableExtraMouseButtons", "true");

Returns:

true if events from extra mouse buttons are allowed to be processed and posted; false otherwise

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true

Since:

1.7

See Also:

System.getProperty(String propertyName), System.setProperty(String propertyName, String value), EventQueue