Courier System Report
Your Company
Chris

Table of Contents
Table of Figures
Use Case Scheduling
Rank Use Case Name Justification
Medium Track Shipment Status
Low Manage Account
Low Schedule a Pickup
High Update Shipment Detail
Low Update Account
Unspecified Login
High Create Shippment

Stereotypes
Extend
Abstract false
Leaf false
Root false

ORM Implementation
Base Type Generalization
Abstract false
Leaf false
Root false

Enum
Tagged Value Definitions
Type
Default Value Type-A
Type Text
Base Type Class
Abstract false
Leaf false
Root false

ORM Persistable
Base Type Class
Abstract false
Leaf false
Root false

Subsystem
Base Type System
Abstract false
Leaf false
Root false

Include
Abstract false
Leaf false
Root false

Use Case Diagram
Use Case Diagram1

Summary

Name Documentation
Account Admin  
Courier Online System  
Create Shippment
Delivery Staff  
Login  
Manage Account  
Schedule a Pickup

Shipper  
Track Shipment Status
Update Account  
Update Shipment Detail  

Details

Account Admin
Name Value
Visibility public
Abstract false
Leaf false
Root false

Relationships
Unamed Association
To
Name Value
End Model Element Manage Account
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Courier Online System
Name Value
Abstract false
Leaf false
Root false
Stereotypes Subsystem

Children
Name Documentation
Track Shipment Status
Manage Account  
Schedule a Pickup

Update Shipment Detail  
Update Account  
Login  
Create Shippment

Create Shippment
Name Value
Rank High
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
From
Name Value
End Model Element Shipper
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Delivery Staff
Name Value
Visibility public
Abstract false
Leaf false
Root false

Relationships
Unamed Association
From
Name Value
End Model Element Update Shipment Detail
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Login
Name Value
Rank Unspecified
Abstract false
Leaf false
Root false

Relationships
Unamed Include
From Track Shipment Status
Visibility Unspecified
Stereotypes Include

Unamed Include
From Update Account
Visibility Unspecified
Stereotypes Include

Unamed Include
From Schedule a Pickup
Visibility Unspecified
Stereotypes Include

Unamed Include
From Manage Account
Visibility Unspecified
Stereotypes Include

Unamed Include
From Update Shipment Detail
Visibility Unspecified
Stereotypes Include

Unamed Include
From Create Shippment
Visibility Unspecified
Stereotypes Include

Manage Account
Name Value
Rank Low
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
From
Name Value
End Model Element Account Admin
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Schedule a Pickup
Name Value
Rank Low
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
From
Name Value
End Model Element Shipper
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Shipper
Name Value
Visibility public
Abstract false
Leaf false
Root false

Relationships
Unamed Association
To
Name Value
End Model Element Schedule a Pickup
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Unamed Association
To
Name Value
End Model Element Track Shipment Status
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Unamed Association
To
Name Value
End Model Element Update Account
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Unamed Association
To
Name Value
End Model Element Create Shippment
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Track Shipment Status
Name Value
Rank Medium
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
From
Name Value
End Model Element Shipper
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Use Case Descriptions
Main
Super Use Case
Author Chris
Date Jul 26, 2006 4:21:22 PM
Brief Description Display the shipment status by providing the shipment ID.
Preconditions
Post-conditions
Flow of Events
1

Login to the System by entering the stuff ID and password.

2

Show login success screen.

3

Open the "Track Shipment Status" window.

4 Show the "Track Shipment Status" window.
5 Enter the shipment ID.
6 Display the shipment status.

Update Account
Name Value
Rank Low
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
From
Name Value
End Model Element Shipper
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Update Shipment Detail
Name Value
Rank High
Abstract false
Leaf false
Root false

Relationships
Unamed Include
To Login
Visibility Unspecified
Stereotypes Include

Unamed Association
To
Name Value
End Model Element Delivery Staff
Multiplicity Unspecified
Visibility Unspecified
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Class Diagram
DataModel

Summary

Name Documentation
ORM_Customer
ORM_CustomerImpl  
ORM_Shipment
ORM_Staff
ORM_TrackingInfo
ORM_User

Details

ORM_Customer
Name Value
Active false
Visibility public
Leaf false
Root false
Stereotypes ORM Persistable

Attributes
private contactPerson : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private email : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private phone : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private ext : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private companyName : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private address : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private city : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private zipPostal : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private stateProvince : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private country : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private creditCardType : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private creditCardNo : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private creditCardExpires : Timestamp
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private debit : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Relationships
Unamed Generalization
To ORM_CustomerImpl
Substitutable false
Visibility Unspecified
Stereotypes ORM Implementation

Unamed Generalization
From ORM_User
Substitutable false
Visibility Unspecified

Unamed Association
From (shipment)
Name Value
End Model Element ORM_Shipment
Multiplicity 0..*
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

ORM Class Detail
Name Value
Discriminator Value customer
Read Only false
Cache Disable
Inheritance Strategy Per class
Reference false

ORM_CustomerImpl
Name Value
Active false
Visibility public
Leaf false
Root false

Operations
public loadShipmentByDate (from : Date, to : Date) : ORM_Shipment
Parameters
from
Type Date
Direction inout
Multiplicity Unspecified

to
Type Date
Direction inout
Multiplicity Unspecified
Type Modifier []
Query false
Static false
Leaf false

Relationships
Unamed Generalization
From ORM_Customer
Substitutable false
Visibility Unspecified
Stereotypes ORM Implementation

ORM_Shipment
Name Value
Active false
Visibility public
Leaf false
Root false
Stereotypes ORM Persistable

Attributes
private receiverCompanyName : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverDeliveryAddress : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverCity : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverZipPostal : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverStateProvince : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverCountry : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverContactPerson : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverPhone : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private receiverEmail : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private weight : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private length : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private width : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private height : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private description : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private delivered : boolean
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private signedBy : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private cost : float
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private paid : boolean
Initial Value false
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private schedulePickupTime : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private dateTime : Timestamp
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private ID : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Relationships
Unamed Association
To (shipper)
Name Value
End Model Element ORM_Customer
Multiplicity Unspecified
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Unamed Association
To (trackingInfo)
Name Value
End Model Element ORM_TrackingInfo
Multiplicity 0..*
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

ORM Class Detail
Name Value
Table Model ORM_Shipment
Read Only false
Cache Disable
Inheritance Strategy Per class
Reference false

ORM_Staff
Name Value
Active false
Visibility public
Leaf false
Root false
Stereotypes ORM Persistable

Attributes
private position : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Relationships
Unamed Generalization
From ORM_User
Substitutable false
Visibility Unspecified

Unamed Association
To (trackingInfo)
Name Value
End Model Element ORM_TrackingInfo
Multiplicity 0..*
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

ORM Class Detail
Name Value
Discriminator Value staff
Read Only false
Cache Disable
Inheritance Strategy Per class
Reference false

ORM_TrackingInfo
Name Value
Active false
Visibility public
Leaf false
Root false
Stereotypes ORM Persistable

Attributes
private dateTime : Timestamp
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private activity : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private comments : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private location : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private ID : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Relationships
Unamed Association
From (shipment)
Name Value
End Model Element ORM_Shipment
Multiplicity Unspecified
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

Unamed Association
From (staff)
Name Value
End Model Element ORM_Staff
Multiplicity 1
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

ORM Class Detail
Name Value
Table Model ORM_TrackingInfo
Read Only false
Cache Disable
Inheritance Strategy Per class
Reference false

ORM_User
Name Value
Active false
Visibility public
Leaf false
Root false
Stereotypes ORM Persistable

Attributes
private loginID : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private password : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private ID : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Relationships
Unamed Generalization
To ORM_Staff
Substitutable false
Visibility Unspecified

Unamed Generalization
To ORM_Customer
Substitutable false
Visibility Unspecified

ORM Class Detail
Name Value
Table Model ORM_User
Read Only false
Cache Disable
Inheritance Strategy Per class
Reference false

Class Diagram
java.awt

Name Value
Default Package java.awt

Summary

Name Documentation
AccessibleAWTMenu Inner class of Menu 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.

This class implements accessibility support for the Menu class. It provides an implementation of the Java Accessibility API appropriate to menu user-interface elements.

AccessibleAWTMenuBar Inner class of MenuBar 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.

This class implements accessibility support for the MenuBar class. It provides an implementation of the Java Accessibility API appropriate to menu bar user-interface elements.

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.

AccessibleAWTMenuItem Inner class of MenuItem 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.

