public class

HeadlessToolkit

extends Toolkit
implements ComponentFactory
java.lang.Object
   ↳ java.awt.Toolkit
     ↳ sun.awt.HeadlessToolkit

Summary

[Expand]
Inherited Fields
From class java.awt.Toolkit
Public Constructors
HeadlessToolkit(Toolkit tk)
Public Methods
void addAWTEventListener(AWTEventListener listener, long eventMask)
Adds an AWTEventListener to receive all AWTEvents dispatched system-wide that conform to the given eventMask.
void addPropertyChangeListener(String name, PropertyChangeListener pcl)
Adds the specified property change listener for the named desktop property.
void beep()
Emits an audio beep.
int checkImage(Image img, int w, int h, ImageObserver o)
Indicates the construction status of a specified image that is being prepared for display.
ButtonPeer createButton(Button target)
Creates this toolkit's implementation of Button using the specified peer interface.
CanvasPeer createCanvas(Canvas target)
Creates this toolkit's implementation of Canvas using the specified peer interface.
CheckboxPeer createCheckbox(Checkbox target)
Creates this toolkit's implementation of Checkbox using the specified peer interface.
CheckboxMenuItemPeer createCheckboxMenuItem(CheckboxMenuItem target)
Creates this toolkit's implementation of CheckboxMenuItem using the specified peer interface.
ChoicePeer createChoice(Choice target)
Creates this toolkit's implementation of Choice using the specified peer interface.
Cursor createCustomCursor(Image cursor, Point hotSpot, String name)
Creates a new custom cursor object.
DesktopPeer createDesktopPeer(Desktop target)
Creates this toolkit's implementation of the Desktop using the specified peer interface.
DialogPeer createDialog(Dialog target)
Creates this toolkit's implementation of Dialog using the specified peer interface.
<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.
DragSourceContextPeer createDragSourceContextPeer(DragGestureEvent dge)
Creates the peer for a DragSourceContext.
FileDialogPeer createFileDialog(FileDialog target)
Creates this toolkit's implementation of FileDialog using the specified peer interface.
FramePeer createFrame(Frame target)
Creates this toolkit's implementation of Frame using the specified peer interface.
Image createImage(byte[] data, int offset, int length)
Creates an image which decodes the image stored in the specified byte array, and at the specified offset and length.
Image createImage(byte[] imagedata)
Creates an image which decodes the image stored in the specified byte array.
Image createImage(String filename)
Returns an image which gets pixel data from the specified file.
Image createImage(ImageProducer producer)
Creates an image with the specified image producer.
Image createImage(URL url)
Returns an image which gets pixel data from the specified URL.
KeyboardFocusManagerPeer createKeyboardFocusManagerPeer(KeyboardFocusManager manager)
LabelPeer createLabel(Label target)
Creates this toolkit's implementation of Label using the specified peer interface.
ListPeer createList(List target)
Creates this toolkit's implementation of List using the specified peer interface.
MenuPeer createMenu(Menu target)
Creates this toolkit's implementation of Menu using the specified peer interface.
MenuBarPeer createMenuBar(MenuBar target)
Creates this toolkit's implementation of MenuBar using the specified peer interface.
MenuItemPeer createMenuItem(MenuItem target)
Creates this toolkit's implementation of MenuItem using the specified peer interface.
PanelPeer createPanel(Panel target)
Creates this toolkit's implementation of Panel using the specified peer interface.
PopupMenuPeer createPopupMenu(PopupMenu target)
Creates this toolkit's implementation of PopupMenu using the specified peer interface.
RobotPeer createRobot(Robot target, GraphicsDevice screen)
ScrollPanePeer createScrollPane(ScrollPane target)
Creates this toolkit's implementation of ScrollPane using the specified peer interface.
ScrollbarPeer createScrollbar(Scrollbar target)
Creates this toolkit's implementation of Scrollbar using the specified peer interface.
SystemTrayPeer createSystemTray(SystemTray target)
TextAreaPeer createTextArea(TextArea target)
Creates this toolkit's implementation of TextArea using the specified peer interface.
TextFieldPeer createTextField(TextField target)
Creates this toolkit's implementation of TextField using the specified peer interface.
TrayIconPeer createTrayIcon(TrayIcon target)
WindowPeer createWindow(Window target)
Creates this toolkit's implementation of Window using the specified peer interface.
AWTEventListener[] getAWTEventListeners()
Returns an array of all the AWTEventListeners registered on this toolkit.
Dimension getBestCursorSize(int preferredWidth, int preferredHeight)
Returns the supported cursor dimension which is closest to the desired sizes.
ColorModel getColorModel()
Determines the color model of this toolkit's screen.
String[] getFontList()
This method is deprecated. see getAvailableFontFamilyNames()
FontMetrics getFontMetrics(Font font)
This method is deprecated. As of JDK version 1.2, replaced by the Font method getLineMetrics.
FontPeer getFontPeer(String name, int style)
This method is deprecated. see java.awt.GraphicsEnvironment#getAllFonts
GlobalCursorManager getGlobalCursorManager()
Image getImage(String filename)
Returns an image which gets pixel data from the specified file, whose format can be either GIF, JPEG or PNG.
Image getImage(URL url)
Returns an image which gets pixel data from the specified URL.
boolean getLockingKeyState(int keyCode)
Returns whether the given locking key on the keyboard is currently in its "on" state.
int getMaximumCursorColors()
Returns the maximum number of colors the Toolkit supports in a custom cursor palette.
int getMenuShortcutKeyMask()
Determines which modifier key is the appropriate accelerator key for menu shortcuts.
PrintJob getPrintJob(Frame frame, String doctitle, Properties props)
Gets a PrintJob object which is the result of initiating a print operation on the toolkit's platform.
PrintJob getPrintJob(Frame frame, String jobtitle, JobAttributes jobAttributes, PageAttributes pageAttributes)
Gets a PrintJob object which is the result of initiating a print operation on the toolkit's platform.
int getScreenHeight()
Insets getScreenInsets(GraphicsConfiguration gc)
Gets the insets of the screen.
int getScreenResolution()
Returns the screen resolution in dots-per-inch.
Dimension getScreenSize()
Gets the size of the screen.
int getScreenWidth()
Clipboard getSystemClipboard()
Gets the singleton instance of the system Clipboard which interfaces with clipboard facilities provided by the native platform.
EventQueue getSystemEventQueueImpl()
Gets the application's or applet's EventQueue instance, without checking access.
Toolkit getUnderlyingToolkit()
boolean isAlwaysOnTopSupported()
Returns whether the always-on-top mode is supported by this toolkit.
boolean isDesktopSupported()
boolean isDynamicLayoutActive()
Returns whether dynamic layout of Containers on resize is currently active (both set in program , and supported by the underlying operating system and/or window manager).
boolean isModalExclusionTypeSupported(Dialog.ModalExclusionType exclusionType)
Returns whether the given modal exclusion type is supported by this toolkit.
boolean isModalityTypeSupported(Dialog.ModalityType modalityType)
Returns whether the given modality type is supported by this toolkit.
boolean isTraySupported()
Map mapInputMethodHighlight(InputMethodHighlight highlight)
Returns a map of visual attributes for the abstract level description of the given input method highlight, or null if no mapping is found.
boolean prepareImage(Image img, int w, int h, ImageObserver o)
Prepares an image for rendering.
void removeAWTEventListener(AWTEventListener listener)
Removes an AWTEventListener from receiving dispatched AWTEvents.
void removePropertyChangeListener(String name, PropertyChangeListener pcl)
Removes the specified property change listener for the named desktop property.
void setDynamicLayout(boolean dynamic)
Controls whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete.
void setLockingKeyState(int keyCode, boolean on)
Sets the state of the given locking key on the keyboard.
void sync()
Synchronizes this toolkit's graphics state.
Protected Methods
boolean isDynamicLayoutSet()
Returns whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete.
void loadSystemColors(int[] systemColors)
Fills in the integer array that is supplied as an argument with the current system color values.
[Expand]
Inherited Methods
From class java.awt.Toolkit
From class java.lang.Object
From interface sun.awt.ComponentFactory

