|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Panel
java.applet.Applet
javax.swing.JApplet
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 it's only child. The contentPane should be the parent of any children of the JApplet. This is different than java.applet.Applet, e.g. to add a child to an an java.applet.Applet you'd write:
applet.add(child);
However using JApplet you need to add the child to the JApplet's contentPane
instead:
applet.getContentPane().add(child);
The same is true for setting LayoutManagers, removing components,
listing children, etc. All these methods should normally be sent to
the contentPane() instead of the JApplet itself. 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.
Please see the JRootPane documentation for a complete description of the contentPane, glassPane, and layeredPane properties.
For the keyboard keys used by this component in the standard Look and
Feel (L&F) renditions, see the
JApplet key assignments.
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.
| Nested Class Summary | |
protected class |
JApplet.AccessibleJApplet
This class implements accessibility support for the JApplet class. |
| Nested classes inherited from class java.applet.Applet |
Applet.AccessibleApplet |
| Nested classes inherited from class java.awt.Panel |
Panel.AccessibleAWTPanel |
| Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
protected AccessibleContext |
accessibleContext
|
protected JRootPane |
rootPane
|
protected boolean |
rootPaneCheckingEnabled
|
| 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(Component comp,
Object constraints,
int index)
By default, children may not be added directly to a this component, they must be added to its contentPane instead. |
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()
|
protected String |
paramString()
Returns a string representation of this JApplet. |
void |
remove(Component comp)
Removes the specified component from this 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)
By default the layout of this component may not be set, the layout of its contentPane should be set instead. |
protected void |
setRootPane(JRootPane root)
Sets the rootPane property. |
protected void |
setRootPaneCheckingEnabled(boolean enabled)
If true then calls to add() and setLayout() will cause an exception to be thrown. |
void |
update(Graphics g)
Just calls paint(g). |
| Methods inherited from class java.applet.Applet |
destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, init, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop |
| Methods inherited from class java.awt.Panel |
addNotify |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
protected JRootPane rootPane
getRootPane(),
setRootPane(javax.swing.JRootPane)protected boolean rootPaneCheckingEnabled
isRootPaneCheckingEnabled(),
setRootPaneCheckingEnabled(boolean)protected AccessibleContext accessibleContext
| Constructor Detail |
public JApplet()
throws HeadlessException
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()| Method Detail |
protected JRootPane createRootPane()
public void update(Graphics g)
paint(g). This method was overridden to
prevent an unnecessary call to clear the background.
update in class Containerg - the specified Graphics windowComponent.update(Graphics)public void setJMenuBar(JMenuBar menuBar)
menuBar - the menubar being placed in the appletgetJMenuBar()public JMenuBar getJMenuBar()
setJMenuBar(javax.swing.JMenuBar)protected boolean isRootPaneCheckingEnabled()
addImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
setRootPaneCheckingEnabled(boolean)protected void setRootPaneCheckingEnabled(boolean enabled)
addImpl(java.awt.Component, java.lang.Object, int),
setLayout(java.awt.LayoutManager),
isRootPaneCheckingEnabled()
protected void addImpl(Component comp,
Object constraints,
int index)
thiComponent.getContentPane().add(child)An attempt to add to directly to this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.
addImpl in class Containercomp - the component to be addedconstraints - an object expressing layout constraints
for this componentindex - the position in the container's list at which to
insert the component, where -1
means append to the end
Error - if called with rootPaneChecking truesetRootPaneCheckingEnabled(boolean)public void remove(Component comp)
remove in class Containercomp - the component to be removedContainer.add(java.awt.Component)public void setLayout(LayoutManager manager)
thisComponent.getContentPane().setLayout(new GridLayout(1, 2))An attempt to set the layout of this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.
setLayout in class Containermanager - the specified layout manager
Error - if called with rootPaneChecking truesetRootPaneCheckingEnabled(boolean)public JRootPane getRootPane()
getRootPane in interface RootPaneContainersetRootPane(javax.swing.JRootPane),
RootPaneContainer.getRootPane()protected void setRootPane(JRootPane root)
root - the rootPane object for this appletgetRootPane()public Container getContentPane()
getContentPane in interface RootPaneContainersetContentPane(java.awt.Container),
RootPaneContainer.getContentPane()public void setContentPane(Container contentPane)
setContentPane in interface RootPaneContainercontentPane - the contentPane object for this applet
IllegalComponentStateException - (a runtime
exception) if the content pane parameter is nullgetContentPane(),
RootPaneContainer.setContentPane(java.awt.Container)public JLayeredPane getLayeredPane()
getLayeredPane in interface RootPaneContainerIllegalComponentStateException - (a runtime
exception) if the layered pane parameter is nullsetLayeredPane(javax.swing.JLayeredPane),
RootPaneContainer.getLayeredPane()public void setLayeredPane(JLayeredPane layeredPane)
setLayeredPane in interface RootPaneContainerlayeredPane - the layeredPane object for this appletgetLayeredPane(),
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)public Component getGlassPane()
getGlassPane in interface RootPaneContainersetGlassPane(java.awt.Component),
RootPaneContainer.getGlassPane()public void setGlassPane(Component glassPane)
setGlassPane in interface RootPaneContainerglassPane - the glassPane object for this appletgetGlassPane(),
RootPaneContainer.setGlassPane(java.awt.Component)protected String paramString()
null.
paramString in class Containerpublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class Applet
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.