This class implements accessibility support for the MenuItem class. It provides an implementation of the Java Accessibility API appropriate to menu item user-interface elements.

Menu A Menu object is a pull-down menu component that is deployed from a menu bar.

A menu can optionally be a tear-off menu. A tear-off menu can be opened and dragged away from its parent menu bar or menu. It remains on the screen after the mouse button has been released. The mechanism for tearing off a menu is platform dependent, since the look and feel of the tear-off menu is determined by its peer. On platforms that do not support tear-off menus, the tear-off property is ignored.

Each item in a menu must belong to the MenuItem class. It can be an instance of MenuItem, a submenu (an instance of Menu), or a check box (an instance of CheckboxMenuItem). @version 1.75, 05/18/04 @author Sami Shaio @see java.awt.MenuItem @see java.awt.CheckboxMenuItem @since JDK1.0

MenuBar The MenuBar class encapsulates the platform's concept of a menu bar bound to a frame. In order to associate the menu bar with a Frame object, call the frame's setMenuBar method.

This is what a menu bar might look like:

ALIGN=center HSPACE=10 VSPACE=7>

A menu bar handles keyboard shortcuts for menu items, passing them along to its child menus. (Keyboard shortcuts, which are optional, provide the user with an alternative to the mouse for invoking a menu item and the action that is associated with it.) Each menu item can maintain an instance of MenuShortcut. The MenuBar class defines several methods, {@link MenuBar#shortcuts} and {@link MenuBar#getShortcutMenuItem} that retrieve information about the shortcuts a given menu bar is managing. @version 1.69, 05/18/04 @author Sami Shaio @see java.awt.Frame @see java.awt.Frame#setMenuBar(java.awt.MenuBar) @see java.awt.Menu @see java.awt.MenuItem @see java.awt.MenuShortcut @since JDK1.0

MenuComponent 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. @version 1.77, 05/18/04 @author Arthur van Hoff @since JDK1.0

MenuContainer The super class of all menu related containers. @version 1.16, 05/18/04 @author Arthur van Hoff
MenuItem All items in a menu must belong to the class MenuItem, or one of its subclasses.

The default MenuItem object embodies a simple labeled menu item.

This picture of a menu bar shows five menu items: The following text describes this graphic.
The first two items are simple menu items, labeled "Basic" and "Simple". Following these two items is a separator, which is itself a menu item, created with the label "-". Next is an instance of CheckboxMenuItem labeled "Check". The final menu item is a submenu labeled "More Examples", and this submenu is an instance of Menu.

When a menu item is selected, AWT sends an action event to the menu item. Since the event is an instance of ActionEvent, the processEvent method examines the event and passes it along to processActionEvent. The latter method redirects the event to any ActionListener objects that have registered an interest in action events generated by this menu item.

Note that the subclass Menu overrides this behavior and does not send any event to the frame until one of its subitems is selected. @version 1.88, 05/18/04 @author Sami Shaio

MenuShortcut The MenuShortcutclass represents a keyboard accelerator for a MenuItem.

Menu shortcuts are created using virtual keycodes, not characters. For example, a menu shortcut for Ctrl-a (assuming that Control is the accelerator key) would be created with code like the following:

MenuShortcut ms = new MenuShortcut(KeyEvent.VK_A, false);

The accelerator key is platform-dependent and may be obtained via {@link Toolkit#getMenuShortcutKeyMask}. @author Thomas Ball @version 1.25, 12/19/03 @since JDK1.1

Details

AccessibleAWTMenu
Name Value
Active false
Visibility protected
Leaf false
Root false
Documentation Inner class of Menu 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.

This class implements accessibility support for the Menu class. It provides an implementation of the Java Accessibility API appropriate to menu user-interface elements.

Attributes
private serialVersionUID : long
Initial Value 5228160894980069094L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public getAccessibleRole () : AccessibleRole
Query false
Static false
Leaf false
Documentation Get the role of this object. @return an instance of AccessibleRole describing the role of the object

AccessibleAWTMenuBar
Name Value
Active false
Visibility protected
Leaf false
Root false
Documentation Inner class of MenuBar 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.

This class implements accessibility support for the MenuBar class. It provides an implementation of the Java Accessibility API appropriate to menu bar user-interface elements.

Attributes
private serialVersionUID : long
Initial Value -8577604491830083815L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public getAccessibleRole () : AccessibleRole
Query false
Static false
Leaf false
Documentation Get the role of this object. @return an instance of AccessibleRole describing the role of the object

AccessibleAWTMenuComponent
Name Value
Active false
Visibility protected
Leaf false
Root false
Documentation 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.

Attributes
private serialVersionUID : long
Initial Value -4269533416223798698L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public AccessibleAWTMenuComponent ()
Query false
Static false
Leaf false
Documentation Although the class is abstract, this should be called by all sub-classes.

public getAccessibleSelection () : AccessibleSelection
Query false
Static false
Leaf false
Documentation Gets the AccessibleSelection associated with this object which allows its Accessible children to be selected. @return AccessibleSelection if supported by object; else return null @see AccessibleSelection

public getAccessibleName () : String
Query false
Static false
Leaf false
Documentation Gets the accessible name of this object. This should almost never return java.awt.MenuComponent.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. @return the localized name of the object -- can be null if this object does not have a name @see AccessibleContext#setAccessibleName

public getAccessibleDescription () : String
Query false
Static false
Leaf false
Documentation Gets the accessible description of this object. This should be a concise, localized description of what this object is - what is its 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). @return the localized description of the object -- can be null if this object does not have a description @see AccessibleContext#setAccessibleDescription

public getAccessibleRole () : AccessibleRole
Query false
Static false
Leaf false
Documentation Gets the role of this object. @return an instance of AccessibleRole describing the role of the object @see AccessibleRole

public getAccessibleStateSet () : AccessibleStateSet
Query false
Static false
Leaf false
Documentation Gets the state of this object. @return an instance of AccessibleStateSet containing the current state set of the object @see AccessibleState

public getAccessibleParent () : Accessible
Query false
Static false
Leaf false
Documentation Gets the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent. @return the Accessible parent of this object -- can be null if this object does not have an Accessible parent

public getAccessibleIndexInParent () : int
Query false
Static false
Leaf false
Documentation Gets the index of this object in its accessible parent. @return the index of this object in its parent; -1 if this object does not have an accessible parent @see #getAccessibleParent

public getAccessibleChildrenCount () : int
Query false
Static false
Leaf false
Documentation Returns the number of accessible children in the object. If all of the children of this object implement Accessible, then this method should return the number of children of this object. @return the number of accessible children in the object

public getAccessibleChild (i : int) : Accessible
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Returns the nth Accessible child of the object. @param i zero-based index of child @return the nth Accessible child of the object

public getLocale () : java.util.Locale
Query false
Static false
Leaf false
Documentation Returns the locale of this object. @return the locale of this object

public getAccessibleComponent () : AccessibleComponent
Query false
Static false
Leaf false
Documentation Gets the AccessibleComponent associated with this object if one exists. Otherwise return null. @return the component

public getBackground () : Color
Query false
Static false
Leaf false
Documentation Gets the background color of this object. @return the background color, if supported, of the object; otherwise, null

public setBackground (c : Color) : void
Parameters
c
Type Color
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the background color of this object. (For transparency, see isOpaque.) @param c the new Color for the background @see Component#isOpaque

public getForeground () : Color
Query false
Static false
Leaf false
Documentation Gets the foreground color of this object. @return the foreground color, if supported, of the object; otherwise, null

public setForeground (c : Color) : void
Parameters
c
Type Color
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the foreground color of this object. @param c the new Color for the foreground

public getCursor () : Cursor
Query false
Static false
Leaf false
Documentation Gets the Cursor of this object. @return the Curso, if supported, of the object; otherwise, null

public setCursor (cursor : Cursor) : void
Parameters
cursor
Type Cursor
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the Cursor of this object. @param cursor the new Cursor for the object

public getFont () : Font
Query false
Static false
Leaf false
Documentation Gets the Font of this object. @return the Font,if supported, for the object; otherwise, null

public setFont (f : Font) : void
Parameters
f
Type Font
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the Font of this object. @param f the new Font for the object

public getFontMetrics (f : Font) : FontMetrics
Parameters
f
Type Font
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Gets the FontMetrics of this object. @param f the Font @return the FontMetrics, if supported, the object; otherwise, null @see #getFont

public isEnabled () : boolean
Query false
Static false
Leaf false
Documentation Determines if the object is enabled. @return true if object is enabled; otherwise, false

public setEnabled (b : boolean) : void
Parameters
b
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the enabled state of the object. @param b if true, enables this object; otherwise, disables it

public isVisible () : boolean
Query false
Static false
Leaf false
Documentation Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not in fact be showing on the screen because one of the objects that this object is contained by is not visible. To determine if an object is showing on the screen, use isShowing. @return true if object is visible; otherwise, false

public setVisible (b : boolean) : void
Parameters
b
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the visible state of the object. @param b if true, shows this object; otherwise, hides it

public isShowing () : boolean
Query false
Static false
Leaf false
Documentation Determines if the object is showing. This is determined by checking the visibility of the object and ancestors of the object. Note: this will return true even if the object is obscured by another (for example, it happens to be underneath a menu that was pulled down). @return true if object is showing; otherwise, false

public contains (p : Point) : boolean
Parameters
p
Type Point
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object. @param p the Point relative to the coordinate system of the object @return true if object contains Point; otherwise false

public getLocationOnScreen () : Point
Query false
Static false
Leaf false
Documentation Returns the location of the object on the screen. @return location of object on screen -- can be null if this object is not on the screen

public getLocation () : Point
Query false
Static false
Leaf false
Documentation Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space. @return an instance of Point representing the top-left corner of the object's bounds in the coordinate space of the screen; null if this object or its parent are not on the screen

public setLocation (p : Point) : void
Parameters
p
Type Point
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the location of the object relative to the parent.

public getBounds () : Rectangle
Query false
Static false
Leaf false
Documentation Gets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent. @return a rectangle indicating this component's bounds; null if this object is not on the screen

public setBounds (r : Rectangle) : void
Parameters
r
Type Rectangle
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent. @param r a rectangle indicating this component's bounds

public getSize () : Dimension
Query false
Static false
Leaf false
Documentation Returns the size of this object in the form of a Dimension object. The height field of the Dimension object contains this object's height, and the width field of the Dimension object contains this object's width. @return a Dimension object that indicates the size of this component; null if this object is not on the screen

public setSize (d : Dimension) : void
Parameters
d
Type Dimension
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Resizes this object. @param d - the Dimension specifying the new size of the object

public getAccessibleAt (p : Point) : Accessible
Parameters
p
Type Point
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Returns the Accessible child, if one exists, contained at the local coordinate Point. If there is no Accessible child, null is returned. @param p the point defining the top-left corner of the Accessible, given in the coordinate space of the object's parent @return the Accessible, if it exists, at the specified location; else null

public isFocusTraversable () : boolean
Query false
Static false
Leaf false
Documentation Returns whether this object can accept focus or not. @return true if object can accept focus; otherwise false

public requestFocus () : void
Query false
Static false
Leaf false
Documentation Requests focus for this object.

public addFocusListener (l : java.awt.event.FocusListener) : void
Parameters
l
Type java.awt.event.FocusListener
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds the specified focus listener to receive focus events from this component. @param l the focus listener

public removeFocusListener (l : java.awt.event.FocusListener) : void
Parameters
l
Type java.awt.event.FocusListener
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the specified focus listener so it no longer receives focus events from this component. @param l the focus listener

public getAccessibleSelectionCount () : int
Query false
Static false
Leaf false
Documentation Returns the number of Accessible children currently selected. If no children are selected, the return value will be 0. @return the number of items currently selected

public getAccessibleSelection (i : int) : Accessible
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Returns an Accessible representing the specified selected child in the object. If there isn't a selection, or there are fewer children selected than the integer passed in, the return value will be null.

Note that the index represents the i-th selected child, which is different from the i-th child. @param i the zero-based index of selected children @return the i-th selected child @see #getAccessibleSelectionCount

public isAccessibleChildSelected (i : int) : boolean
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Determines if the current child of this object is selected. @return true if the current child of this object is selected; else false @param i the zero-based index of the child in this Accessible object @see AccessibleContext#getAccessibleChild

public addAccessibleSelection (i : int) : void
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds the specified Accessible child of the object to the object's selection. If the object supports multiple selections, the specified child is added to any existing selection, otherwise it replaces any existing selection in the object. If the specified child is already selected, this method has no effect. @param i the zero-based index of the child @see AccessibleContext#getAccessibleChild

public removeAccessibleSelection (i : int) : void
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the specified child of the object from the object's selection. If the specified item isn't currently selected, this method has no effect. @param i the zero-based index of the child @see AccessibleContext#getAccessibleChild

public clearAccessibleSelection () : void
Query false
Static false
Leaf false
Documentation Clears the selection in the object, so that no children in the object are selected.

public selectAllAccessibleSelection () : void
Query false
Static false
Leaf false
Documentation Causes every child of the object to be selected if the object supports multiple selections.

AccessibleAWTMenuItem
Name Value
Active false
Visibility protected
Leaf false
Root false
Documentation Inner class of MenuItem 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.

This class implements accessibility support for the MenuItem class. It provides an implementation of the Java Accessibility API appropriate to menu item user-interface elements.

Attributes
private serialVersionUID : long
Initial Value -217847831945965825L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public getAccessibleName () : String
Query false
Static false
Leaf false
Documentation Get the accessible name of this object. @return the localized name of the object -- can be null if this object does not have a name

public getAccessibleRole () : AccessibleRole
Query false
Static false
Leaf false
Documentation Get the role of this object. @return an instance of AccessibleRole describing the role of the object

public getAccessibleAction () : AccessibleAction
Query false
Static false
Leaf false
Documentation Get the AccessibleAction associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleAction interface on behalf of itself. @return this object

public getAccessibleValue () : AccessibleValue
Query false
Static false
Leaf false
Documentation Get the AccessibleValue associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleValue interface on behalf of itself. @return this object

public getAccessibleActionCount () : int
Query false
Static false
Leaf false
Documentation Returns the number of Actions available in this object. The default behavior of a menu item is to have one action. @return 1, the number of Actions in this object

public getAccessibleActionDescription (i : int) : String
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Return a description of the specified action of the object. @param i zero-based index of the actions

public doAccessibleAction (i : int) : boolean
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Perform the specified Action on the object @param i zero-based index of actions @return true if the action was performed; otherwise false.

public getCurrentAccessibleValue () : Number
Query false
Static false
Leaf false
Documentation Get the value of this object as a Number. @return An Integer of 0 if this isn't selected or an Integer of 1 if this is selected. @see javax.swing.AbstractButton#isSelected()

public setCurrentAccessibleValue (n : Number) : boolean
Parameters
n
Type Number
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Set the value of this object as a Number. @return True if the value was set.

public getMinimumAccessibleValue () : Number
Query false
Static false
Leaf false
Documentation Get the minimum value of this object as a Number. @return An Integer of 0.

public getMaximumAccessibleValue () : Number
Query false
Static false
Leaf false
Documentation Get the maximum value of this object as a Number. @return An Integer of 0.

Menu
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation A Menu object is a pull-down menu component that is deployed from a menu bar.

A menu can optionally be a tear-off menu. A tear-off menu can be opened and dragged away from its parent menu bar or menu. It remains on the screen after the mouse button has been released. The mechanism for tearing off a menu is platform dependent, since the look and feel of the tear-off menu is determined by its peer. On platforms that do not support tear-off menus, the tear-off property is ignored.

Each item in a menu must belong to the MenuItem class. It can be an instance of MenuItem, a submenu (an instance of Menu), or a check box (an instance of CheckboxMenuItem). @version 1.75, 05/18/04 @author Sami Shaio @see java.awt.MenuItem @see java.awt.CheckboxMenuItem @since JDK1.0

Children
Name Documentation
AccessibleAWTMenu Inner class of Menu 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.

This class implements accessibility support for the Menu class. It provides an implementation of the Java Accessibility API appropriate to menu user-interface elements.

Attributes
package items : java.util.Vector
Initial Value new Vector()
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation A vector of the items that will be part of the Menu. @serial @see #countItems()

package tearOff : boolean
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This field indicates whether the menu has the tear of property or not. It will be set to true if the menu has the tear off property and it will be set to false> if it does not. A torn off menu can be deleted by a user when it is no longer needed. @serial @see #isTearOff()

package isHelpMenu : boolean
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This field will be set to true if the Menu in question is actually a help menu. Otherwise it will be set to false. @serial

private base : String
Initial Value "menu"
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private nameCounter : int
Initial Value 0
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private serialVersionUID : long
Initial Value -8809584163345499784L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private menuSerializedDataVersion : int
Initial Value 1
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The menu serialized Data Version. @serial

Operations
public Menu ()
Query false
Static false
Leaf false
Documentation Constructs a new menu with an empty label. This menu is not a tear-off menu. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since JDK1.1

public Menu (label : String)
Parameters
label
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Constructs a new menu with the specified label. This menu is not a tear-off menu. @param label the menu's label in the menu bar, or in another menu of which this menu is a submenu. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless

public Menu (label : String, tearOff : boolean)
Parameters
label
Type String
Direction inout
Multiplicity Unspecified

tearOff
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Constructs a new menu with the specified label, indicating whether the menu can be torn off.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored. @param label the menu's label in the menu bar, or in another menu of which this menu is a submenu. @param tearOff if true, the menu is a tear-off menu. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since JDK1.0.

package constructComponentName () : String
Query false
Static false
Leaf false
Documentation Construct a name for this MenuComponent. Called by getName() when the name is null.

public addNotify () : void
Query false
Static false
Leaf false
Documentation Creates the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

public removeNotify () : void
Query false
Static false
Leaf false
Documentation Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

public isTearOff () : boolean
Query false
Static false
Leaf false
Documentation Indicates whether this menu is a tear-off menu.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored. @return true if this is a tear-off menu; false otherwise.

public getItemCount () : int
Query false
Static false
Leaf false
Documentation Get the number of items in this menu. @return the number of items in this menu. @since JDK1.1

public countItems () : int
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, replaced by getItemCount().

package countItemsImpl () : int
Query false
Static false
Leaf false

public getItem (index : int) : MenuItem
Parameters
index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Gets the item located at the specified index of this menu. @param index the position of the item to be returned. @return the item located at the specified index.

package getItemImpl (index : int) : MenuItem
Parameters
index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

public add (mi : MenuItem) : MenuItem
Parameters
mi
Type MenuItem
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds the specified menu item to this menu. If the menu item has been part of another menu, removes it from that menu. @param mi the menu item to be added @return the menu item added @see java.awt.Menu#insert(java.lang.String, int) @see java.awt.Menu#insert(java.awt.MenuItem, int)

public add (label : String) : void
Parameters
label
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds an item with the specified label to this menu. @param label the text on the item @see java.awt.Menu#insert(java.lang.String, int) @see java.awt.Menu#insert(java.awt.MenuItem, int)

public insert (menuitem : MenuItem, index : int) : void
Parameters
menuitem
Type MenuItem
Direction inout
Multiplicity Unspecified

index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Inserts a menu item into this menu at the specified position. @param menuitem the menu item to be inserted. @param index the position at which the menu item should be inserted. @see java.awt.Menu#add(java.lang.String) @see java.awt.Menu#add(java.awt.MenuItem) @exception IllegalArgumentException if the value of index is less than zero @since JDK1.1

public insert (label : String, index : int) : void
Parameters
label
Type String
Direction inout
Multiplicity Unspecified

index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Inserts a menu item with the specified label into this menu at the specified position. This is a convenience method for insert(menuItem, index). @param label the text on the item @param index the position at which the menu item should be inserted @see java.awt.Menu#add(java.lang.String) @see java.awt.Menu#add(java.awt.MenuItem) @exception IllegalArgumentException if the value of index is less than zero @since JDK1.1

public addSeparator () : void
Query false
Static false
Leaf false
Documentation Adds a separator line, or a hypen, to the menu at the current position. @see java.awt.Menu#insertSeparator(int)

public insertSeparator (index : int) : void
Parameters
index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Inserts a separator at the specified position. @param index the position at which the menu separator should be inserted. @exception IllegalArgumentException if the value of index is less than 0. @see java.awt.Menu#addSeparator @since JDK1.1

public remove (index : int) : void
Parameters
index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the menu item at the specified index from this menu. @param index the position of the item to be removed.

public remove (item : MenuComponent) : void
Parameters
item
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the specified menu item from this menu. @param item the item to be removed from the menu. If item is null or is not in this menu, this method does nothing.

public removeAll () : void
Query false
Static false
Leaf false
Documentation Removes all items from this menu. @since JDK1.0.

package handleShortcut (e : java.awt.event.KeyEvent) : boolean
Parameters
e
Type java.awt.event.KeyEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package getShortcutMenuItem (s : MenuShortcut) : MenuItem
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package shortcuts () : java.util.Enumeration
Query false
Static false
Leaf false

package deleteShortcut (s : MenuShortcut) : void
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

private writeObject (s : java.io.ObjectOutputStream) : void
Parameters
s
Type java.io.ObjectOutputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Writes default serializable fields to stream. @param s the ObjectOutputStream to write @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener) @see #readObject(ObjectInputStream)