Public Constructors

public HeadlessToolkit (Toolkit tk)

Public Methods

public void addAWTEventListener (AWTEventListener listener, long eventMask)

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

public void addPropertyChangeListener (String name, PropertyChangeListener pcl)

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

public void beep ()

Emits an audio beep.

public int checkImage (Image img, int w, int h, ImageObserver o)

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
img the image whose status is being checked.
w the width of the scaled version whose status is being checked, or -1.
h the height of the scaled version whose status is being checked, or -1.
o 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.

public ButtonPeer createButton (Button target)

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.

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

public CheckboxPeer createCheckbox (Checkbox target)

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.

public CheckboxMenuItemPeer createCheckboxMenuItem (CheckboxMenuItem target)

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.

public ChoicePeer createChoice (Choice target)

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.

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

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
cursor the image to display when the cursor is actived
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

public DesktopPeer createDesktopPeer (Desktop target)

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

public DialogPeer createDialog (Dialog target)

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.

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

public DragSourceContextPeer createDragSourceContextPeer (DragGestureEvent dge)

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

public FileDialogPeer createFileDialog (FileDialog target)

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.

public FramePeer createFrame (Frame target)

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.

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

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
data an array of bytes, representing image data in a supported image format.
offset the offset of the beginning of the data in the array.
length the length of the data in the array.
Returns
  • an image.

public Image createImage (byte[] imagedata)

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.

public Image createImage (String filename)

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.

This method first checks if there is a security manager installed. If so, the method calls the security manager's checkRead method with the specified file to ensure that the image creation is allowed.

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.

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

public Image createImage (URL url)

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.

This method first checks if there is a security manager installed. If so, the method calls the security manager's checkPermission method with the url.openConnection().getPermission() permission to ensure that the image creation is allowed. For compatibility with pre-1.2 security managers, if the access is denied with FilePermission or SocketPermission, the method throws SecurityException if the corresponding 1.1-style SecurityManager.checkXXX method also denies permission.

