- 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
public class JApplet extends Applet implements Accessible, RootPaneContainer
An extended version ofjava.applet.Applet
that adds support for the JFC/Swing component architecture. You can find task-oriented documentation about usingJApplet
in The Java Tutorial, in the section How to Make Applets.The
JApplet
class is slightly incompatible withjava.applet.Applet
.JApplet
contains aJRootPane
as its only child. ThecontentPane
should be the parent of any children of theJApplet
. As a convenienceadd
and its variants,remove
andsetLayout
have been overridden to forward to thecontentPane
as necessary. This means you can write:applet.add(child);
And the child will be added to thecontentPane
. ThecontentPane
will always be non-null
. Attempting to set it tonull
will cause theJApplet
to throw an exception. The defaultcontentPane
will have aBorderLayout
manager set on it. Refer toRootPaneContainer
for details on adding, removing and setting theLayoutManager
of aJApplet
.Please see the
JRootPane
documentation for a complete description of thecontentPane
,glassPane
, andlayeredPane
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 JavaBeansTM has been added to the
java.beans
package. Please seeXMLEncoder
.- See Also:
RootPaneContainer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected class
JApplet.AccessibleJApplet
This class implements accessibility support for theJApplet
class.-
Nested classes/interfaces inherited from class java.applet.Applet
Applet.AccessibleApplet
-
Nested classes/interfaces inherited from class java.awt.Panel
Panel.AccessibleAWTPanel
-
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
Fields Modifier and Type Field and Description protected AccessibleContext
accessibleContext
protected JRootPane
rootPane
protected boolean
rootPaneCheckingEnabled
If true then calls toadd
andsetLayout
will be forwarded to thecontentPane
.-
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
-
-
Constructor Summary
Constructors Constructor and Description JApplet()
Creates a swing applet instance.
-
Method Summary
Methods Modifier and Type Method and Description protected void
addImpl(Component comp, Object constraints, int index)
Adds the specified childComponent
.protected JRootPane
createRootPane()
Called by the constructor methods to create the default rootPane.AccessibleContext
getAccessibleContext()
Gets the AccessibleContext associated with this JApplet.Container
getContentPane()
Returns the contentPane object for this applet.Component
getGlassPane()
Returns the glassPane object for this applet.Graphics
getGraphics()
Creates a graphics context for this component.JMenuBar
getJMenuBar()
Returns the menubar set on this applet.JLayeredPane
getLayeredPane()
Returns the layeredPane object for this applet.JRootPane
getRootPane()
Returns the rootPane object for this applet.TransferHandler
getTransferHandler()
Gets thetransferHandler
property.protected boolean
isRootPaneCheckingEnabled()
Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.protected String
paramString()
Returns a string representation of this JApplet.void
remove(Component comp)
Removes the specified component from the container.void
repaint(long time, int x, int y, int width, int height)
Repaints the specified rectangle of this component withintime
milliseconds.void
setContentPane(Container contentPane)
Sets the contentPane property.void
setGlassPane(Component glassPane)
Sets the glassPane property.void
setJMenuBar(JMenuBar menuBar)
Sets the menubar for this applet.void
setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property.void
setLayout(LayoutManager manager)
Sets theLayoutManager
.protected void
setRootPane(JRootPane root)
Sets the rootPane property.protected void
setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.void
setTransferHandler(TransferHandler newHandler)
Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component.void
update(Graphics g)
Just callspaint(g)
.-
Methods inherited from 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 inherited from class java.awt.Panel
addNotify
-
Methods inherited from 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 inherited from 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
rootPane
protected JRootPane rootPane
-
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabled
If true then calls toadd
andsetLayout
will be forwarded to thecontentPane
. This is initially false, but is set to true when theJApplet
is constructed.
-
accessibleContext
protected AccessibleContext accessibleContext
-
-
Constructor Detail
-
JApplet
public JApplet() throws HeadlessException
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:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
-
Method Detail
-
createRootPane
protected JRootPane createRootPane()
Called by the constructor methods to create the default rootPane.
-
setTransferHandler
public void setTransferHandler(TransferHandler newHandler)
Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component. Usenull
if the component does not support data transfer operations.If the system property
suppressSwingDropSupport
isfalse
(the default) and the current drop target on this component is eithernull
or not a user-set drop target, this method will change the drop target as follows: IfnewHandler
isnull
it will clear the drop target. If notnull
it will install a newDropTarget
.Note: When used with
JApplet
,TransferHandler
only provides data import capability, as the data export related methods are currently typed toJComponent
.Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.
- Parameters:
newHandler
- the newTransferHandler
- Since:
- 1.6
- See Also:
TransferHandler
,getTransferHandler()
,Component.setDropTarget(java.awt.dnd.DropTarget)
-
getTransferHandler
public TransferHandler getTransferHandler()
Gets thetransferHandler
property.- Returns:
- the value of the
transferHandler
property - Since:
- 1.6
- See Also:
TransferHandler
,setTransferHandler(javax.swing.TransferHandler)
-
update
public void update(Graphics g)
Just callspaint(g)
. This method was overridden to prevent an unnecessary call to clear the background.- Overrides:
update
in classContainer
- Parameters:
g
- the specified Graphics window- See Also:
Component.update(Graphics)
-
setJMenuBar
public void setJMenuBar(JMenuBar menuBar)
Sets the menubar for this applet.- Parameters:
menuBar
- the menubar being placed in the applet- See Also:
getJMenuBar()
-
getJMenuBar
public JMenuBar getJMenuBar()
Returns the menubar set on this applet.- See Also:
setJMenuBar(javax.swing.JMenuBar)
-
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()
Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Returns:
- true if
add
andsetLayout
are fowarded; false otherwise - See Also:
addImpl(java.awt.Component, java.lang.Object, int)
,setLayout(java.awt.LayoutManager)
,setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
setRootPaneCheckingEnabled
protected void setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Parameters:
enabled
- true ifadd
andsetLayout
are forwarded, false if they should operate directly on theJApplet
.- See Also:
addImpl(java.awt.Component, java.lang.Object, int)
,setLayout(java.awt.LayoutManager)
,isRootPaneCheckingEnabled()
,RootPaneContainer
-
addImpl
protected void addImpl(Component comp, Object constraints, int index)
Adds the specified childComponent
. This method is overridden to conditionally forward calls to thecontentPane
. By default, children are added to thecontentPane
instead of the frame, refer toRootPaneContainer
for details.- Overrides:
addImpl
in classContainer
- Parameters:
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the index- Throws:
IllegalArgumentException
- ifindex
is invalidIllegalArgumentException
- if adding the container's parent to itselfIllegalArgumentException
- if adding a window to a container- See Also:
setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
remove
public void remove(Component comp)
Removes the specified component from the container. Ifcomp
is not therootPane
, this will forward the call to thecontentPane
. This will do nothing ifcomp
is not a child of theJFrame
orcontentPane
.- Overrides:
remove
in classContainer
- Parameters:
comp
- the component to be removed- Throws:
NullPointerException
- ifcomp
is null- See Also:
Container.add(java.awt.Component)
,RootPaneContainer
-
setLayout
public void setLayout(LayoutManager manager)
Sets theLayoutManager
. Overridden to conditionally forward the call to thecontentPane
. Refer toRootPaneContainer
for more information.- Overrides:
setLayout
in classContainer
- Parameters:
manager
- theLayoutManager
- See Also:
setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
getRootPane
public JRootPane getRootPane()
Returns the rootPane object for this applet.- Specified by:
getRootPane
in interfaceRootPaneContainer
- Returns:
- this components single JRootPane child.
- See Also:
setRootPane(javax.swing.JRootPane)
,RootPaneContainer.getRootPane()
-
setRootPane
protected void setRootPane(JRootPane root)
Sets the rootPane property. This method is called by the constructor.- Parameters:
root
- the rootPane object for this applet- See Also:
getRootPane()
-
getContentPane
public Container getContentPane()
Returns the contentPane object for this applet.- Specified by:
getContentPane
in interfaceRootPaneContainer
- Returns:
- the value of the contentPane property.
- See Also:
setContentPane(java.awt.Container)
,RootPaneContainer.getContentPane()
-
setContentPane
public void setContentPane(Container contentPane)
Sets the contentPane property. This method is called by the constructor.- Specified by:
setContentPane
in interfaceRootPaneContainer
- Parameters:
contentPane
- the contentPane object for this applet- Throws:
IllegalComponentStateException
- (a runtime exception) if the content pane parameter is null- See Also:
getContentPane()
,RootPaneContainer.setContentPane(java.awt.Container)
-
getLayeredPane
public JLayeredPane getLayeredPane()
Returns the layeredPane object for this applet.- Specified by:
getLayeredPane
in interfaceRootPaneContainer
- Returns:
- the value of the layeredPane property.
- Throws:
IllegalComponentStateException
- (a runtime exception) if the layered pane parameter is null- See Also:
setLayeredPane(javax.swing.JLayeredPane)
,RootPaneContainer.getLayeredPane()
-
setLayeredPane
public void setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property. This method is called by the constructor.- Specified by:
setLayeredPane
in interfaceRootPaneContainer
- Parameters:
layeredPane
- the layeredPane object for this applet- See Also:
getLayeredPane()
,RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
-
getGlassPane
public Component getGlassPane()
Returns the glassPane object for this applet.- Specified by:
getGlassPane
in interfaceRootPaneContainer
- Returns:
- the value of the glassPane property.
- See Also:
setGlassPane(java.awt.Component)
,RootPaneContainer.getGlassPane()
-
setGlassPane
public void setGlassPane(Component glassPane)
Sets the glassPane property. This method is called by the constructor.- Specified by:
setGlassPane
in interfaceRootPaneContainer
- Parameters:
glassPane
- the glassPane object for this applet- See Also:
getGlassPane()
,RootPaneContainer.setGlassPane(java.awt.Component)
-
getGraphics
public Graphics getGraphics()
Creates a graphics context for this component. This method will returnnull
if this component is currently not displayable.- Overrides:
getGraphics
in classComponent
- Returns:
- a graphics context for this component, or
null
if it has none - Since:
- 1.6
- See Also:
Component.paint(java.awt.Graphics)
-
repaint
public void repaint(long time, int x, int y, int width, int height)
Repaints the specified rectangle of this component withintime
milliseconds. Refer toRepaintManager
for details on how the repaint is handled.- Overrides:
repaint
in classComponent
- Parameters:
time
- maximum time in milliseconds before updatex
- the x coordinatey
- the y coordinatewidth
- the widthheight
- the height- Since:
- 1.6
- See Also:
RepaintManager
-
paramString
protected String paramString()
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 benull
.- Overrides:
paramString
in classContainer
- Returns:
- a string representation of this JApplet.
-
getAccessibleContext
public AccessibleContext getAccessibleContext()
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 interfaceAccessible
- Overrides:
getAccessibleContext
in classApplet
- Returns:
- an AccessibleJApplet that serves as the AccessibleContext of this JApplet
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/JApplet.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.