private readObject (s : java.io.ObjectInputStream) : void
Parameters
s
Type java.io.ObjectInputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Reads the ObjectInputStream. Unrecognized keys or values will be ignored. @param s the ObjectInputStream to read @exception HeadlessException if GraphicsEnvironment.isHeadless returns true @see java.awt.GraphicsEnvironment#isHeadless @see #writeObject(ObjectOutputStream)

public paramString () : String
Query false
Static false
Leaf false
Documentation Returns a string representing the state of this Menu. 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. @return the parameter string of this menu

private initIDs () : void
Query false
Static false
Leaf false
Documentation Initialize JNI field and method IDs

public getAccessibleContext () : AccessibleContext
Query false
Static false
Leaf false
Documentation Gets the AccessibleContext associated with this Menu. For menus, the AccessibleContext takes the form of an AccessibleAWTMenu. A new AccessibleAWTMenu instance is created if necessary. @return an AccessibleAWTMenu that serves as the AccessibleContext of this Menu

package getAccessibleChildIndex (child : MenuComponent) : int
Parameters
child
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Defined in MenuComponent. Overridden here.

Relationships
Unamed Generalization
From MenuItem
Substitutable false
Visibility Unspecified

Unamed Realization
From MenuContainer
Visibility Unspecified

Unamed Association
From
Name Value
End Model Element MenuBar
Multiplicity Unspecified
Visibility private
Aggregation Kind None
Navigable false
Derived false
Abstract false
Leaf false
Visibility Unspecified

