Class Toolkit

protected final Map Object>()

protected final Map desktopProperties

protected final PropertyChangeSupport desktopPropsSupport

public Toolkit()

Default constructor for subclasses.

public void addAWTEventListener(AWTEventListener listener,
                                long eventMask)

Adds an AWTEventListener to this toolkit. This listener is informed about all events that pass the eventqueue that match the specified evenMask. The eventMask is an ORed combination of event masks as defined in AWTEvent. If a security manager is installed, it is asked first if an AWTPermission("listenToAllAWTEvents") is allowed. This may result in a SecurityException beeing thrown. It is not recommended to use this kind of notification for normal applications. It is intended solely for the purpose of debugging and to support special facilities.

Parameters:

listener - the listener to add

eventMask - the event mask of event types which the listener is interested in

Throws:

SecurityException - if there is a SecurityManager that doesn't grant AWTPermission("listenToAllAWTEvents")

Since:

1.2

See Also:

getAWTEventListeners(), getAWTEventListeners(long), removeAWTEventListener(AWTEventListener)

public void addPropertyChangeListener(String name,
                                      PropertyChangeListener pcl)

public abstract void beep()

Causes a "beep" tone to be generated.

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

Checks the status of specified image as it is being readied for rendering.

Parameters:

image - The image to prepare for rendering.

width - The width of the image.

height - The height of the image.

observer - The observer to receive events about the preparation process.

Returns:

A union of the bitmasks from java.awt.image.ImageObserver that indicates the current state of the imaging readying process.

protected abstract ButtonPeer createButton(Button target)

Creates a peer object for the specified Button.

Parameters:

target - The Button to create the peer for.

Returns:

The peer for the specified Button object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract CanvasPeer createCanvas(Canvas target)

Creates a peer object for the specified Canvas.

Parameters:

target - The Canvas to create the peer for.

Returns:

The peer for the specified Canvas object.

protected abstract CheckboxPeer createCheckbox(Checkbox target)

Creates a peer object for the specified Checkbox.

Parameters:

target - The Checkbox to create the peer for.

Returns:

The peer for the specified Checkbox object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract CheckboxMenuItemPeer createCheckboxMenuItem(CheckboxMenuItem target)

Creates a peer object for the specified CheckboxMenuItem.

Parameters:

target - The CheckboxMenuItem to create the peer for.

Returns:

The peer for the specified CheckboxMenuItem object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract ChoicePeer createChoice(Choice target)

Creates a peer object for the specified Choice.

Parameters:

target - The Choice to create the peer for.

Returns:

The peer for the specified Choice object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected LightweightPeer createComponent(Component target)

Creates a peer object for the specified Component. The peer returned by this method is not a native windowing system peer with its own native window. Instead, this method allows the component to draw on its parent window as a "lightweight" widget.

Parameters:

target - The Component to create the peer for.

Returns:

The peer for the specified Component object.

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

Creates a new custom cursor object.

Throws:

IndexOutOfBoundsException - If the hotSpot values are outside the bounds of the cursor.

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract DesktopPeer createDesktopPeer(Desktop target)
            throws HeadlessException

Parameters:

target -

Returns:

Throws:

HeadlessException -

protected abstract DialogPeer createDialog(Dialog target)

Creates a peer object for the specified Dialog.

Parameters:

target - The dialog to create the peer for

Returns:

The peer for the specified font name.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public abstract DragSourceContextPeer createDragSourceContextPeer(DragGestureEvent e)

Since:

1.3

protected abstract FileDialogPeer createFileDialog(FileDialog target)

Creates a peer object for the specified FileDialog.

Parameters:

target - The FileDialog to create the peer for.

Returns:

The peer for the specified FileDialog object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract FramePeer createFrame(Frame target)

Creates a peer object for the specified Frame.

Parameters:

target - The Frame to create the peer for.

Returns:

The peer for the specified Frame object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public Image createImage(byte[] data)

Creates an image from the specified byte array. The array must be in a recognized format. Supported formats vary from toolkit to toolkit.

Parameters:

data - The raw image data.

Returns:

The created image.

public abstract Image createImage(byte[] data,
                                  int offset,
                                  int len)

