All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.JApplet

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.Panel
                            |
                            +----java.applet.Applet
                                    |
                                    +----java.awt.swing.JApplet

public class JApplet
extends Applet
An extended version of java.applet.Applet that adds support for interposing input and painting behavior in front of the applets children (see glassPane), support for special children that are managed by a LayeredPane (see rootPane) and for Swing MenuBars.

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.


Variable Index

 o accessibleDescription
 o accessibleName
 o rootPane

Constructor Index

 o JApplet()

Method Index

 o addAccessibleSelection(int)
Adds the nth selected item in the object to the object's selection.
 o addNotify()
Creates the Panel's peer.
 o clearAccessibleSelection()
Clears the selection in the object, so that nothing in the object is selected.
 o createRootPane()
Called by the constructor methods to create the default rootPane.
 o doAccessibleAction(int)
Perform the nth Action on the object
 o getAccessibleActionCount()
Returns the number of Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").
 o getAccessibleActionDescription(int)
Return a description of the nth action of the object.
 o getAccessibleAt(Point)
Returns the Accessible child contained at the local coordinate Point, if one exists.
 o getAccessibleChild(int)
Return the nth Accessible child of the object.
 o getAccessibleChildrenCount()
Returns the number of accessible children in the object.
 o getAccessibleDescription()
Get the accessible description of this object.
 o getAccessibleName()
Get the accessible name of this object.
 o getAccessibleParent()
Get the Accessible parent of this object.
 o getAccessibleRole()
Get the role of this object.
 o getAccessibleSelection(int)
Returns an Accessible representing the nth selected item in the object.
 o getAccessibleSelectionCount()
Returns the number of items currently selected.
 o getAccessibleStateSet()
Get the state of this object.
 o getAccessibleText()
Gets the AccessibleText interface for the component.
 o getAccessibleValue()
Get the value of this object as a Number.
 o getContentPane()
 o getGlassPane()
 o getJMenuBar()
 o getLayeredPane()
 o getMaximumAccessibleValue()
Get the maximum value of this object as a Number.
 o getMinimumAccessibleValue()
Get the minimum value of this object as a Number.
 o getNextAccessibleSibling()
Get the next sibling of this Accessible, if a preferred one exists.
 o getPreviousAccessibleSibling()
Get the previous sibling of this Accessible, if a preferred one exists.
 o getRootPane()
 o processKeyEvent(KeyEvent)
Processes key events occurring on this component by dispatching them to any registered objects.
 o removeAccessibleSelection(int)
Removes the nth selected item in the object from the object's selection.
 o selectAllAccessibleSelection()
Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).
 o setAccessibleDescription(String)
Set the accessible description of this object.
 o setAccessibleName(String)
Set the localized accessible name of this object.
 o setAccessibleValue(Number)
Get the value of this object as a Number.
 o setContentPane(Container)
 o setGlassPane(Component)
 o setJMenuBar(JMenuBar)
Overrided to not paint the background
 o setLayeredPane(JLayeredPane)
 o setRootPane(JRootPane)

Variables

 o rootPane
protected JRootPane rootPane
 o accessibleName
protected String accessibleName
 o accessibleDescription
protected String accessibleDescription

Constructors

 o JApplet
public JApplet()

Methods

 o addNotify
public void addNotify()
Creates the Panel's peer.

Overrides:
addNotify in class Panel
 o createRootPane
protected JRootPane createRootPane()
Called by the constructor methods to create the default rootPane.

 o processKeyEvent
protected void processKeyEvent(KeyEvent e)
Processes key events occurring on this component by dispatching them to any registered objects.

Overrides:
processKeyEvent in class Component
 o setJMenuBar
public void setJMenuBar(JMenuBar menu)
Overrided to not paint the background

 o getJMenuBar
public JMenuBar getJMenuBar()
 o setContentPane
public void setContentPane(Container content)
 o getContentPane
public Container getContentPane()
 o setLayeredPane
public void setLayeredPane(JLayeredPane layered)
 o getLayeredPane
public JLayeredPane getLayeredPane()
 o setGlassPane
public void setGlassPane(Component glass)
 o getGlassPane
public Component getGlassPane()
 o setRootPane
protected void setRootPane(JRootPane root)
 o getRootPane
public JRootPane getRootPane()
 o getNextAccessibleSibling
public Accessible getNextAccessibleSibling()
Get the next sibling of this Accessible, if a preferred one exists. This should generally return the next item in the tab order, if that item implements Accessible

Returns:
the next Accessible, if there is one
 o getPreviousAccessibleSibling
public Accessible getPreviousAccessibleSibling()
Get the previous sibling of this Accessible, if a preferred one exists. This should generally return the previous item in the tab order, if that item implements Accessible

Returns:
the previous Accessible, if there is one
 o getAccessibleAt
public Accessible getAccessibleAt(Point p)
Returns the Accessible child contained at the local coordinate Point, if one exists.

Returns:
the Accessible at the specified location, if it exists
 o getAccessibleName