MenuBar
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation The MenuBar class encapsulates the platform's concept of a menu bar bound to a frame. In order to associate the menu bar with a Frame object, call the frame's setMenuBar method.

This is what a menu bar might look like:

ALIGN=center HSPACE=10 VSPACE=7>

A menu bar handles keyboard shortcuts for menu items, passing them along to its child menus. (Keyboard shortcuts, which are optional, provide the user with an alternative to the mouse for invoking a menu item and the action that is associated with it.) Each menu item can maintain an instance of MenuShortcut. The MenuBar class defines several methods, {@link MenuBar#shortcuts} and {@link MenuBar#getShortcutMenuItem} that retrieve information about the shortcuts a given menu bar is managing. @version 1.69, 05/18/04 @author Sami Shaio @see java.awt.Frame @see java.awt.Frame#setMenuBar(java.awt.MenuBar) @see java.awt.Menu @see java.awt.MenuItem @see java.awt.MenuShortcut @since JDK1.0

Children
Name Documentation
AccessibleAWTMenuBar Inner class of MenuBar 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.

This class implements accessibility support for the MenuBar class. It provides an implementation of the Java Accessibility API appropriate to menu bar user-interface elements.

Attributes
package menus : java.util.Vector
Initial Value new Vector()
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This field represents a vector of the actual menus that will be part of the MenuBar. @serial @see #countMenus()

package helpMenu : Menu
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This menu is a special menu dedicated to help. The one thing to note about this menu is that on some platforms it appears at the right edge of the menubar. @serial @see #getHelpMenu() @see #setHelpMenu(Menu)

private base : String
Initial Value "menubar"
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private nameCounter : int
Initial Value 0
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private serialVersionUID : long
Initial Value -4930327919388951260L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private menuBarSerializedDataVersion : int
Initial Value 1
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The MenuBar's serialized data version. @serial

Operations
public MenuBar ()
Query false
Static false
Leaf false
Documentation Creates a new menu bar. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless

package constructComponentName () : String
Query false
Static false
Leaf false
Documentation Construct a name for this MenuComponent. Called by getName() when the name is null.

public addNotify () : void
Query false
Static false
Leaf false
Documentation Creates the menu bar's peer. The peer allows us to change the appearance of the menu bar without changing any of the menu bar's functionality.

public removeNotify () : void
Query false
Static false
Leaf false
Documentation Removes the menu bar's peer. The peer allows us to change the appearance of the menu bar without changing any of the menu bar's functionality.

public getHelpMenu () : Menu
Query false
Static false
Leaf false
Documentation Gets the help menu on the menu bar. @return the help menu on this menu bar.

public setHelpMenu (m : Menu) : void
Parameters
m
Type Menu
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the specified menu to be this menu bar's help menu. If this menu bar has an existing help menu, the old help menu is removed from the menu bar, and replaced with the specified menu. @param m the menu to be set as the help menu

public add (m : Menu) : Menu
Parameters
m
Type Menu
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds the specified menu to the menu bar. If the menu has been part of another menu bar, removes it from that menu bar. @param m the menu to be added @return the menu added @see java.awt.MenuBar#remove(int) @see java.awt.MenuBar#remove(java.awt.MenuComponent)

public remove (index : int) : void
Parameters
index
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the menu located at the specified index from this menu bar. @param index the position of the menu to be removed. @see java.awt.MenuBar#add(java.awt.Menu)

public remove (m : MenuComponent) : void
Parameters
m
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the specified menu component from this menu bar. @param m the menu component to be removed. @see java.awt.MenuBar#add(java.awt.Menu)

public getMenuCount () : int
Query false
Static false
Leaf false
Documentation Gets the number of menus on the menu bar. @return the number of menus on the menu bar. @since JDK1.1

public countMenus () : int
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, replaced by getMenuCount().

package getMenuCountImpl () : int
Query false
Static false
Leaf false

public getMenu (i : int) : Menu
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Gets the specified menu. @param i the index position of the menu to be returned. @return the menu at the specified index of this menu bar.

package getMenuImpl (i : int) : Menu
Parameters
i
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

public shortcuts () : Enumeration
Query false
Static false
Leaf false
Documentation Gets an enumeration of all menu shortcuts this menu bar is managing. @return an enumeration of menu shortcuts that this menu bar is managing. @see java.awt.MenuShortcut @since JDK1.1

public getShortcutMenuItem (s : MenuShortcut) : MenuItem
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Gets the instance of MenuItem associated with the specified MenuShortcut object, or null if none of the menu items being managed by this menu bar is associated with the specified menu shortcut. @param s the specified menu shortcut. @see java.awt.MenuItem @see java.awt.MenuShortcut @since JDK1.1

package handleShortcut (e : java.awt.event.KeyEvent) : boolean
Parameters
e
Type java.awt.event.KeyEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

public deleteShortcut (s : MenuShortcut) : void
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Deletes the specified menu shortcut. @param s the menu shortcut to delete. @since JDK1.1

private writeObject (s : java.io.ObjectOutputStream) : void
Parameters
s
Type java.io.ObjectOutputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Writes default serializable fields to stream. @param s the ObjectOutputStream to write @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener) @see #readObject(java.io.ObjectInputStream)

