W3cubDocs

/OpenJDK 21

Class JApplet

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Panel
java.applet.Applet
javax.swing.JApplet
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer 
@Deprecated(since="9", forRemoval=true) @JavaBean(defaultProperty="JMenuBar", description="Swing\'s Applet subclass.") public class JApplet extends Applet implements Accessible, RootPaneContainer
Deprecated, for removal: This API element is subject to removal in a future version.
The Applet API is deprecated, no replacement.
An extended version of java.applet.Applet that adds support for the JFC/Swing component architecture. You can find task-oriented documentation about using JApplet in The Java Tutorial, in the section How to Make Applets.

The JApplet class is slightly incompatible with java.applet.Applet. JApplet contains a JRootPane as its only child. The contentPane should be the parent of any children of the JApplet. As a convenience, the add, remove, and setLayout methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane. For example, you can add a child component to an applet as follows: 

       applet.add(child);
And the child will be added to the contentPane. The contentPane will always be non-null. Attempting to set it to null will cause the JApplet to throw an exception. The default contentPane will have a BorderLayout manager set on it. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JApplet.

Please see the JRootPane documentation for a complete description of the contentPane, glassPane, and layeredPane properties.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
See Also:

Nested Class Summary

Modifier and Type Class Description
protected class  JApplet.AccessibleJApplet
Deprecated, for removal: This API element is subject to removal in a future version.
This class implements accessibility support for the JApplet class.

Nested classes/interfaces declared in class java.applet.Applet

Applet.AccessibleApplet

Nested classes/interfaces declared in class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces declared in class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces declared in class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Modifier and Type Field Description
protected AccessibleContext accessibleContext
Deprecated, for removal: This API element is subject to removal in a future version.
AccessibleContext associated with this JApplet
protected JRootPane rootPane
Deprecated, for removal: This API element is subject to removal in a future version.
The JRootPane instance that manages the contentPane.
protected boolean rootPaneCheckingEnabled
Deprecated, for removal: This API element is subject to removal in a future version.
If true then calls to add and setLayout will be forwarded to the contentPane.

Fields declared in class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields declared in interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructor Description
JApplet()
Deprecated, for removal: This API element is subject to removal in a future version.
Creates a swing applet instance.

Method Summary

