MenuComponent (Sample Document)

java.lang.Object
- java.awt.MenuComponent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MenuBar, MenuItem

public abstract class MenuComponent extends java.lang.Object implements java.io.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.

Since:

JDK1.0

See Also:
Serialized Form

Nested Classes
	Modifier and Type	Class and Description
	AccessibleAWTMenuComponent	`protected class` AccessibleAWTMenuComponent Inner class of `MenuComponent` used to provide default support for accessibility. `protected class` AccessibleAWTMenuComponent Inner class of `MenuComponent` used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by menu component developers. The class used to obtain the accessible role for this object. Since: 1.3 See Also: Serialized Form

Constructors
	Constructor and Description
	MenuComponent	MenuComponent() Creates a `MenuComponent`. public MenuComponent() throws HeadlessException Creates a `MenuComponent`. Throws: `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true` See Also: `GraphicsEnvironment.isHeadless()`

Methods
	Modifier and Type	Method and Description
	dispatchEvent	`void` dispatchEvent(AWTEvent e) Delivers an event to this component or one of its sub components. public final void dispatchEvent(AWTEvent e) Delivers an event to this component or one of its sub components. Parameters: `e` - the event
	getAccessibleContext	`javax.accessibility.AccessibleContext` getAccessibleContext() Gets the `AccessibleContext` associated with this `MenuComponent`. public javax.accessibility.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` Since: 1.3
	getFont	`Font` getFont() Gets the font used for this menu component. 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 See Also: `setFont(java.awt.Font)`
	getName	`java.lang.String` getName() Gets the name of the menu component. public java.lang.String getName() Gets the name of the menu component. Returns: the name of the menu component Since: JDK1.1 See Also: `setName(java.lang.String)`
	getParent	`MenuContainer` getParent() Returns the parent container for this menu component. 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	`java.awt.peer.MenuComponentPeer` getPeer() Deprecated. As of JDK version 1.1, programs should not directly manipulate peers. @Deprecated public java.awt.peer.MenuComponentPeer getPeer() Deprecated. As of JDK version 1.1, programs should not directly manipulate peers.
	getTreeLock	`protected java.lang.Object` getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations. protected final java.lang.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 java.lang.String` paramString() Returns a string representing the state of this `MenuComponent`. protected java.lang.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	`boolean` postEvent(Event evt) Deprecated. As of JDK version 1.1, replaced by `dispatchEvent`. @Deprecated public boolean postEvent(Event evt) Deprecated. As of JDK version 1.1, replaced by `dispatchEvent`. 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. 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 Since: JDK1.1
	removeNotify	`void` removeNotify() Removes the menu component's peer. 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	`void` setFont(Font f) Sets the font to be used for this menu component to the specified font. 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 See Also: `getFont()`, `Font.getAttributes()`, `TextAttribute`
	setName	`void` setName(java.lang.String name) Sets the name of the component to the specified string. public void setName(java.lang.String name) Sets the name of the component to the specified string. Parameters: `name` - the name of the menu component Since: JDK1.1 See Also: `getName()`
	toString	`java.lang.String` toString() Returns a representation of this menu component as a string. public java.lang.String toString() Returns a representation of this menu component as a string. Overrides: `toString` in class `java.lang.Object` Returns: a string representation of this menu component

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

SourceForge

Class MenuComponent

Methods inherited from class java.lang.Object