private readObject (s : java.io.ObjectInputStream) : void
Parameters
s
Type java.io.ObjectInputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Reads the ObjectInputStream. Unrecognized keys or values will be ignored. @param s the ObjectInputStream to read @exception HeadlessException if GraphicsEnvironment.isHeadless returns true @see java.awt.GraphicsEnvironment#isHeadless @see #writeObject(java.io.ObjectOutputStream)

private initIDs () : void
Query false
Static false
Leaf false
Documentation Initialize JNI field and method IDs

public getAccessibleContext () : AccessibleContext
Query false
Static false
Leaf false
Documentation Gets the AccessibleContext associated with this MenuBar. For menu bars, the AccessibleContext takes the form of an AccessibleAWTMenuBar. A new AccessibleAWTMenuBar instance is created if necessary. @return an AccessibleAWTMenuBar that serves as the AccessibleContext of this MenuBar

package getAccessibleChildIndex (child : MenuComponent) : int
Parameters
child
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Defined in MenuComponent. Overridden here.

Relationships
Unamed Generalization
From MenuComponent
Substitutable false
Visibility Unspecified

Unamed Realization
From MenuContainer
Visibility Unspecified

Unamed Association
To (helpMenu)
Name Value
End Model Element Menu
Multiplicity 1
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

MenuComponent
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation 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. @version 1.77, 05/18/04 @author Arthur van Hoff @since JDK1.0

Children
Name Documentation
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.

Attributes
package peer : java.awt.peer.MenuComponentPeer
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

package parent : MenuContainer
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

package appContext : sun.awt.AppContext
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The AppContext of the MenuComponent. This is set in the constructor and never changes.

package font : Font
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The menu component's font. This value can be null at which point a default will be used. This defaults to null. @serial @see #setFont(Font) @see #getFont()

private name : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The menu component's name, which defaults to null. @serial @see #getName() @see #setName(String)

private nameExplicitlySet : boolean
Initial Value false
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation A variable to indicate whether a name is explicitly set. If true the name will be set explicitly. This defaults to false. @serial @see #setName(String)

package newEventsOnly : boolean
Initial Value false
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation Defaults to false. @serial @see #dispatchEvent(AWTEvent)

package actionListenerK : String
Initial Value Component.actionListenerK
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

package itemListenerK : String
Initial Value Component.itemListenerK
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private serialVersionUID : long
Initial Value -4536902356223894379L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private privateKey : Object
Initial Value new Object()
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This object is used as a key for internal hashtables.

package accessibleContext : AccessibleContext
Initial Value null
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public MenuComponent ()
Query false
Static false
Leaf false
Documentation Creates a MenuComponent. @exception HeadlessException if GraphicsEnvironment.isHeadless returns true @see java.awt.GraphicsEnvironment#isHeadless

package constructComponentName () : String
Query false
Static false
Leaf false
Documentation Constructs a name for this MenuComponent. Called by getName when the name is null. @return a name for this MenuComponent

public getName () : String
Query false
Static false
Leaf false
Documentation Gets the name of the menu component. @return the name of the menu component @see java.awt.MenuComponent#setName(java.lang.String) @since JDK1.1

public setName (name : String) : void
Parameters
name
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the name of the component to the specified string. @param name the name of the menu component @see java.awt.MenuComponent#getName @since JDK1.1

public getParent () : MenuContainer
Query false
Static false
Leaf false
Documentation Returns the parent container for this menu component. @return the menu component containing this menu component, or null if this menu component is the outermost component, the menu bar itself

package getParent_NoClientCode () : MenuContainer
Query false
Static false
Leaf false
Documentation NOTE: This method may be called by privileged threads. This functionality is implemented in a package-private method to insure that it cannot be overridden by client subclasses. DO NOT INVOKE CLIENT CODE ON THIS THREAD!

public getPeer () : java.awt.peer.MenuComponentPeer
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, programs should not directly manipulate peers.

public getFont () : Font
Query false
Static false
Leaf false
Documentation Gets the font used for this menu component. @return the font used in this menu component, if there is one; null otherwise @see java.awt.MenuComponent#setFont

package getFont_NoClientCode () : Font
Query false
Static false
Leaf false
Documentation NOTE: This method may be called by privileged threads. This functionality is implemented in a package-private method to insure that it cannot be overridden by client subclasses. DO NOT INVOKE CLIENT CODE ON THIS THREAD!

public setFont (f : Font) : void
Parameters
f
Type Font
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation 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. @param f the font to be set @see #getFont @see Font#getAttributes @see java.awt.font.TextAttribute

public removeNotify () : void
Query false
Static false
Leaf false
Documentation 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.

