JApplet (Java 2 Platform SE 5.0) (original) (raw)
javax.swing
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
public class JApplet
extends Applet
implements Accessible, RootPaneContainer
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 withjava.applet.Applet. JApplet contains aJRootPane as its only child. The contentPane should be the parent of any children of the JApplet. As a convenience add 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 the contentPane. The contentPane will always be non-null. Attempting to set it to null will cause theJApplet to throw an exception. The defaultcontentPane 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: 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 see XMLEncoder.
See Also:
| Nested Class Summary | |
|---|---|
| protected class | JApplet.AccessibleJApplet This class implements accessibility support for the JApplet 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.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
| protected AccessibleContext | accessibleContext |
| protected JRootPane | rootPane |
| protected boolean | rootPaneCheckingEnabled If true then calls to add and setLayout will be forwarded to the contentPane. |
| Fields inherited from class java.awt.Component |
|---|
| BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
| ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary |
|---|
| JApplet() Creates a swing applet instance. |
| Method Summary | |
|---|---|
| protected void | [addImpl](../../javax/swing/JApplet.html#addImpl%28java.awt.Component, java.lang.Object, int%29)(Component comp,Object constraints, int index) Adds the specified child Component. |
| 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. |
| 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. |
| protected boolean | isRootPaneCheckingEnabled() Returns whether calls to add and setLayout are forwarded to the contentPane. |
| protected String | paramString() Returns a string representation of this JApplet. |
| void | remove(Component comp) Removes the specified component from the container. |
| 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 the LayoutManager. |
| protected void | setRootPane(JRootPane root) Sets the rootPane property. |
| protected void | setRootPaneCheckingEnabled(boolean enabled) Sets whether calls to add and setLayout are forwarded to the contentPane. |
| void | update(Graphics g) Just calls paint(g). |
| Methods inherited from class java.applet.Applet |
|---|
| destroy, getAppletContext, getAppletInfo, getAudioClip, [getAudioClip](../../java/applet/Applet.html#getAudioClip%28java.net.URL, java.lang.String%29), getCodeBase, getDocumentBase, getImage, [getImage](../../java/applet/Applet.html#getImage%28java.net.URL, java.lang.String%29), getLocale, getParameter, getParameterInfo, init, isActive, newAudioClip, play, [play](../../java/applet/Applet.html#play%28java.net.URL, java.lang.String%29), resize, [resize](../../java/applet/Applet.html#resize%28int, int%29), setStub, showStatus, start, stop |
| Methods inherited from class java.awt.Panel |
|---|
| addNotify |
| Methods inherited from class java.awt.Container |
|---|
| add, [add](../../java/awt/Container.html#add%28java.awt.Component, int%29), [add](../../java/awt/Container.html#add%28java.awt.Component, java.lang.Object%29), [add](../../java/awt/Container.html#add%28java.awt.Component, java.lang.Object, int%29), [add](../../java/awt/Container.html#add%28java.lang.String, java.awt.Component%29), addContainerListener, addPropertyChangeListener, [addPropertyChangeListener](../../java/awt/Container.html#addPropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, [findComponentAt](../../java/awt/Container.html#findComponentAt%28int, int%29), findComponentAt, getAlignmentX, getAlignmentY, getComponent, [getComponentAt](../../java/awt/Container.html#getComponentAt%28int, int%29), getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, [list](../../java/awt/Container.html#list%28java.io.PrintStream, int%29), [list](../../java/awt/Container.html#list%28java.io.PrintWriter, int%29), [locate](../../java/awt/Container.html#locate%28int, int%29), minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, [setComponentZOrder](../../java/awt/Container.html#setComponentZOrder%28java.awt.Component, int%29), setFocusCycleRoot, [setFocusTraversalKeys](../../java/awt/Container.html#setFocusTraversalKeys%28int, java.util.Set%29), setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
|---|
| [action](../../java/awt/Component.html#action%28java.awt.Event, java.lang.Object%29), add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, java.awt.image.ImageObserver%29), [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), [coalesceEvents](../../java/awt/Component.html#coalesceEvents%28java.awt.AWTEvent, java.awt.AWTEvent%29), [contains](../../java/awt/Component.html#contains%28int, int%29), contains, createImage, [createImage](../../java/awt/Component.html#createImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int, java.awt.ImageCapabilities%29), disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, boolean, boolean%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, byte, byte%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, char, char%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, double, double%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, float, float%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, int, int%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, long, long%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, short, short%29), getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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](../../java/awt/Component.html#gotFocus%28java.awt.Event, java.lang.Object%29), handleEvent, hasFocus, hide, [imageUpdate](../../java/awt/Component.html#imageUpdate%28java.awt.Image, int, int, int, int, int%29), [inside](../../java/awt/Component.html#inside%28int, int%29), isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, [keyDown](../../java/awt/Component.html#keyDown%28java.awt.Event, int%29), [keyUp](../../java/awt/Component.html#keyUp%28java.awt.Event, int%29), list, list, list, location, [lostFocus](../../java/awt/Component.html#lostFocus%28java.awt.Event, java.lang.Object%29), [mouseDown](../../java/awt/Component.html#mouseDown%28java.awt.Event, int, int%29), [mouseDrag](../../java/awt/Component.html#mouseDrag%28java.awt.Event, int, int%29), [mouseEnter](../../java/awt/Component.html#mouseEnter%28java.awt.Event, int, int%29), [mouseExit](../../java/awt/Component.html#mouseExit%28java.awt.Event, int, int%29), [mouseMove](../../java/awt/Component.html#mouseMove%28java.awt.Event, int, int%29), [mouseUp](../../java/awt/Component.html#mouseUp%28java.awt.Event, int, int%29), [move](../../java/awt/Component.html#move%28int, int%29), nextFocus, paintAll, postEvent, [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, java.awt.image.ImageObserver%29), [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, [removePropertyChangeListener](../../java/awt/Component.html#removePropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), repaint, [repaint](../../java/awt/Component.html#repaint%28int, int, int, int%29), repaint, [repaint](../../java/awt/Component.html#repaint%28long, int, int, int, int%29), requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, [reshape](../../java/awt/Component.html#reshape%28int, int, int, int%29), setBackground, [setBounds](../../java/awt/Component.html#setBounds%28int, int, int, int%29), setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, [setLocation](../../java/awt/Component.html#setLocation%28int, int%29), setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, [setSize](../../java/awt/Component.html#setSize%28int, int%29), setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle |
| Methods inherited from class java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29) |
| Field Detail |
|---|
rootPane
protected JRootPane rootPane
See Also:
getRootPane(), setRootPane(javax.swing.JRootPane)
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabled
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:
isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean), RootPaneContainer
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](../../java/awt/HeadlessException.html "class in java.awt") - 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.
update
public void update(Graphics g)
Just calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.
Overrides:
[update](../../java/awt/Container.html#update%28java.awt.Graphics%29) in class [Container](../../java/awt/Container.html "class in java.awt")
Parameters:
g - the specified Graphics window
See Also:
setJMenuBar
public void setJMenuBar(JMenuBar menuBar)
Sets the menubar for this applet.
Parameters:
menuBar - the menubar being placed in the applet
See Also:
getJMenuBar
public JMenuBar getJMenuBar()
Returns the menubar set on this applet.
See Also:
setJMenuBar(javax.swing.JMenuBar)
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()
Returns whether calls to add and setLayout are forwarded to the contentPane.
Returns:
true if add and setLayout are fowarded; false otherwise
See Also:
[addImpl(java.awt.Component, java.lang.Object, int)](../../javax/swing/JApplet.html#addImpl%28java.awt.Component, java.lang.Object, int%29), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean), RootPaneContainer
setRootPaneCheckingEnabled
protected void setRootPaneCheckingEnabled(boolean enabled)
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 theJApplet.
See Also:
[addImpl(java.awt.Component, java.lang.Object, int)](../../javax/swing/JApplet.html#addImpl%28java.awt.Component, java.lang.Object, int%29), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled(), RootPaneContainer
addImpl
protected void addImpl(Component comp, Object constraints, int index)
Adds the specified child Component. This method is overridden to conditionally forwad calls to thecontentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.
Overrides:
[addImpl](../../java/awt/Container.html#addImpl%28java.awt.Component, java.lang.Object, int%29) in class [Container](../../java/awt/Container.html "class in java.awt")
Parameters:
comp - the component to be enhanced
constraints - the constraints to be respected
index - the index
Throws:
[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if index is invalid
[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if adding the container's parent to itself
[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - 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 the rootPane, this will forward the call to the contentPane. This will do nothing ifcomp is not a child of the JFrame orcontentPane.
Overrides:
[remove](../../java/awt/Container.html#remove%28java.awt.Component%29) in class [Container](../../java/awt/Container.html "class in java.awt")
Parameters:
comp - the component to be removed
Throws:
[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if comp is null
See Also:
Container.add(java.awt.Component), RootPaneContainer
setLayout
public void setLayout(LayoutManager manager)
Sets the LayoutManager. Overridden to conditionally forward the call to thecontentPane. Refer to RootPaneContainer for more information.
Overrides:
[setLayout](../../java/awt/Container.html#setLayout%28java.awt.LayoutManager%29) in class [Container](../../java/awt/Container.html "class in java.awt")
Parameters:
manager - the LayoutManager
See Also:
setRootPaneCheckingEnabled(boolean), RootPaneContainer
getRootPane
public JRootPane getRootPane()
Returns the rootPane object for this applet.
Specified by:
[getRootPane](../../javax/swing/RootPaneContainer.html#getRootPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
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:
getContentPane
public Container getContentPane()
Returns the contentPane object for this applet.
Specified by:
[getContentPane](../../javax/swing/RootPaneContainer.html#getContentPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
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](../../javax/swing/RootPaneContainer.html#setContentPane%28java.awt.Container%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
Parameters:
contentPane - the contentPane object for this applet
Throws:
[IllegalComponentStateException](../../java/awt/IllegalComponentStateException.html "class in java.awt") - (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](../../javax/swing/RootPaneContainer.html#getLayeredPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
Returns:
the value of the layeredPane property.
Throws:
[IllegalComponentStateException](../../java/awt/IllegalComponentStateException.html "class in java.awt") - (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](../../javax/swing/RootPaneContainer.html#setLayeredPane%28javax.swing.JLayeredPane%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
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](../../javax/swing/RootPaneContainer.html#getGlassPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
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](../../javax/swing/RootPaneContainer.html#setGlassPane%28java.awt.Component%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")
Parameters:
glassPane - the glassPane object for this applet
See Also:
getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)
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 be null.
Overrides:
[paramString](../../java/awt/Container.html#paramString%28%29) in class [Container](../../java/awt/Container.html "class in java.awt")
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](../../javax/accessibility/Accessible.html#getAccessibleContext%28%29) in interface [Accessible](../../javax/accessibility/Accessible.html "interface in javax.accessibility")
Overrides:
[getAccessibleContext](../../java/applet/Applet.html#getAccessibleContext%28%29) in class [Applet](../../java/applet/Applet.html "class in java.applet")
Returns:
an AccessibleJApplet that serves as the AccessibleContext of this JApplet
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.