This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt
class MenuComponent

java.lang.Object extended by java.awt.MenuComponent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
MenuBar, MenuItem

public abstract class MenuComponent
extends Object
implements Serializable

The abstract class MenuComponent is the superclass of all menu-related components. In this respect, the class MenuComponent is analogous to the abstract superclass Component for AWT components.

Menu components receive and process AWT events, just as components do, through the method processEvent.


Nested Class Summary
protected abstract class

           Inner class of MenuComponent used to provide default support for accessibility.
 
Constructor Summary

          Creates a MenuComponent.
 
Method Summary
 void

          Delivers an event to this component or one of its sub components.
 AccessibleContext

          Gets the AccessibleContext associated with this MenuComponent.
 Font

          Gets the font used for this menu component.
 String

          Gets the name of the menu component.
 MenuContainer

          Returns the parent container for this menu component.
 MenuComponentPeer

          
protected Object

          Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
protected String

          Returns a string representing the state of this MenuComponent.
 boolean

          Posts the specified event to the menu.
protected void

          Processes events occurring on this menu component.
 void

          Removes the menu component's peer.
 void

          Sets the font to be used for this menu component to the specified font.
 void

          Sets the name of the component to the specified string.
 String

          Returns a representation of this menu component as a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MenuComponent

public MenuComponent()
              throws HeadlessException
Creates a MenuComponent.

Throws:
HeadlessException - if GraphicsEnvironment.isHeadless returns true
Method Detail

dispatchEvent

public final void dispatchEvent(AWTEvent e)
Delivers an event to this component or one of its sub components.

Parameters:
e - the event

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this MenuComponent. The method implemented by this base class returns null. Classes that extend MenuComponent should implement this method to return the AccessibleContext associated with the subclass.

Returns:
the AccessibleContext of this MenuComponent

getFont

public Font getFont()
Gets the font used for this menu component.

Returns:
the font used in this menu component, if there is one; null otherwise

getName

public String getName()
Gets the name of the menu component.

Returns:
the name of the menu component

getParent

public MenuContainer getParent()
Returns the parent container for this menu component.

Returns:
the menu component containing this menu component, or null if this menu component is the outermost component, the menu bar itself

getPeer

public MenuComponentPeer getPeer()

getTreeLock

protected final Object getTreeLock()
Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.

Returns:
this component's locking object

paramString

protected String paramString()
Returns a string representing the state of this MenuComponent. 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.

Returns:
the parameter string of this menu component

postEvent

public boolean postEvent(Event evt)
Posts the specified event to the menu. This method is part of the Java 1.0 event system and it is maintained only for backwards compatibility. Its use is discouraged, and it may not be supported in the future.

Parameters:
evt - the event which is to take place

processEvent

protected void processEvent(AWTEvent e)
Processes events occurring on this menu component.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Parameters:
e - the event

removeNotify

public void removeNotify()
Removes the menu component's peer. The peer allows us to modify the appearance of the menu component without changing the functionality of the menu component.


setFont

public void setFont(Font f)
Sets the font to be used for this menu component to the specified font. This font is also used by all subcomponents of this menu component, unless those subcomponents specify a different font.

Some platforms may not support setting of all font attributes of a menu component; in such cases, calling setFont will have no effect on the unsupported font attributes of this menu component. Unless subcomponents of this menu component specify a different font, this font will be used by those subcomponents if supported by the underlying platform.

Parameters:
f - the font to be set

setName

public void setName(String name)
Sets the name of the component to the specified string.

Parameters:
name - the name of the menu component

toString

public String toString()
Returns a representation of this menu component as a string.

Overrides:
toString in class Object
Returns:
a string representation of this menu component


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.