public postEvent (evt : Event) : boolean
Parameters
evt
Type Event
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation 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. @param evt the event which is to take place @deprecated As of JDK version 1.1, replaced by {@link #dispatchEvent(AWTEvent) dispatchEvent}.

public dispatchEvent (e : AWTEvent) : void
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package dispatchEventImpl (e : AWTEvent) : void
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package eventEnabled (e : AWTEvent) : boolean
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation REMIND: remove when filtering is done at lower level

protected processEvent (e : AWTEvent) : void
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation 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. @param e the event @since JDK1.1

protected paramString () : String
Query false
Static false
Leaf false
Documentation 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. @return the parameter string of this menu component

public toString () : String
Query false
Static false
Leaf false
Documentation Returns a representation of this menu component as a string. @return a string representation of this menu component

protected getTreeLock () : Object
Query false
Static false
Leaf false
Documentation Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations. @return this component's locking object

private readObject (s : java.io.ObjectInputStream) : void
Parameters
s
Type java.io.ObjectInputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Reads the menu component from an object input stream. @param s the ObjectInputStream to read @exception HeadlessException if GraphicsEnvironment.isHeadless returns true @serial @see java.awt.GraphicsEnvironment#isHeadless

private initIDs () : void
Query false
Static false
Leaf false
Documentation Initialize JNI field and method IDs.

public getAccessibleContext () : AccessibleContext
Query false
Static false
Leaf false
Documentation 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. @return the AccessibleContext of this MenuComponent

package getAccessibleIndexInParent () : int
Query false
Static false
Leaf false
Documentation Gets the index of this object in its accessible parent. @return -1 if this object does not have an accessible parent; otherwise, the index of the child in its accessible parent.

package getAccessibleChildIndex (child : MenuComponent) : int
Parameters
child
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Gets the index of the child within this MenuComponent. @param child MenuComponent whose index we are interested in. @return -1 if this object doesn't contain the child, otherwise, index of the child.

package getAccessibleStateSet () : AccessibleStateSet
Query false
Static false
Leaf false
Documentation Gets the state of this object. @return an instance of AccessibleStateSet containing the current state set of the object @see AccessibleState

Relationships
Unamed Generalization
To MenuBar
Substitutable false
Visibility Unspecified

Unamed Generalization
To MenuItem
Substitutable false
Visibility Unspecified

Unamed Association
To (parent)
Name Value
End Model Element MenuContainer
Multiplicity 1
Visibility package
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

MenuContainer
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation The super class of all menu related containers. @version 1.16, 05/18/04 @author Arthur van Hoff

Operations
package getFont () : Font
Query false
Static false
Leaf false

package remove (comp : MenuComponent) : void
Parameters
comp
Type MenuComponent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package postEvent (evt : Event) : boolean
Parameters
evt
Type Event
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1 replaced by dispatchEvent(AWTEvent).

Relationships
Unamed Realization
To Menu
Visibility Unspecified

Unamed Realization
To MenuBar
Visibility Unspecified

Unamed Association
From
Name Value
End Model Element MenuComponent
Multiplicity Unspecified
Visibility private
Aggregation Kind None
Navigable false
Derived false
Abstract false
Leaf false
Visibility Unspecified

MenuItem
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation All items in a menu must belong to the class MenuItem, or one of its subclasses.

The default MenuItem object embodies a simple labeled menu item.

This picture of a menu bar shows five menu items: The following text describes this graphic.
The first two items are simple menu items, labeled "Basic" and "Simple". Following these two items is a separator, which is itself a menu item, created with the label "-". Next is an instance of CheckboxMenuItem labeled "Check". The final menu item is a submenu labeled "More Examples", and this submenu is an instance of Menu.

When a menu item is selected, AWT sends an action event to the menu item. Since the event is an instance of ActionEvent, the processEvent method examines the event and passes it along to processActionEvent. The latter method redirects the event to any ActionListener objects that have registered an interest in action events generated by this menu item.

Note that the subclass Menu overrides this behavior and does not send any event to the frame until one of its subitems is selected. @version 1.88, 05/18/04 @author Sami Shaio

Children
Name Documentation
AccessibleAWTMenuItem Inner class of MenuItem 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.

This class implements accessibility support for the MenuItem class. It provides an implementation of the Java Accessibility API appropriate to menu item user-interface elements.

Attributes
package enabled : boolean
Initial Value true
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation A value to indicate whether a menu item is enabled or not. If it is enabled, enabled will be set to true. Else enabled will be set to false. @serial @see #isEnabled() @see #setEnabled(boolean)

package label : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation label is the label of a menu item. It can be any string. @serial @see #getLabel() @see #setLabel(String)

package actionCommand : String
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation This field indicates the command tha has been issued by a particular menu item. By default the actionCommand is the label of the menu item, unless it has been set using setActionCommand. @serial @see #setActionCommand(String) @see #getActionCommand()

package eventMask : long
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The eventMask is ONLY set by subclasses via enableEvents. The mask should NOT be set when listeners are registered so that we can distinguish the difference between when listeners request events and subclasses request them. @serial

package actionListener : ActionListener
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private shortcut : MenuShortcut
Initial Value null
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation A sequence of key stokes that ia associated with a menu item. Note :in 1.1.2 you must use setActionCommand() on a menu item in order for its shortcut to work. @serial @see #getShortcut() @see #setShortcut(MenuShortcut) @see #deleteShortcut()

private base : String
Initial Value "menuitem"
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private nameCounter : int
Initial Value 0
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private serialVersionUID : long
Initial Value -21757335363267194L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

private menuItemSerializedDataVersion : int
Initial Value 1
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation Menu item serialized data version. @serial

Operations
public MenuItem ()
Query false
Static false
Leaf false
Documentation Constructs a new MenuItem with an empty label and no keyboard shortcut. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since JDK1.1

public MenuItem (label : String)
Parameters
label
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Constructs a new MenuItem with the specified label and no keyboard shortcut. Note that use of "-" in a label is reserved to indicate a separator between menu items. By default, all menu items except for separators are enabled. @param label the label for this menu item. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since JDK1.0

public MenuItem (label : String, s : MenuShortcut)
Parameters
label
Type String
Direction inout
Multiplicity Unspecified

s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Create a menu item with an associated keyboard shortcut. Note that use of "-" in a label is reserved to indicate a separator between menu items. By default, all menu items except for separators are enabled. @param label the label for this menu item. @param s the instance of MenuShortcut associated with this menu item. @exception HeadlessException if GraphicsEnvironment.isHeadless() returns true. @see java.awt.GraphicsEnvironment#isHeadless @since JDK1.1

package constructComponentName () : String
Query false
Static false
Leaf false
Documentation Construct a name for this MenuComponent. Called by getName() when the name is null.

public addNotify () : void
Query false
Static false
Leaf false
Documentation Creates the menu item's peer. The peer allows us to modify the appearance of the menu item without changing its functionality.

public getLabel () : String
Query false
Static false
Leaf false
Documentation Gets the label for this menu item. @return the label of this menu item, or null if this menu item has no label. @see java.awt.MenuItem#setLabel @since JDK1.0

public setLabel (label : String) : void
Parameters
label
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the label for this menu item to the specified label. @param label the new label, or null for no label. @see java.awt.MenuItem#getLabel @since JDK1.0

public isEnabled () : boolean
Query false
Static false
Leaf false
Documentation Checks whether this menu item is enabled. @see java.awt.MenuItem#setEnabled @since JDK1.0

public setEnabled (b : boolean) : void
Parameters
b
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets whether or not this menu item can be chosen. @param b if true, enables this menu item; if false, disables it. @see java.awt.MenuItem#isEnabled @since JDK1.1

public enable () : void
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, replaced by setEnabled(boolean).

public enable (b : boolean) : void
Parameters
b
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, replaced by setEnabled(boolean).

public disable () : void
Query false
Static false
Leaf false
Documentation @deprecated As of JDK version 1.1, replaced by setEnabled(boolean).

public getShortcut () : MenuShortcut
Query false
Static false
Leaf false
Documentation Get the MenuShortcut object associated with this menu item, @return the menu shortcut associated with this menu item, or null if none has been specified. @see java.awt.MenuItem#setShortcut @since JDK1.1

public setShortcut (s : MenuShortcut) : void
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Set the MenuShortcut object associated with this menu item. If a menu shortcut is already associated with this menu item, it is replaced. @param s the menu shortcut to associate with this menu item. @see java.awt.MenuItem#getShortcut @since JDK1.1

public deleteShortcut () : void
Query false
Static false
Leaf false
Documentation Delete any MenuShortcut object associated with this menu item. @since JDK1.1

package deleteShortcut (s : MenuShortcut) : void
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package doMenuEvent (when : long, modifiers : int) : void
Parameters
when
Type long
Direction inout
Multiplicity Unspecified

modifiers
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package handleShortcut (e : KeyEvent) : boolean
Parameters
e
Type KeyEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

package getShortcutMenuItem (s : MenuShortcut) : MenuItem
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false

protected enableEvents (eventsToEnable : long) : void
Parameters
eventsToEnable
Type long
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Enables event delivery to this menu item for events to be defined by the specified event mask parameter

Since event types are automatically enabled when a listener for that type is added to the menu item, this method only needs to be invoked by subclasses of MenuItem which desire to have the specified event types delivered to processEvent regardless of whether a listener is registered. @param eventsToEnable the event mask defining the event types @see java.awt.MenuItem#processEvent @see java.awt.MenuItem#disableEvents @see java.awt.Component#enableEvents @since JDK1.1

protected disableEvents (eventsToDisable : long) : void
Parameters
eventsToDisable
Type long
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Disables event delivery to this menu item for events defined by the specified event mask parameter. @param eventsToDisable the event mask defining the event types @see java.awt.MenuItem#processEvent @see java.awt.MenuItem#enableEvents @see java.awt.Component#disableEvents @since JDK1.1

public setActionCommand (command : String) : void
Parameters
command
Type String
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Sets the command name of the action event that is fired by this menu item.

By default, the action command is set to the label of the menu item. @param command the action command to be set for this menu item. @see java.awt.MenuItem#getActionCommand @since JDK1.1

public getActionCommand () : String
Query false
Static false
Leaf false
Documentation Gets the command name of the action event that is fired by this menu item. @see java.awt.MenuItem#setActionCommand @since JDK1.1

package getActionCommandImpl () : String
Query false
Static false
Leaf false
Documentation This is final so it can be called on the Toolkit thread.

public addActionListener (l : ActionListener) : void
Parameters
l
Type ActionListener
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Adds the specified action listener to receive action events from this menu item. If l is null, no exception is thrown and no action is performed. @param l the action listener. @see #removeActionListener @see #getActionListeners @see java.awt.event.ActionEvent @see java.awt.event.ActionListener @since JDK1.1

public removeActionListener (l : ActionListener) : void
Parameters
l
Type ActionListener
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Removes the specified action listener so it no longer receives action events from this menu item. If l is null, no exception is thrown and no action is performed. @param l the action listener. @see #addActionListener @see #getActionListeners @see java.awt.event.ActionEvent @see java.awt.event.ActionListener @since JDK1.1

public getActionListeners () : ActionListener
Type Modifier []
Query false
Static false
Leaf false
Documentation Returns an array of all the action listeners registered on this menu item. @return all of this menu item's ActionListeners or an empty array if no action listeners are currently registered @see #addActionListener @see #removeActionListener @see java.awt.event.ActionEvent @see java.awt.event.ActionListener @since 1.4

public getListeners (listenerType : Class) : T
Parameters
listenerType
Type Class
Direction inout
Multiplicity Unspecified
Type Modifier []
Query false
Static false
Leaf false
Documentation Returns an array of all the objects currently registered as FooListeners upon this MenuItem. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a MenuItem m for its action listeners with the following code: 

ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
If no such listeners exist, this method returns an empty array. @param listenerType the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener @return an array of all objects registered as FooListeners on this menu item, or an empty array if no such listeners have been added @exception ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener @see #getActionListeners @since 1.3

protected processEvent (e : AWTEvent) : void
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Processes events on this menu item. If the event is an instance of ActionEvent, it invokes processActionEvent, another method defined by MenuItem.

Currently, menu items only support action events.

Note that if the event parameter is null the behavior is unspecified and may result in an exception. @param e the event @see java.awt.MenuItem#processActionEvent @since JDK1.1

package eventEnabled (e : AWTEvent) : boolean
Parameters
e
Type AWTEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation REMIND: remove when filtering is done at lower level

protected processActionEvent (e : ActionEvent) : void
Parameters
e
Type ActionEvent
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Processes action events occurring on this menu item, by dispatching them to any registered ActionListener objects. This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs:

  • An ActionListener object is registered via addActionListener.
  • Action events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception. @param e the action event @see java.awt.event.ActionEvent @see java.awt.event.ActionListener @see java.awt.MenuItem#enableEvents @since JDK1.1

public paramString () : String
Query false
Static false
Leaf false
Documentation Returns a string representing the state of this MenuItem. 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. @return the parameter string of this menu item

private writeObject (s : java.io.ObjectOutputStream) : void
Parameters
s
Type java.io.ObjectOutputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Writes default serializable fields to stream. Writes a list of serializable ActionListeners as optional data. The non-serializable listeners are detected and no attempt is made to serialize them. @param s the ObjectOutputStream to write @serialData null terminated sequence of 0 or more pairs; the pair consists of a String and an Object; the String indicates the type of object and is one of the following: actionListenerK indicating an ActionListener object @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener) @see #readObject(ObjectInputStream)