Creates an image from the specified portion of the byte array passed. The array must be in a recognized format. Supported formats vary from toolkit to toolkit.

Parameters:

data - The raw image data.

offset - The offset into the data where the image data starts.

len - The length of the image data.

Returns:

The created image.

public abstract Image createImage(ImageProducer producer)

Creates an image using the specified ImageProducer

Parameters:

producer - The ImageProducer to create the image from.

Returns:

The created image.

public abstract Image createImage(String filename)

public abstract Image createImage(URL url)

protected abstract LabelPeer createLabel(Label target)

Creates a peer object for the specified Label.

Parameters:

target - The Label to create the peer for.

Returns:

The peer for the specified Label object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract ListPeer createList(List target)

Creates a peer object for the specified List.

Parameters:

target - The List to create the peer for.

Returns:

The peer for the specified List object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract MenuPeer createMenu(Menu target)

Creates a peer object for the specified Menu.

Parameters:

target - The Menu to create the peer for.

Returns:

The peer for the specified Menu object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract MenuBarPeer createMenuBar(MenuBar target)

Creates a peer object for the specified MenuBar.

Parameters:

target - The MenuBar to create the peer for.

Returns:

The peer for the specified MenuBar object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract MenuItemPeer createMenuItem(MenuItem target)

Creates a peer object for the specified MenuItem.

Parameters:

target - The MenuItem to create the peer for.

Returns:

The peer for the specified MenuItem object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract PanelPeer createPanel(Panel target)

Creates a peer object for the specified Panel.

Parameters:

target - The Panel to create the peer for.

Returns:

The peer for the specified Panel object.

protected abstract PopupMenuPeer createPopupMenu(PopupMenu target)

Creates a peer object for the specified PopupMenu.

Parameters:

target - The PopupMenu to create the peer for.

Returns:

The peer for the specified PopupMenu object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract ScrollPanePeer createScrollPane(ScrollPane target)

Creates a peer object for the specified ScrollPane.

Parameters:

target - The ScrollPane to create the peer for.

Returns:

The peer for the specified ScrollPane object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract ScrollbarPeer createScrollbar(Scrollbar target)

Creates a peer object for the specified Scrollbar.

Parameters:

target - The Scrollbar to create the peer for.

Returns:

The peer for the specified Scrollbar object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract TextAreaPeer createTextArea(TextArea target)

Creates a peer object for the specified TextArea.

Parameters:

target - The TextArea to create the peer for.

Returns:

The peer for the specified TextArea object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract TextFieldPeer createTextField(TextField target)

Creates a peer object for the specified TextField.

Parameters:

target - The TextField to create the peer for.

Returns:

The peer for the specified TextField object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected abstract WindowPeer createWindow(Window target)

Creates a peer object for the specified Window.

Parameters:

target - The Window to create the peer for.

Returns:

The peer for the specified Window object.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public extends DragGestureRecognizer> T
    createDragGestureRecognizer(Class recognizer,
                                                                           DragSource ds,
                                                                           Component comp,
                                                                           int actions,
                                                                           DragGestureListener l)

Since:

1.3

public AWTEventListener[] getAWTEventListeners()

Returns all registered AWT event listeners. This method returns a copy of the listener array, so that application cannot trash the listener list. If a security manager is installed, it is asked first if an AWTPermission("listenToAllAWTEvents") is allowed. This may result in a SecurityException beeing thrown. It is not recommended to use this kind of notification for normal applications. It is intended solely for the purpose of debugging and to support special facilities.

Returns:

all registered AWT event listeners

Throws:

SecurityException - if there is a SecurityManager that doesn't grant AWTPermission("listenToAllAWTEvents")

Since:

1.4

See Also:

addAWTEventListener(AWTEventListener,long), removeAWTEventListener(AWTEventListener), getAWTEventListeners(long)

public AWTEventListener[] getAWTEventListeners(long mask)

Returns all registered AWT event listeners that listen for events with the specified eventMask. This method returns a copy of the listener array, so that application cannot trash the listener list. If a security manager is installed, it is asked first if an AWTPermission("listenToAllAWTEvents") is allowed. This may result in a SecurityException beeing thrown. It is not recommended to use this kind of notification for normal applications. It is intended solely for the purpose of debugging and to support special facilities.