public String getAccessibleName()
Get the accessible name of this object. This should almost never return java.awt.Component.getName(), as that generally isn't a localized name, and doesn't have meaning for the user. If the object is fundamentally a text object (e.g. a menu item), the accessible name should be the text of the object (e.g. "save"). If the object has a tooltip, the tooltip text may also be an appropriate String to return.

Returns:
the localized name of the object -- can be null if this object does not have a name
See Also:
setAccessibleName
 o setAccessibleName
public void setAccessibleName(String s)
Set the localized accessible name of this object.

Parameters:
s - the new localized name of the object.
See Also:
getAccessibleName
 o getAccessibleDescription
public String getAccessibleDescription()
Get the accessible description of this object. This should be a concise, localized description of what this object is - what is it's meaning to the user. If the object has a tooltip, the tooltip text may be an appropriate string to return, assuming it contains a concise description of the object (instead of just the name of the object - e.g. a "Save" icon on a toolbar that had "save" as the tooltip text shouldn't return the tooltip text as the description, but something like "Saves the current text document" instead).

Returns:
the localized description of the object -- can be null if this object does not have a description
See Also:
setAccessibleDescription
 o setAccessibleDescription
public void setAccessibleDescription(String s)
Set the accessible description of this object.

Parameters:
s - the new localized description of the object
See Also:
getAccessibleDescription
 o getAccessibleStateSet
public AccessibleStateSet getAccessibleStateSet()
Get the state of this object.

Returns:
an instance of AccessibleStateSet containing the current state set of the object
See Also:
AccessibleState
 o getAccessibleRole
public AccessibleRole getAccessibleRole()
Get the role of this object.

Returns:
an instance of AccessibleRole describing the role of the object
See Also:
AccessibleRole
 o getAccessibleValue
public Number getAccessibleValue()
Get the value of this object as a Number.

Returns:
value of the object -- can be null if this object does not have a value
 o setAccessibleValue
public boolean setAccessibleValue(Number n)
Get the value of this object as a Number.

Returns:
value of the object -- can be null if this object does not have a value
 o getMinimumAccessibleValue
public Number getMinimumAccessibleValue()
Get the minimum value of this object as a Number.

Returns:
Minimum value of the object; null if this object does not have a minimum value
 o getMaximumAccessibleValue
public Number getMaximumAccessibleValue()
Get the maximum value of this object as a Number.

Returns:
Maximum value of the object; null if this object does not have a maximum value
 o getAccessibleParent
public Accessible getAccessibleParent()
Get the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent().

Returns:
the Accessible parent of this object -- can be null if this object does not have an Accessible parent
 o getAccessibleChildrenCount
public int getAccessibleChildrenCount()
Returns the number of accessible children in the object. If all of the children of this object implement Accessible, than this method should return the number of children of this object.

Returns:
the number of accessible children in the object.
 o getAccessibleChild
public Accessible getAccessibleChild(int i)
Return the nth Accessible child of the object.

Parameters:
i - zero-based index of child
Returns:
the nth Accessible child of the object
 o getAccessibleActionCount
public int getAccessibleActionCount()
Returns the number of Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").

Returns:
the number of Actions in this object
 o getAccessibleActionDescription
public String getAccessibleActionDescription(int i)
Return a description of the nth action of the object. This description should be human-readable; by default it currently isn't...

Parameters:
i - zero-based index of the actions
Returns:
a description of the nth action
 o doAccessibleAction
public boolean doAccessibleAction(int i)
Perform the nth Action on the object

Parameters:
i - zero-based index of actions
Returns:
whether the action was performed or not.
 o getAccessibleText
public AccessibleText getAccessibleText()
Gets the AccessibleText interface for the component. If the component does not speak AccessibleText, or have a proxy which does, this method returns null.

Returns:
the AccessibleText of the object.
See Also:
AccessibleText
 o getAccessibleSelectionCount
public int getAccessibleSelectionCount()
Returns the number of items currently selected. If no items are selected, the return value will be 0.

Returns:
the number of items currently selected.
 o getAccessibleSelection
public Accessible getAccessibleSelection(int i)
Returns an Accessible representing the nth selected item in the object. If there isn't a selection, or there are fewer items selcted than the integer passed in, the return value will be null.

Parameters:
i - the zero-based index of selected items
Returns:
an Accessible containing the selected item
 o addAccessibleSelection
public void addAccessibleSelection(int i)
Adds the nth selected item in the object to the object's selection. If the object supports multiple selections, (the method getAccessibleStateSet returns a state that is MULTISELECTABLE) the nth item is added to any existing selection, otherwse it replaces any existing selection in the objct. If the nth item is already selected, this method has no effect.

Parameters:
i - the zero-based index of selectable items
See Also:
getAccessibleStateSet
 o removeAccessibleSelection
public void removeAccessibleSelection(int i)
Removes the nth selected item in the object from the object's selection. If the nth item isn't currently selected, this method has no effect.

Parameters:
i - the zero-based index of selectable items
 o clearAccessibleSelection
public void clearAccessibleSelection()
Clears the selection in the object, so that nothing in the object is selected.

 o selectAllAccessibleSelection
public void selectAllAccessibleSelection()
Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).

See Also:
getAccessibleStateSet

All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Submit a bug or feature