private readObject (s : java.io.ObjectInputStream) : void
Parameters
s
Type java.io.ObjectInputStream
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Reads the ObjectInputStream and if it isn't null adds a listener to receive action events fired by the Menu Item. Unrecognized keys or values will be ignored. @param s the ObjectInputStream to read @exception HeadlessException if GraphicsEnvironment.isHeadless returns true @see #removeActionListener(actionListener) @see #addActionListener(actionListener) @see #writeObject(ObjectOutputStream)

private initIDs () : void
Query false
Static false
Leaf false
Documentation Initialize JNI field and method IDs

public getAccessibleContext () : AccessibleContext
Query false
Static false
Leaf false
Documentation Gets the AccessibleContext associated with this MenuItem. For menu items, the AccessibleContext takes the form of an AccessibleAWTMenuItem. A new AccessibleAWTMenuItem instance is created if necessary. @return an AccessibleAWTMenuItem that serves as the AccessibleContext of this MenuItem

Relationships
Unamed Generalization
To Menu
Substitutable false
Visibility Unspecified

Unamed Generalization
From MenuComponent
Substitutable false
Visibility Unspecified

Unamed Association
To (shortcut)
Name Value
End Model Element MenuShortcut
Multiplicity 1
Visibility private
Aggregation Kind None
Navigable true
Derived false
Abstract false
Leaf false
Visibility Unspecified

MenuShortcut
Name Value
Active false
Visibility public
Leaf false
Root false
Documentation The MenuShortcutclass represents a keyboard accelerator for a MenuItem.

Menu shortcuts are created using virtual keycodes, not characters. For example, a menu shortcut for Ctrl-a (assuming that Control is the accelerator key) would be created with code like the following:

MenuShortcut ms = new MenuShortcut(KeyEvent.VK_A, false);