Parameters:

mask - the event mask

Throws:

SecurityException - if there is a SecurityManager that doesn't grant AWTPermission("listenToAllAWTEvents")

Since:

1.4

See Also:

addAWTEventListener(AWTEventListener,long), removeAWTEventListener(AWTEventListener), getAWTEventListeners()

public Dimension getBestCursorSize(int preferredWidth,
                                   int preferredHeight)

Returns the supported cursor dimension which is closest to the desired sizes.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public abstract ColorModel getColorModel()

Returns the color model of the screen.

Returns:

The color model of the screen.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public static Toolkit getDefaultToolkit()

Returns an instance of the default toolkit. The default toolkit is the subclass of Toolkit specified in the system property awt.toolkit, or gnu.java.awt.peer.gtk.GtkToolkit if the property is not set.

Returns:

An instance of the system default toolkit.

public final Object getDesktopProperty(String propertyName)

public abstract String[] getFontList()

Deprecated.

Returns the names of the available fonts.

Returns:

The names of the available fonts.

public abstract FontMetrics getFontMetrics(Font name)

Deprecated.

Return the font metrics for the specified font

Parameters:

name - The name of the font to return metrics for.

Returns:

The requested font metrics.

protected abstract FontPeer getFontPeer(String name,
                                        int style)

Deprecated.

Creates a peer object for the specified font name.

Parameters:

name - The font to create the peer for.

style - The font style to create the peer for.

Returns:

The peer for the specified font name.

public abstract Image getImage(String name)

Returns an image from the specified file, which must be in a recognized format. Supported formats vary from toolkit to toolkit.

Returns:

name The name of the file to read the image from.

public abstract Image getImage(URL url)

Returns an image from the specified URL, which must be in a recognized format. Supported formats vary from toolkit to toolkit.

Returns:

url The URl to read the image from.

public boolean getLockingKeyState(int keyCode)

Returns whether the given locking key on the keyboard is currently in its "on" state.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

IllegalArgumentException - If keyCode is not one of the valid keys.

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

public int getMaximumCursorColors()

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

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public int getMenuShortcutKeyMask()

Returns the accelerator key mask for menu shortcuts. The default is Event.CTRL_MASK. A toolkit must override this method to change the default.

Returns:

The key mask for the menu accelerator key.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

protected MouseInfoPeer getMouseInfoPeer()

Returns a MouseInfoPeer. The default implementation of this method throws UnsupportedOperationException. Toolkit implementations should overload this if possible, however.

protected static Container getNativeContainer(Component component)

Returns the native container object of the specified component. This method is necessary because the parent component might be a lightweight component.

Parameters:

component - The component to fetch the native container for.

Returns:

The native container object for this component.

public PrintJob getPrintJob(Frame frame,
                            String title,
                            JobAttributes jobAttr,
                            PageAttributes pageAttr)

Returns a instance of PrintJob for the specified arguments.

Parameters:

frame - The window initiating the print job.

title - The print job title.

jobAttr - A set of job attributes which will control the print job.

pageAttr - A set of page attributes which will control the print job.

Throws:

NullPointerException - If frame is null, and either jobAttr is null or jobAttr.getDialog() returns JobAttributes.DialogType.NATIVE.

IllegalArgumentException - If pageAttrspecifies differing cross feed and feed resolutions, or when GraphicsEnvironment.isHeadless() returns true.

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

Since:

1.3

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

Returns a instance of PrintJob for the specified arguments.

Parameters:

frame - The window initiating the print job.

title - The print job title.

props - The print job properties.

Returns:

The requested print job, or null if the job was cancelled.

Throws:

NullPointerException - If frame is null, or GraphicsEnvironment.isHeadless() returns true.

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

public static String getProperty(String key,
                                 String def)

Returns the value of the property with the specified name, or the default value if the property does not exist.

Parameters:

key - The name of the property to retrieve.

def - The default value of the property.

public PropertyChangeListener[] getPropertyChangeListeners()

Since:

1.4

public PropertyChangeListener[] getPropertyChangeListeners(String name)

