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, callingScrollPane.setScrollPosition
and thengetScrollPosition
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.
CallingsetVisible(true)
on aWindow
,Frame
orDialog
may occur asynchronously. - Setting the size or location of a top-level container.
Calls tosetSize
,setBounds
orsetLocation
on aWindow
,Frame
orDialog
are forwarded to the underlying window management system and may be ignored or modified. SeeWindow
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.
- Since:
- 1.0
-
Field Summary
Modifier and TypeFieldDescriptionThe desktop properties.protected final PropertyChangeSupport
The desktop properties change support. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAWTEventListener
(AWTEventListener listener, long eventMask) Adds an AWTEventListener to receive all AWTEvents dispatched system-wide that conform to the giveneventMask
.void
Adds the specified property change listener for the named desktop property.boolean
Reports whether events from extra mouse buttons are allowed to be processed and posted intoEventQueue
.abstract void
beep()
Emits an audio beep depending on native system settings and hardware capabilities.abstract int
checkImage
(Image image, int width, int height, ImageObserver observer) Indicates the construction status of a specified image that is being prepared for display.createCustomCursor
(Image cursor, Point hotSpot, String name) Creates a new custom cursor object.<T extends DragGestureRecognizer>
TcreateDragGestureRecognizer
(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.createImage
(byte[] imagedata) Creates an image which decodes the image stored in the specified byte array.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.abstract Image
createImage
(ImageProducer producer) Creates an image with the specified image producer.abstract Image
createImage
(String filename) Returns an image which gets pixel data from the specified file.abstract Image
createImage
(URL url) Returns an image which gets pixel data from the specified URL.Returns an array of all theAWTEventListener
s registered on this toolkit.getAWTEventListeners
(long eventMask) Returns an array of all theAWTEventListener
s registered on this toolkit which listen to all of the event types specified in theeventMask
argument.getBestCursorSize
(int preferredWidth, int preferredHeight) Returns the supported cursor dimension which is closest to the desired sizes.abstract ColorModel
Determines the color model of this toolkit's screen.static Toolkit
Gets the default toolkit.final Object
getDesktopProperty
(String propertyName) Obtains a value for the specified desktop property.abstract String[]
Deprecated.abstract FontMetrics
getFontMetrics
(Font font) Deprecated.As of JDK version 1.2, replaced by theFont
methodgetLineMetrics
.abstract Image
Returns an image which gets pixel data from the specified file, whose format can be either GIF, JPEG or PNG.abstract Image
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
Returns the maximum number of colors the Toolkit supports in a custom cursor palette.int
Deprecated.It is recommended that extended modifier keys andgetMenuShortcutKeyMaskEx()
be used insteadint
Determines which extended modifier key is the appropriate accelerator key for menu shortcuts.protected static Container
Give native peers the ability to query the native container given a native component (eg the direct parent may be lightweight).getPrintJob
(Frame frame, String jobtitle, JobAttributes jobAttributes, PageAttributes pageAttributes) Gets aPrintJob
object which is the result of initiating a print operation on the toolkit's platform.abstract PrintJob
getPrintJob
(Frame frame, String jobtitle, Properties props) Gets aPrintJob
object which is the result of initiating a print operation on the toolkit's platform.static String
getProperty
(String key, String defaultValue) Gets a property with the specified key and default.Returns an array of all the property change listeners registered on this toolkit.getPropertyChangeListeners
(String propertyName) Returns an array of all property change listeners associated with the specified name of a desktop property.Gets the insets of the screen.abstract int
Returns the screen resolution in dots-per-inch.abstract Dimension
Gets the size of the screen.abstract Clipboard
Gets the singleton instance of the system Clipboard which interfaces with clipboard facilities provided by the native platform.final EventQueue
Get the application's or applet's EventQueue instance.protected abstract EventQueue
Gets the application's or applet'sEventQueue
instance, without checking access.Gets the singleton instance of the system selection as aClipboard
object.protected void
initializeDesktopPropertiesboolean
Returns whether the always-on-top mode is supported by this toolkit.boolean
Returns whether dynamic layout of Containers on resize is currently enabled on the underlying operating system and/or window manager.protected boolean
Returns whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete.boolean
isFrameStateSupported
(int state) Returns whether Toolkit supports this state forFrame
s.abstract boolean
isModalExclusionTypeSupported
(Dialog.ModalExclusionType modalExclusionType) Returns whether the given modal exclusion type is supported by this toolkit.abstract boolean
isModalityTypeSupported
(Dialog.ModalityType modalityType) Returns whether the given modality type is supported by this toolkit.protected Object
An opportunity to lazily evaluate desktop property values.protected void
loadSystemColors
(int[] systemColors) Fills in the integer array that is supplied as an argument with the current system color values.abstract Map
<TextAttribute, ?> 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.abstract boolean
prepareImage
(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering.void
removeAWTEventListener
(AWTEventListener listener) Removes an AWTEventListener from receiving dispatched AWTEvents.void
Removes the specified property change listener for the named desktop property.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.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.abstract void
sync()
Synchronizes this toolkit's graphics state.
-
Field Details
-
desktopProperties
-
desktopPropsSupport
The desktop properties change support.
-
-
Constructor Details
-
Toolkit
protected Toolkit()Constructs aToolkit
.
-
-
Method Details
-
loadSystemColors
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:
- 1.1
- See Also:
-
setDynamicLayout
Controls whether the layout of Containers is validated dynamically during resizing, or statically, after resizing is complete. UseisDynamicLayoutActive()
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
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:
-
isDynamicLayoutActive
Returns whether dynamic layout of Containers on resize is currently enabled on the underlying operating system and/or window manager. If the platform supports it,setDynamicLayout(boolean)
may be used to programmatically enable or disable platform dynamic layout. Regardless of whether that toggling is supported, or whethertrue
orfalse
is specified as an argument, or has never been called at all, this method will return the active current platform behavior and which will be followed by the JDK in determining layout policy during resizing.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 thevalidate()
method will be invoked each time. The OS/WM support can be queried using the getDesktopProperty("awt.dynamicLayoutSupported") method. This property will reflect the platform capability but is not sufficient to tell if it is presently enabled.- 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:
-
getScreenSize
Gets the size of the screen. On systems with multiple displays, the primary display is used. Multi-screen aware display dimensions are available fromGraphicsConfiguration
andGraphicsDevice
.- Returns:
- the size of this toolkit's screen, in pixels.
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
-
getScreenResolution
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:
-
getScreenInsets
Gets the insets of the screen.- Parameters:
gc
- aGraphicsConfiguration
- Returns:
- the insets of this toolkit's screen, in pixels.
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.4
- See Also:
-
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 theComponent
class.- Returns:
- the color model of this toolkit's screen.
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
-
getFontList
Deprecated.Returns the names of the available fonts in this toolkit.For 1.1, the following font names are deprecated (the replacement name follows):
- TimesRoman (use Serif)
- Helvetica (use SansSerif)
- Courier (use Monospaced)
The ZapfDingbats fontname is also deprecated in 1.1 but the characters are defined in Unicode starting at 0x2700, and as of 1.1 Java supports those characters.
- Returns:
- the names of the available fonts in this toolkit.
- See Also:
-
getFontMetrics
Deprecated.As of JDK version 1.2, replaced by theFont
methodgetLineMetrics
.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:
-
sync
public abstract 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.
-
getDefaultToolkit
Gets the default toolkit.If a system property named
"java.awt.headless"
is set totrue
then the headless implementation ofToolkit
is used, otherwise the default platform-specific implementation ofToolkit
is used.If this Toolkit is not a headless implementation and if they exist, service providers of
AccessibilityProvider
will be loaded if specified by the system propertyjavax.accessibility.assistive_technologies
.An example of setting this property is to invoke Java with
-Djavax.accessibility.assistive_technologies=MyServiceProvider
. In addition to MyServiceProvider other service providers can be specified using a comma separated list. Service providers are loaded after the AWT toolkit is created.If the list of assistive technology providers as provided through system property "
javax.accessibility.assistive_technologies
" is the empty string or contains only white space characters it is ignored. All other errors are handled via an AWTError exception.The names specified in the assistive_technologies property are used to query each service provider implementation. If the requested name matches the name of the service provider, the
AccessibilityProvider.activate()
method will be invoked to activate the matching service provider.- Implementation Requirements:
- If assistive technology service providers are not specified with a system
property this implementation will look in a properties file located as follows:
-
${user.home}/.accessibility.properties
-
${java.home}/conf/accessibility.properties
assistive_technologies=
property. A single provider or a comma separated list of providers can be specified. -
- Returns:
- the default toolkit.
- Throws:
AWTError
- in case of an error loading assistive technologies.- See Also:
-
getImage
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 thecreateImage
variant wherever available. If the image data contained in the specified file changes, theImage
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 theflush
method on the returnedImage
.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.
- Throws:
SecurityException
- if a security manager exists and its checkRead method doesn't allow the operation.- See Also:
-
getImage
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 thecreateImage
variant wherever available. If the image data stored at the specified URL changes, theImage
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 theflush
method on the returnedImage
.This method first checks if there is a security manager installed. If so, the method calls the security manager's
checkPermission
method with the corresponding permission to ensure that the access to the image is allowed. If the connection to the specified URL requires eitherURLPermission
orSocketPermission
, thenURLPermission
is used for security checks.- 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
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.
- Throws:
SecurityException
- if a security manager exists and its checkRead method doesn't allow the operation.- See Also:
-
createImage
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 corresponding permission to ensure that the image creation is allowed. If the connection to the specified URL requires eitherURLPermission
orSocketPermission
, thenURLPermission
is used for security checks.- 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:
-
prepareImage
Prepares an image for rendering.If the values of the width and height arguments are both
-1
, this method prepares the image for rendering on the default screen; otherwise, this method prepares an image for rendering on the default screen at the specified width and height.The image data is downloaded asynchronously in another thread, and an appropriately scaled screen representation of the image is generated.
This method is called by components
prepareImage
methods.Information on the flags returned by this method can be found with the definition of the
ImageObserver
interface.- Parameters:
image
- the image for which to prepare a screen representation.width
- the width of the desired screen representation, or-1
.height
- the height of the desired screen representation, or-1
.observer
- theImageObserver
object to be notified as the image is being prepared.- Returns:
true
if the image has already been fully prepared;false
otherwise.- See Also:
-
checkImage
Indicates the construction status of a specified image that is being prepared for display.If the values of the width and height arguments are both
-1
, this method returns the construction status of a screen representation of the specified image in this toolkit. Otherwise, this method returns the construction status of a scaled representation of the image at the specified width and height.This method does not cause the image to begin loading. An application must call
prepareImage
to force the loading of an image.This method is called by the component's
checkImage
methods.Information on the flags returned by this method can be found with the definition of the
ImageObserver
interface.- Parameters:
image
- the image whose status is being checked.width
- the width of the scaled version whose status is being checked, or-1
.height
- the height of the scaled version whose status is being checked, or-1
.observer
- theImageObserver
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:
-
createImage
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:
-
createImage
Creates an image which decodes the image stored in the specified byte array.The data must be in some image format, such as GIF or JPEG, that is supported by this toolkit.
- Parameters:
imagedata
- an array of bytes, representing image data in a supported image format.- Returns:
- an image.
- Since:
- 1.1
-
createImage
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:
- 1.1
-
getPrintJob
Gets aPrintJob
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 ofcheckPrintJobAccess
is used (that is, that method is not overridden), then this results in a call to the security manager'scheckPermission
method with aRuntimePermission("queuePrintJob")
permission.- Parameters:
frame
- the parent of the print dialog. May not be null.jobtitle
- the title of the PrintJob. A null title is equivalent to "".props
- a Properties object containing zero or more properties. Properties are not standardized and are not consistent across implementations. Because of this, PrintJobs which require job and page control should use the version of this function which takes JobAttributes and PageAttributes objects. This object may be updated to reflect the user's job choices on exit. May be null.- Returns:
- a
PrintJob
object, ornull
if the user cancelled the print job. - Throws:
NullPointerException
- if frame is nullSecurityException
- if this thread is not allowed to initiate a print job request- Since:
- 1.1
- See Also:
-
getPrintJob
public PrintJob getPrintJob(Frame frame, String jobtitle, JobAttributes jobAttributes, PageAttributes pageAttributes) Gets aPrintJob
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 ofcheckPrintJobAccess
is used (that is, that method is not overridden), then this results in a call to the security manager'scheckPermission
method with aRuntimePermission("queuePrintJob")
permission.- Parameters:
frame
- the parent of the print dialog. May not be null.jobtitle
- the title of the PrintJob. A null title is equivalent to "".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, ornull
if the user cancelled the print job. - Throws:
NullPointerException
- if frame is nullIllegalArgumentException
- 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:
-
beep
public abstract void beep()Emits an audio beep depending on native system settings and hardware capabilities.- Since:
- 1.1
-
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 default formats text returned by the system Clipboard's
getTransferData()
method is available in the following flavors:- DataFlavor.stringFlavor
- DataFlavor.plainTextFlavor (deprecated)
java.awt.datatransfer.StringSelection
, if the requested flavor isDataFlavor.plainTextFlavor
, or an equivalent flavor, a Reader is returned. Note: The behavior of the system Clipboard'sgetTransferData()
method forDataFlavor.plainTextFlavor
, and equivalent DataFlavors, is inconsistent with the definition ofDataFlavor.plainTextFlavor
. Because of this, support forDataFlavor.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
checkPermission
method to checkAWTPermission("accessClipboard")
.- Returns:
- the system Clipboard
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.1
- See Also:
-
getSystemSelection
Gets the singleton instance of the system selection as aClipboard
object. This allows an application to read and modify the current, system-wide selection.An application is responsible for updating the system selection whenever the user selects text, using either the mouse or the keyboard. Typically, this is implemented by installing a
FocusListener
on allComponent
s which support text selection, and, betweenFOCUS_GAINED
andFOCUS_LOST
events delivered to thatComponent
, updating the system selectionClipboard
when the selection changes inside theComponent
. Properly updating the system selection ensures that a Java application will interact correctly with native applications and other Java applications running simultaneously on the system. Note thatjava.awt.TextComponent
andjavax.swing.text.JTextComponent
already adhere to this policy. When using these classes, and their subclasses, developers need not write any additional code.Some platforms do not support a system selection
Clipboard
. On those platforms, this method will returnnull
. In such a case, an application is absolved from its responsibility to update the system selectionClipboard
as described above.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
checkPermission
method to checkAWTPermission("accessClipboard")
.- Returns:
- the system selection as a
Clipboard
, ornull
if the native platform does not support a system selectionClipboard
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.4
- See Also:
-
getMenuShortcutKeyMask
Deprecated.It is recommended that extended modifier keys andgetMenuShortcutKeyMaskEx()
be used insteadDetermines which modifier key is the appropriate accelerator key for menu shortcuts.Menu shortcuts, which are embodied in the
MenuShortcut
class, are handled by theMenuBar
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. - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.1
- See Also:
-
getMenuShortcutKeyMaskEx
Determines which extended modifier key is the appropriate accelerator key for menu shortcuts.Menu shortcuts, which are embodied in the
MenuShortcut
class, are handled by theMenuBar
class.By default, this method returns
InputEvent.CTRL_DOWN_MASK
. Toolkit implementations should override this method if the Control key isn't the correct key for accelerators.- Returns:
- the modifier mask on the
InputEvent
class that is used for menu shortcuts on this toolkit - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 10
- See Also:
-
getLockingKeyState
Returns whether the given locking key on the keyboard is currently in its "on" state. Valid key codes areVK_CAPS_LOCK
,VK_NUM_LOCK
,VK_SCROLL_LOCK
, andVK_KANA_LOCK
.- Parameters:
keyCode
- the key code- Returns:
true
if the given key is currently in its "on" state; otherwisefalse
- Throws:
IllegalArgumentException
- ifkeyCode
is not one of the valid key codesUnsupportedOperationException
- if the host system doesn't allow getting the state of this key programmatically, or if the keyboard doesn't have this keyHeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.3
- See Also:
-
setLockingKeyState
Sets the state of the given locking key on the keyboard. Valid key codes areVK_CAPS_LOCK
,VK_NUM_LOCK
,VK_SCROLL_LOCK
, andVK_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.
- Parameters:
keyCode
- the key codeon
- the state of the key- Throws:
IllegalArgumentException
- ifkeyCode
is not one of the valid key codesUnsupportedOperationException
- if the host system doesn't allow setting the state of this key programmatically, or if the keyboard doesn't have this keyHeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.3
- See Also:
-
getNativeContainer
-
createCustomCursor
public Cursor createCustomCursor(Image cursor, Point hotSpot, String name) throws IndexOutOfBoundsException, HeadlessException 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 activatedhotSpot
- the X and Y of the large cursor's hot spot; the hotSpot values must be less than the Dimension returned bygetBestCursorSize
name
- a localized description of the cursor, for Java Accessibility use- Returns:
- the cursor created
- Throws:
IndexOutOfBoundsException
- if the hotSpot values are outside the bounds of the cursorHeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.2
- See Also:
-
getBestCursorSize
public Dimension getBestCursorSize(int preferredWidth, int preferredHeight) throws HeadlessException 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.
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.2
- See Also:
-
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.
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- Since:
- 1.2
- See Also:
-
isFrameStateSupported
Returns whether Toolkit supports this state forFrame
s. This method tells whether the UI concept of, say, maximization or iconification is supported. It will always return false for "compound" states likeFrame.ICONIFIED|Frame.MAXIMIZED_VERT
. In other words, the rule of thumb is that only queries with a single frame state constant as an argument are meaningful.Note that supporting a given concept is a platform- dependent feature. Due to native limitations the Toolkit object may report a particular state as supported, however at the same time the Toolkit object will be unable to apply the state to a given frame. This circumstance has two following consequences:
- Only the return value of
false
for the present method actually indicates that the given state is not supported. If the method returnstrue
the given state may still be unsupported and/or unavailable for a particular frame. - The developer should consider examining the value of the
WindowEvent.getNewState()
method of theWindowEvent
received through theWindowStateListener
, rather than assuming that the state given to thesetExtendedState()
method will be definitely applied. For more information see the documentation for theFrame.setExtendedState(int)
method.
- Parameters:
state
- one of named frame state constants.- Returns:
true
is this frame state is supported by this Toolkit implementation,false
otherwise.- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- Since:
- 1.4
- See Also:
- Only the return value of
-
getProperty
Gets a property with the specified key and default. This method returns defaultValue if the property is not found.- Parameters:
key
- the keydefaultValue
- the default value- Returns:
- the value of the property or the default value if the property was not found
-
getSystemEventQueue
Get the application's or applet's EventQueue instance. Depending on the Toolkit implementation, different EventQueues may be returned for different applets. Applets should therefore not assume that the EventQueue instance returned by this method will be shared by other applets or the system.If there is a security manager then its
checkPermission
method is called to checkAWTPermission("accessEventQueue")
.- Returns:
- the
EventQueue
object - Throws:
SecurityException
- if a security manager is set and it denies access to theEventQueue
- See Also:
-
getSystemEventQueueImpl
Gets the application's or applet'sEventQueue
instance, without checking access. For security reasons, this can only be called from aToolkit
subclass.- Returns:
- the
EventQueue
object
-
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- Type Parameters:
T
- the type of DragGestureRecognizer to create- Parameters:
abstractRecognizerClass
- The abstract class of the required recognizerds
- The DragSourcec
- The Component target for the DragGestureRecognizersrcActions
- The actions permitted for the gesturedgl
- The DragGestureListener- Returns:
- the new object or null. Always returns null if GraphicsEnvironment.isHeadless() returns true.
- See Also:
-
getDesktopProperty
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.- Parameters:
propertyName
- the property name- Returns:
- the value for the specified desktop property
-
setDesktopProperty
-
lazilyLoadDesktopProperty
-
initializeDesktopProperties
protected void initializeDesktopProperties()initializeDesktopProperties -
addPropertyChangeListener
Adds the specified property change listener for the named desktop property. When aPropertyChangeListenerProxy
object is added, its property name is ignored, and the wrapped listener is added. Ifname
isnull
orpcl
isnull
, no exception is thrown and no action is performed.- Parameters:
name
- The name of the property to listen forpcl
- The property change listener- Since:
- 1.2
- See Also:
-
removePropertyChangeListener
Removes the specified property change listener for the named desktop property. When aPropertyChangeListenerProxy
object is removed, its property name is ignored, and the wrapped listener is removed. Ifname
isnull
orpcl
isnull
, no exception is thrown and no action is performed.- Parameters:
name
- The name of the property to removepcl
- The property change listener- Since:
- 1.2
- See Also:
-
getPropertyChangeListeners
Returns an array of all the property change listeners registered on this toolkit. The returned array containsPropertyChangeListenerProxy
objects that associate listeners with the names of desktop properties.- Returns:
- all of this toolkit's
PropertyChangeListener
objects wrapped injava.beans.PropertyChangeListenerProxy
objects or an empty array if no listeners are added - Since:
- 1.4
- See Also:
-
getPropertyChangeListeners
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:
-
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, useWindow.isAlwaysOnTopSupported()
.- Returns:
true
, if current toolkit supports the always-on-top mode, otherwise returnsfalse
- Since:
- 1.6
- See Also:
-
isModalityTypeSupported
Returns whether the given modality type is supported by this toolkit. If a dialog with unsupported modality type is created, thenDialog.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:
-
isModalExclusionTypeSupported
Returns whether the given modal exclusion type is supported by this toolkit. If an unsupported modal exclusion type property is set on a window, thenDialog.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:
-
addAWTEventListener
Adds an AWTEventListener to receive all AWTEvents dispatched system-wide that conform to the giveneventMask
.First, if there is a security manager, its
checkPermission
method is called with anAWTPermission("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 inAWTEvent
.Note: event listener use is not recommended for normal application use, but are intended solely to support special purpose facilities including support for accessibility, event record/playback, and diagnostic tracing. If listener is null, no exception is thrown and no action is performed.
- Parameters:
listener
- the event listener.eventMask
- the bitmask of event types to receive- Throws:
SecurityException
- if a security manager exists and itscheckPermission
method doesn't allow the operation.- Since:
- 1.2
- See Also:
-
removeAWTEventListener
Removes an AWTEventListener from receiving dispatched AWTEvents.First, if there is a security manager, its
checkPermission
method is called with anAWTPermission("listenToAllAWTEvents")
permission. This may result in a SecurityException.Note: event listener use is not recommended for normal application use, but are intended solely to support special purpose facilities including support for accessibility, event record/playback, and diagnostic tracing. If listener is null, no exception is thrown and no action is performed.
- Parameters:
listener
- the event listener.- Throws:
SecurityException
- if a security manager exists and itscheckPermission
method doesn't allow the operation.- Since:
- 1.2
- See Also:
-
getAWTEventListeners
Returns an array of all theAWTEventListener
s registered on this toolkit. If there is a security manager, itscheckPermission
method is called with anAWTPermission("listenToAllAWTEvents")
permission. This may result in a SecurityException. Listeners can be returned withinAWTEventListenerProxy
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
AWTEventListener
s or an empty array if no listeners are currently registered - Throws:
SecurityException
- if a security manager exists and itscheckPermission
method doesn't allow the operation.- Since:
- 1.4
- See Also:
-
getAWTEventListeners
Returns an array of all theAWTEventListener
s registered on this toolkit which listen to all of the event types specified in theeventMask
argument. If there is a security manager, itscheckPermission
method is called with anAWTPermission("listenToAllAWTEvents")
permission. This may result in a SecurityException. Listeners can be returned withinAWTEventListenerProxy
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
AWTEventListener
s 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 itscheckPermission
method doesn't allow the operation.- Since:
- 1.4
- See Also:
-
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
- ifGraphicsEnvironment.isHeadless
returns true- Since:
- 1.3
- See Also:
-
areExtraMouseButtonsEnabled
Reports whether events from extra mouse buttons are allowed to be processed and posted intoEventQueue
.
To change the returned value it is necessary to set thesun.awt.enableExtraMouseButtons
property before theToolkit
class initialization. This setting could be done on the application startup by the following command:java -Dsun.awt.enableExtraMouseButtons=false Application
Alternatively, the property could be set in the application by using the following code:System.setProperty("sun.awt.enableExtraMouseButtons", "true");
before theToolkit
class initialization. If not set by the time of theToolkit
class initialization, this property will be initialized withtrue
. Changing this value after theToolkit
class initialization will have no effect.- 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:
-
GraphicsEnvironment.getAvailableFontFamilyNames()