---

java.awt
Class MenuComponent

java.lang.Object
 |
 +--java.awt.MenuComponent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MenuBar, MenuItem

---

public abstract class MenuComponent

extends Object

implements Serializable

Safe: 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

Version:

1.67, 03/21/02

Author:

Arthur van Hoff

See Also:

Serialized Form

---

peer

transient java.awt.peer.MenuComponentPeer peer

---

parent

transient MenuContainer parent

---

appContext

transient sun.awt.AppContext appContext

The AppContext of the MenuComponent. This is set in the constructor and never changes.

---

font

Font font

The menu component's font. This value can be null at which point a default will be used. This defaults to null.

See Also:

setFont(), getFont()

---

name

private String name

The menu component's name, which defaults to null.

See Also:

getName(), setName()

---

nameExplicitlySet

private boolean nameExplicitlySet

A variable to indicate whether a name is explicitly set. If true the name will be set explicitly. This defaults to false.

See Also:

setName()

---

newEventsOnly

boolean newEventsOnly

Defaults to false.

See Also:

dispatchEvent()

---

actionListenerK

static final String actionListenerK

---

itemListenerK

static final String itemListenerK

---

serialVersionUID

private static final long serialVersionUID

---

privateKey

private transient Object privateKey

This object is used as a key for internal hashtables.

---

accessibleContext

AccessibleContext accessibleContext

MenuComponent

public MenuComponent()
 throws HeadlessException

Enabled: Creates a MenuComponent.

See Also:

java.awt.GraphicsEnvironment#isHeadless

constructComponentName

String constructComponentName()

Constructs a name for this MenuComponent. Called by getName when the name is null.

Returns:

a name for this MenuComponent

---

getName

public String getName()

Enabled: Gets the name of the menu component.

Returns:

the name of the menu component

Since:

JDK1.1

See Also:

java.awt.MenuComponent#setName(java.lang.String)

---

setName

public void setName(String name)

Enabled: Sets the name of the component to the specified string.

Parameters:

name - the name of the menu component

Since:

JDK1.1

See Also:

java.awt.MenuComponent#getName

---

getParent

public MenuContainer getParent()

Suppressed: 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

---

getParent_NoClientCode

final MenuContainer getParent_NoClientCode()

---

getPeer

public java.awt.peer.MenuComponentPeer getPeer()

Suppressed: @deprecated As of JDK version 1.1, programs should not directly manipulate peers.

---

getFont

public Font getFont()

Enabled: Gets the font used for this menu component.

Returns:

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

See Also:

java.awt.MenuComponent#setFont

---

getFont_NoClientCode

final Font getFont_NoClientCode()

---

setFont

public void setFont(Font f)

Enabled: 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 look and feels may not support setting the font of a menu component; in this case, calling setFont will have no effect.

Parameters:

f - the font to be set

See Also:

java.awt.MenuComponent#getFont

---

removeNotify

public void removeNotify()

Suppressed: 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.

---

postEvent

public boolean postEvent(Event evt)

Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).

Suppressed: 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

---

dispatchEvent

public final void dispatchEvent(AWTEvent e)

Suppressed:

---

dispatchEventImpl

void dispatchEventImpl(AWTEvent e)

---

eventEnabled

boolean eventEnabled(AWTEvent e)

---

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

Since:

JDK1.1

---

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

---

toString

public String toString()

Suppressed: Returns a representation of this menu component as a string.

Overrides:

toString in class Object

Returns:

a string representation of this menu component

---

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

---

readObject

private void readObject(ObjectInputStream s)
 throws ClassNotFoundException,
 IOException,
 HeadlessException

Reads the menu component from an object input stream.

Parameters:

s - the ObjectInputStream to read

ClassNotFoundException

IOException

HeadlessException

See Also:

java.awt.GraphicsEnvironment#isHeadless

---

initIDs

private static void initIDs()

Initialize JNI field and method IDs.

---

getAccessibleContext

public AccessibleContext getAccessibleContext()

Suppressed: 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

---

getAccessibleIndexInParent

int getAccessibleIndexInParent()

Gets the index of this object in its accessible parent.

Returns:

-1 of this object does not have an accessible parent; otherwise, the index of the child in its accessible parent.

---

getAccessibleStateSet

AccessibleStateSet getAccessibleStateSet()

Gets the state of this object.

Returns:

an instance of AccessibleStateSet containing the current state set of the object

See Also:

AccessibleState

---

---