Parameters
url the URL to use in fetching the pixel data.
Returns
  • an image which gets its pixel data from the specified URL.

public KeyboardFocusManagerPeer createKeyboardFocusManagerPeer (KeyboardFocusManager manager)

public LabelPeer createLabel (Label target)

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.

public ListPeer createList (List target)

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.

public MenuPeer createMenu (Menu target)

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.

public MenuBarPeer createMenuBar (MenuBar target)

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.

public MenuItemPeer createMenuItem (MenuItem target)

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.

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

public PopupMenuPeer createPopupMenu (PopupMenu target)

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.

public RobotPeer createRobot (Robot target, GraphicsDevice screen)

public ScrollPanePeer createScrollPane (ScrollPane target)

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.

public ScrollbarPeer createScrollbar (Scrollbar target)

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.

public SystemTrayPeer createSystemTray (SystemTray target)

public TextAreaPeer createTextArea (TextArea target)

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.

public TextFieldPeer createTextField (TextField target)

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.

public TrayIconPeer createTrayIcon (TrayIcon target)

public WindowPeer createWindow (Window target)

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.

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

public Dimension getBestCursorSize (int preferredWidth, int preferredHeight)

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.

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.

public ColorModel getColorModel ()

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.

public String[] getFontList ()

This method is deprecated.
see getAvailableFontFamilyNames()

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.

public FontMetrics getFontMetrics (Font font)

This method is 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

public FontPeer getFontPeer (String name, int style)

This method is 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

public GlobalCursorManager getGlobalCursorManager ()

public Image getImage (String filename)

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 in use for an indefinite period of time, developers are encouraged to implement their own caching of images by using the createImage variant wherever available. If the image data contained in the specified file changes, the Image object returned from this method may still contain stale information which was loaded from the file after a prior call. Previously loaded image data can be manually discarded by calling the flush method on the returned Image.

This method first checks if there is a security manager installed. If so, the method calls the security manager's checkRead method with the file specified to ensure that the access to the image is allowed.

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.

public Image getImage (URL url)

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 in use for an indefinite period of time, developers are encouraged to implement their own caching of images by using the createImage variant wherever available. If the image data stored at the specified URL changes, the Image object returned from this method may still contain stale information which was fetched from the URL after a prior call. Previously loaded image data can be manually discarded by calling the flush method on the returned Image.

This method first checks if there is a security manager installed. If so, the method calls the security manager's checkPermission method with the url.openConnection().getPermission() permission to ensure that the access to the image is allowed. For compatibility with pre-1.2 security managers, if the access is denied with FilePermission or SocketPermission, the method throws the SecurityException if the corresponding 1.1-style SecurityManager.checkXXX method also denies permission.

Parameters
url the URL to use in fetching the pixel data.
Returns
  • an image which gets its pixel data from the specified URL.

public boolean getLockingKeyState (int keyCode)

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.

public int getMaximumCursorColors ()

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.

public int getMenuShortcutKeyMask ()

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.

public PrintJob getPrintJob (Frame frame, String doctitle, Properties props)

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

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

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.

public int getScreenHeight ()

public Insets getScreenInsets (GraphicsConfiguration gc)

Gets the insets of the screen.

Parameters
gc a GraphicsConfiguration
Returns
  • the insets of this toolkit's screen, in pixels.

public int getScreenResolution ()

Returns the screen resolution in dots-per-inch.

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

public Dimension getScreenSize ()

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.

public int getScreenWidth ()

public Clipboard getSystemClipboard ()

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

public 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

public Toolkit getUnderlyingToolkit ()

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 isAlwaysOnTopSupported().

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

public boolean isDesktopSupported ()

public boolean isDynamicLayoutActive ()

Returns whether dynamic layout of Containers on resize is currently active (both set in program , and supported by the underlying operating system and/or window manager). 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.

public boolean isModalExclusionTypeSupported (Dialog.ModalExclusionType exclusionType)

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
exclusionType modal exclusion type to be checked for support by this toolkit
Returns
  • true, if current toolkit supports given modal exclusion type, false otherwise

public 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

public boolean isTraySupported ()

public Map mapInputMethodHighlight (InputMethodHighlight highlight)

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

public boolean prepareImage (Image img, int w, int h, ImageObserver o)

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
img the image for which to prepare a screen representation.
w the width of the desired screen representation, or -1.
h the height of the desired screen representation, or -1.
o the ImageObserver object to be notified as the image is being prepared.
Returns
  • true if the image has already been fully prepared; false otherwise.

public void removeAWTEventListener (AWTEventListener listener)

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.

public void removePropertyChangeListener (String name, PropertyChangeListener pcl)

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

public void setDynamicLayout (boolean dynamic)

Controls whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete. 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.

public void setLockingKeyState (int keyCode, boolean on)

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.

public void sync ()

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.

Protected Methods

protected boolean isDynamicLayoutSet ()

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.

protected void loadSystemColors (int[] systemColors)

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

Parameters
systemColors an integer array.