The accelerator key is platform-dependent and may be obtained via {@link Toolkit#getMenuShortcutKeyMask}. @author Thomas Ball @version 1.25, 12/19/03 @since JDK1.1

Attributes
package key : int
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation The virtual keycode for the menu shortcut. This is the keycode with which the menu shortcut will be created. Note that it is a virtual keycode, not a character, e.g. KeyEvent.VK_A, not 'a'. Note: in 1.1.x you must use setActionCommand() on a menu item in order for its shortcut to work, otherwise it will fire a null action command. @serial @see #getKey() @see #usesShiftModifier() @see java.awt.event.KeyEvent @since JDK1.1

package usesShift : boolean
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true
Documentation Indicates whether the shft key was pressed. If true, the shift key was pressed. If false, the shift key was not pressed @serial @see #usesShiftModifier() @since JDK1.1

private serialVersionUID : long
Initial Value 143448358473180225L
Has Setter false
Has Getter false
Derived false
Multiplicity Unspecified
Visible true

Operations
public MenuShortcut (key : int)
Parameters
key
Type int
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Constructs a new MenuShortcut for the specified virtual keycode. @param key the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed. @see java.awt.event.KeyEvent

public MenuShortcut (key : int, useShiftModifier : boolean)
Parameters
key
Type int
Direction inout
Multiplicity Unspecified

useShiftModifier
Type boolean
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Constructs a new MenuShortcut for the specified virtual keycode. @param key the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed. @param useShiftModifier indicates whether this MenuShortcut is invoked with the SHIFT key down. @see java.awt.event.KeyEvent

public getKey () : int
Query false
Static false
Leaf false
Documentation Returns the raw keycode of this MenuShortcut. @return the raw keycode of this MenuShortcut. @see java.awt.event.KeyEvent @since JDK1.1

public usesShiftModifier () : boolean
Query false
Static false
Leaf false
Documentation Returns whether this MenuShortcut must be invoked using the SHIFT key. @return true if this MenuShortcut must be invoked using the SHIFT key, false otherwise. @since JDK1.1

public equals (s : MenuShortcut) : boolean
Parameters
s
Type MenuShortcut
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Returns whether this MenuShortcut is the same as another: equality is defined to mean that both MenuShortcuts use the same key and both either use or don't use the SHIFT key. @param s the MenuShortcut to compare with this. @return true if this MenuShortcut is the same as another, false otherwise. @since JDK1.1

public equals (obj : Object) : boolean
Parameters
obj
Type Object
Direction inout
Multiplicity Unspecified
Query false
Static false
Leaf false
Documentation Returns whether this MenuShortcut is the same as another: equality is defined to mean that both MenuShortcuts use the same key and both either use or don't use the SHIFT key. @param obj the Object to compare with this. @return true if this MenuShortcut is the same as another, false otherwise. @since 1.2

public hashCode () : int
Query false
Static false
Leaf false
Documentation Returns the hashcode for this MenuShortcut. @return the hashcode for this MenuShortcut. @since 1.2

public toString () : String
Query false
Static false
Leaf false
Documentation Returns an internationalized description of the MenuShortcut. @return a string representation of this MenuShortcut. @since JDK1.1

protected paramString () : String
Query false
Static false
Leaf false
Documentation Returns the parameter string representing the state of this MenuShortcut. This string is useful for debugging. @return the parameter string of this MenuShortcut. @since JDK1.1

Relationships
Unamed Association
From
Name Value
End Model Element MenuItem
Multiplicity Unspecified
Visibility private
Aggregation Kind None
Navigable false
Derived false
Abstract false
Leaf false
Visibility Unspecified

Sequence Diagram
Create Account level 1

Summary

Name Documentation
: FAS Online System  
CombinedFragment
Shipper  
request accept
request reject

Details

: FAS Online System
Name Value
Multiplicity Unspecified
Base Classifier FAS Online System
Active false
Stopped false
Multi Object false

Relationships
Web page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 1
Asynchronous false

request create account : Message
From
Name Value
End Model Element Shipper
Type Message
Sequence Number 2
Asynchronous false

create account page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 3
Asynchronous false

submit user details : Message
From
Name Value
End Model Element Shipper
Type Message
Sequence Number 4
Asynchronous false

login page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 5
Asynchronous false

reject message, page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 6
Asynchronous false

CombinedFragment
Name Value
Operator Kind alt

Interaction Operands
Value
request accept
request reject

Covered LifeLines
Name Documentation
N/A  
Shipper  

Shipper
Name Value
Active false
Visibility public
Abstract false
Leaf false
Root false

Relationships
Web page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 1
Asynchronous false

request create account : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 2
Asynchronous false

create account page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 3
Asynchronous false

submit user details : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 4
Asynchronous false

login page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 5
Asynchronous false

reject message, page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 6
Asynchronous false

request accept

request reject

Sequence Diagram
Create Account level 2

Summary

Name Documentation
: JBoss Web Server  
: MYSQL Database  
: FAS ORM Library  
CombinedFragment
Shipper  
request accept  
request reject  

Details

: JBoss Web Server
Name Value
Multiplicity Unspecified
Base Classifier JBoss Web Server
Active false
Stopped false
Multi Object false

Relationships
Web page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 1
Asynchronous false

request create account : Message
From
Name Value
End Model Element Shipper
Type Message
Sequence Number 2
Asynchronous false

create account page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 3
Asynchronous false

submit user details : Message
From
Name Value
End Model Element Shipper
Type Message
Sequence Number 4
Asynchronous false

load customer by login ID and password : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 5
Asynchronous false

result : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 9
Asynchronous false

save new customer : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 10
Asynchronous false

login page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 12
Asynchronous false

reject message, page : Message
To
Name Value
End Model Element Shipper
Type Message
Sequence Number 13
Asynchronous false

: MYSQL Database
Name Value
Multiplicity Unspecified
Base Classifier MYSQL Database
Active false
Stopped false
Multi Object false

Relationships
load customer by login ID and password : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 7
Asynchronous false

result : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 8
Asynchronous false

save new customer : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 11
Asynchronous false

: FAS ORM Library
Name Value
Multiplicity Unspecified
Base Classifier FAS ORM Library
Active false
Stopped false
Multi Object false

Relationships
load customer by login ID and password : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 5
Asynchronous false

load customer by login ID and password : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 7
Asynchronous false

result : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 8
Asynchronous false

result : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 9
Asynchronous false

save new customer : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 10
Asynchronous false

save new customer : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 11
Asynchronous false

CombinedFragment
Name Value
Operator Kind alt

Interaction Operands
Value
request accept
request reject

Covered LifeLines
Name Documentation
Shipper  
N/A  
N/A  
N/A  

Shipper
Name Value
Active false
Visibility public
Abstract false
Leaf false
Root false

Relationships
Web page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 1
Asynchronous false

request create account : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 2
Asynchronous false

create account page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 3
Asynchronous false

submit user details : Message
To
Name Value
End Model Element N/A
Type Message
Sequence Number 4
Asynchronous false

login page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 12
Asynchronous false

reject message, page : Message
From
Name Value
End Model Element N/A
Type Message
Sequence Number 13
Asynchronous false

request accept

request reject

Entity Relationship Diagram
Entity Relationship Diagram1

Summary

Name Documentation
ORM_Shipment
ORM_TrackingInfo
ORM_User A user is an entity that asks for shipment.

Details

ORM_Shipment
Name Value
Class Model ORM_Shipment

Columns
Name Data type PK/FK Nullable Documentation
receiverCompanyName varchar Yes The company name of the receiver, which can be null.
receiverDeliveryAddress varchar Yes The address where the courier was delivered to.
receiverCity varchar Yes The city where the receiver is in.
receiverZipPostal int Yes Six digit numeric zip code representing the receiver location.
receiverStateProvince varchar Yes The name of the state where the receiver is in.
receiverCountry varchar Yes The name of the country where the receiver is in.
receiverContactPerson varchar Yes The name of the person who received the courier.
receiverPhone varchar Yes

The phone number of the receiver.

receiverEmail varchar Yes The email address of receiver. This will be used for notification purposes.
weight float No The weight of the courier.
length float No The length of the courier.
width float No The width of the courier.
height float No The height of the courier.
description varchar Yes Any additional information about the shipment.
delivered tinyint No

A flag to indicate whether the shipment is delivered.

signedBy varchar Yes The name of person who signed for the receive of courier.
cost float No The cost of that shipment.
paid tinyint No A flag to indicate whether the shipment has been settled or not.
schedulePickupTime int No
dateTime datetime Yes The date which the courier was delivered.
ID int PK No A number to uniquely identify the courier.
ORM_UserID int FK Yes

Relationships
trackingInfo : Relationship
To ORM_TrackingInfo
Identifying false
From Phrase ORM_Shipment
To Phrase trackingInfo
To Multiplicity 0..*
From Multiplicity 1

Unamed Relationship
From ORM_User
Identifying false
From Phrase shipper
To Phrase shipment
To Multiplicity 0..*
From Multiplicity 1

ORM_TrackingInfo
Name Value
Class Model ORM_TrackingInfo

Columns
Name Data type PK/FK Nullable Documentation
dateTime datetime Yes
activity varchar Yes
location varchar Yes A text to represent the location of the tracking record.
comments varchar Yes Remarks to the track record.
ID int PK No A number to uniquely identify the tracking info.
ORM_ShipmentID int FK Yes
ORM_ShipmentIndex int Yes
ORM_UserID int FK No

Relationships
trackingInfo : Relationship
From ORM_Shipment
Identifying false
From Phrase ORM_Shipment
To Phrase trackingInfo
To Multiplicity 0..*
From Multiplicity 1

Unamed Relationship
From ORM_User
Identifying false
From Phrase staff
To Phrase trackingInfo
To Multiplicity 0..*
From Multiplicity 1

ORM_User
Name Value
Discriminator Discriminator
Class Model ORM_User
Documentation A user is an entity that asks for shipment.

Columns
Name Data type PK/FK Nullable Documentation
ID int PK No A number to uniquely identify the user.
password varchar Yes The password is a text used for validating the user identity.
loginID varchar Yes The login ID is for identifying the user.
position varchar Yes The positionn is the position of the user in his/her company.
Discriminator varchar No
contactPerson varchar Yes The name of user.
email varchar Yes The email address of user.
phone varchar Yes Phone number of user.
ext varchar Yes Extension of phone number.
companyName varchar Yes The name of the company where user is working at.
address varchar Yes Postal address of user.
city varchar Yes The city where the user is in.
zipPostal int Yes Ten digit numeric zip code representing the user location.
stateProvince varchar Yes The name of the state where the user is in.
country varchar Yes The name of the country where the user is in.
creditCardType varchar Yes Credit card information for settling payments.
creditCardNo varchar Yes Credit card information for settling payments.
creditCardExpires datetime Yes Credit card information for settling payments.
debit float Yes Debit for a user.

Relationships
Unamed Relationship
To ORM_Shipment
Identifying false
From Phrase shipper
To Phrase shipment
To Multiplicity 0..*
From Multiplicity 1

Unamed Relationship
To ORM_TrackingInfo
Identifying false
From Phrase staff
To Phrase trackingInfo
To Multiplicity 0..*
From Multiplicity 1