Modifier and Type Method Description
protected void addImpl(Component comp, Object constraints, int index)
Deprecated, for removal: This API element is subject to removal in a future version.
Adds the specified child Component.
protected JRootPane createRootPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Called by the constructor methods to create the default rootPane.
AccessibleContext getAccessibleContext()
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the AccessibleContext associated with this JApplet.
Container getContentPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the contentPane object for this applet.
Component getGlassPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the glassPane object for this applet.
Graphics getGraphics()
Deprecated, for removal: This API element is subject to removal in a future version.
Creates a graphics context for this component.
JMenuBar getJMenuBar()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the menubar set on this applet.
JLayeredPane getLayeredPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the layeredPane object for this applet.
JRootPane getRootPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the rootPane object for this applet.
TransferHandler getTransferHandler()
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the transferHandler property.
protected boolean isRootPaneCheckingEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns whether calls to add and setLayout are forwarded to the contentPane.
protected String paramString()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a string representation of this JApplet.
void remove(Component comp)
Deprecated, for removal: This API element is subject to removal in a future version.
Removes the specified component from the container.
void repaint(long time, int x, int y, int width, int height)
Deprecated, for removal: This API element is subject to removal in a future version.
Repaints the specified rectangle of this component within time milliseconds.
void setContentPane(Container contentPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the contentPane property.
void setGlassPane(Component glassPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the glassPane property.
void setJMenuBar(JMenuBar menuBar)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the menubar for this applet.
void setLayeredPane(JLayeredPane layeredPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the layeredPane property.
void setLayout(LayoutManager manager)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the LayoutManager.
protected void setRootPane(JRootPane root)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the rootPane property.
protected void setRootPaneCheckingEnabled(boolean enabled)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets whether calls to add and setLayout are forwarded to the contentPane.
void setTransferHandler(TransferHandler newHandler)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the transferHandler property, which is a mechanism to support transfer of data into this component.
void update(Graphics g)
Deprecated, for removal: This API element is subject to removal in a future version.
Just calls paint(g).

Methods declared in class java.applet.Applet

destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, init, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop

Methods declared in class java.awt.Panel

addNotify

Methods declared in class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods declared in class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

rootPane

protected JRootPane rootPane
Deprecated, for removal: This API element is subject to removal in a future version.
The JRootPane instance that manages the contentPane.
See Also:

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled
Deprecated, for removal: This API element is subject to removal in a future version.
If true then calls to add and setLayout will be forwarded to the contentPane. This is initially false, but is set to true when the JApplet is constructed.
See Also:

accessibleContext

protected AccessibleContext accessibleContext
Deprecated, for removal: This API element is subject to removal in a future version.
AccessibleContext associated with this JApplet

Constructor Details

JApplet

public JApplet() throws HeadlessException
Deprecated, for removal: This API element is subject to removal in a future version.
Creates a swing applet instance.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Throws:
HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
See Also:

Method Details

createRootPane

protected JRootPane createRootPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Called by the constructor methods to create the default rootPane.
Returns:
a new JRootPane

setTransferHandler

@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") public void setTransferHandler(TransferHandler newHandler)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the transferHandler property, which is a mechanism to support transfer of data into this component. Use null if the component does not support data transfer operations.

If the system property suppressSwingDropSupport is false (the default) and the current drop target on this component is either null or not a user-set drop target, this method will change the drop target as follows: If newHandler is null it will clear the drop target. If not null it will install a new DropTarget.

Note: When used with JApplet, TransferHandler only provides data import capability, as the data export related methods are currently typed to JComponent.

Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

Parameters:
newHandler - the new TransferHandler
Since:
1.6
See Also:

getTransferHandler

public TransferHandler getTransferHandler()
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the transferHandler property.
Returns:
the value of the transferHandler property
Since:
1.6
See Also:

update

public void update(Graphics g)
Deprecated, for removal: This API element is subject to removal in a future version.
Just calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.
Overrides:
update in class Container
Parameters:
g - the specified Graphics window
See Also:

setJMenuBar

@BeanProperty(bound=false, hidden=true, description="The menubar for accessing pulldown menus from this applet.") public void setJMenuBar(JMenuBar menuBar)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the menubar for this applet.
Parameters:
menuBar - the menubar being placed in the applet
See Also:

getJMenuBar

public JMenuBar getJMenuBar()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the menubar set on this applet.
Returns:
the menubar set on this applet
See Also:

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns whether calls to add and setLayout are forwarded to the contentPane.
Returns:
true if add and setLayout are forwarded; false otherwise
See Also:

setRootPaneCheckingEnabled

@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets whether calls to add and setLayout are forwarded to the contentPane.
Parameters:
enabled - true if add and setLayout are forwarded, false if they should operate directly on the JApplet.
See Also:

addImpl

protected void addImpl(Component comp, Object constraints, int index)
Deprecated, for removal: This API element is subject to removal in a future version.
Adds the specified child Component. This method is overridden to conditionally forward calls to the contentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.
Overrides:
addImpl in class Container
Parameters:
comp - the component to be enhanced
constraints - the constraints to be respected
index - the index
Throws:
IllegalArgumentException - if index is invalid
IllegalArgumentException - if adding the container's parent to itself
IllegalArgumentException - if adding a window to a container
See Also:

remove

public void remove(Component comp)
Deprecated, for removal: This API element is subject to removal in a future version.
Removes the specified component from the container. If comp is not the rootPane, this will forward the call to the contentPane. This will do nothing if comp is not a child of the JFrame or contentPane.
Overrides:
remove in class Container
Parameters:
comp - the component to be removed
Throws:
NullPointerException - if comp is null
See Also:

setLayout

public void setLayout(LayoutManager manager)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.
Overrides:
setLayout in class Container
Parameters:
manager - the LayoutManager
See Also:

getRootPane

@BeanProperty(bound=false, hidden=true, description="the RootPane object for this applet.") public JRootPane getRootPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the rootPane object for this applet.
Specified by:
getRootPane in interface RootPaneContainer
Returns:
this components single JRootPane child.
See Also:

setRootPane

protected void setRootPane(JRootPane root)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the rootPane property. This method is called by the constructor.
Parameters:
root - the rootPane object for this applet
See Also:

getContentPane

public Container getContentPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the contentPane object for this applet.
Specified by:
getContentPane in interface RootPaneContainer
Returns:
the value of the contentPane property.
See Also:

setContentPane

@BeanProperty(bound=false, hidden=true, description="The client area of the applet where child components are normally inserted.") public void setContentPane(Container contentPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the contentPane property. This method is called by the constructor.
Specified by:
setContentPane in interface RootPaneContainer
Parameters:
contentPane - the contentPane object for this applet
Throws:
IllegalComponentStateException - (a runtime exception) if the content pane parameter is null
See Also:

getLayeredPane

public JLayeredPane getLayeredPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the layeredPane object for this applet.
Specified by:
getLayeredPane in interface RootPaneContainer
Returns:
the value of the layeredPane property.
Throws:
IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null
See Also:

setLayeredPane

@BeanProperty(bound=false, hidden=true, description="The pane which holds the various applet layers.") public void setLayeredPane(JLayeredPane layeredPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the layeredPane property. This method is called by the constructor.
Specified by:
setLayeredPane in interface RootPaneContainer
Parameters:
layeredPane - the layeredPane object for this applet
See Also:

getGlassPane

public Component getGlassPane()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the glassPane object for this applet.
Specified by:
getGlassPane in interface RootPaneContainer
Returns:
the value of the glassPane property.
See Also:

setGlassPane

@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane)
Deprecated, for removal: This API element is subject to removal in a future version.
Sets the glassPane property. This method is called by the constructor.
Specified by:
setGlassPane in interface RootPaneContainer
Parameters:
glassPane - the glassPane object for this applet
See Also:

getGraphics

@BeanProperty(bound=false) public Graphics getGraphics()
Deprecated, for removal: This API element is subject to removal in a future version.
Creates a graphics context for this component. This method will return null if this component is currently not displayable.
Overrides:
getGraphics in class Component
Returns:
a graphics context for this component, or null if it has none
Since:
1.6
See Also:

repaint

public void repaint(long time, int x, int y, int width, int height)
Deprecated, for removal: This API element is subject to removal in a future version.
Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.
Overrides:
repaint in class Component
Parameters:
time - maximum time in milliseconds before update
x - the x coordinate
y - the y coordinate
width - the width
height - the height
Since:
1.6
See Also:

paramString

protected String paramString()
Deprecated, for removal: This API element is subject to removal in a future version.
Returns a string representation of this JApplet. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
Overrides:
paramString in class Container
Returns:
a string representation of this JApplet.

getAccessibleContext

public AccessibleContext getAccessibleContext()
Deprecated, for removal: This API element is subject to removal in a future version.
Gets the AccessibleContext associated with this JApplet. For JApplets, the AccessibleContext takes the form of an AccessibleJApplet. A new AccessibleJApplet instance is created if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class Applet
Returns:
an AccessibleJApplet that serves as the AccessibleContext of this JApplet

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JApplet.html