Since:

1.4

public Insets getScreenInsets(GraphicsConfiguration gc)

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Since:

1.4

public abstract int getScreenResolution()

Returns the screen resolution in dots per square inch.

Returns:

The screen resolution in dots per square inch.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public abstract Dimension getScreenSize()

Returns the dimensions of the screen in pixels.

Returns:

The dimensions of the screen in pixels.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public abstract Clipboard getSystemClipboard()

Returns the system clipboard.

Returns:

THe system clipboard.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

public final EventQueue getSystemEventQueue()

Returns the event queue that is suitable for the calling context.

Despite the word “System” in the name of this method, a toolkit may provide different event queues for each applet. There is no guarantee that the same queue is shared system-wide.

The implementation first checks whether a SecurityManager has been installed. If so, its SecurityManager.checkAwtEventQueueAccess() method gets called. The security manager will throw a SecurityException if it does not grant the permission to access the event queue.

Next, the call is delegated to getSystemEventQueueImpl().

Returns:

The event queue for this applet (or application).

Throws:

SecurityException - if a security manager has been installed, and it does not grant the permission to access the event queue.

protected abstract EventQueue getSystemEventQueueImpl()

Returns the event queue that is suitable for the calling context.

Despite the word “System” in the name of this method, a toolkit may provide different event queues for each applet. There is no guarantee that the same queue is shared system-wide.

No security checks are performed, which is why this method may only be called by Toolkits.

See Also:

getSystemEventQueue()

public Clipboard getSystemSelection()

Gets the singleton instance of the system selection as a Clipboard object. The system selection contains the selected text of the last component/widget that had focus and a text selection. The default implementation returns null.

Returns:

The Clipboard holding the system (text) selection or null if the Toolkit or system doesn't support a selection clipboard.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

SecurityException - If the current security manager checkSystemClipboardAccess() doesn't allow access.

Since:

1.4

protected void initializeDesktopProperties()

public boolean isDynamicLayoutActive()

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Since:

1.4

protected boolean isDynamicLayoutSet()

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Since:

1.4

public boolean isFrameStateSupported(int state)

Returns whether Toolkit supports this state for Frames.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Since:

1.4

protected Object lazilyLoadDesktopProperty(String name)

protected void loadSystemColors(systemColors[] )

Copies the current system colors into the specified array. This is the interface used by the SystemColor class. Although this method fills in the array with some default colors a real Toolkit should override this method and provide real system colors for the native GUI platform.

Parameters:

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

See Also:

SystemColor

public abstract Map mapInputMethodHighlight(InputMethodHighlight highlight)

Since:

1.3

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

Readies an image to be rendered on the screen. The width and height values can be set to the default sizes for the image by passing -1 in those parameters.

Parameters:

image - The image to prepare for rendering.

width - The width of the image.

height - The height of the image.

observer - The observer to receive events about the preparation process.

Returns:

true if the image is already prepared for rendering, false otherwise.

public void removeAWTEventListener(AWTEventListener listener)

Removes an AWT event listener from this toolkit. This listener is no longer informed of any event types it was registered in. If a security manager is installed, it is asked first if an AWTPermission("listenToAllAWTEvents") is allowed. This may result in a SecurityException beeing thrown. It is not recommended to use this kind of notification for normal applications. It is intended solely for the purpose of debugging and to support special facilities.

Parameters:

listener - the listener to remove

Throws:

SecurityException - if there is a SecurityManager that doesn't grant AWTPermission("listenToAllAWTEvents")

Since:

1.2

See Also:

addAWTEventListener(AWTEventListener,long), getAWTEventListeners(), getAWTEventListeners(long)

public void removePropertyChangeListener(String name,
                                         PropertyChangeListener pcl)

protected final void setDesktopProperty(String name,
                                        Object newValue)

public void setDynamicLayout(boolean dynamic)

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Since:

1.4

public void setLockingKeyState(int keyCode,
                               boolean on)

Sets the state of the given locking key on the keyboard.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true.

IllegalArgumentException - If keyCode is not one of the valid keys.

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

public abstract void sync()

Flushes any buffered data to the screen so that it is in sync with what the AWT system has drawn to it.