Index: ChangeLog =================================================================== RCS file: /cvsroot/classpath/classpath/ChangeLog,v retrieving revision 1.2448 diff -u -3 -p -u -r1.2448 ChangeLog --- ChangeLog 31 Aug 2004 22:17:29 -0000 1.2448 +++ ChangeLog 1 Sep 2004 01:31:27 -0000 @@ -1,3 +1,9 @@ +2004-09-01 Andrew John Hughes + + * java/awt/MenuComponent.java, java/awt/MenuBar.java + Implementation of accessibility classes and methods + for these two components. + 2004-08-31 Mark Wielaard * NEWS: Add new news. Index: java/awt/Component.java =================================================================== RCS file: /cvsroot/classpath/classpath/java/awt/Component.java,v retrieving revision 1.39 diff -u -3 -p -u -r1.39 Component.java --- java/awt/Component.java 8 Aug 2004 13:01:35 -0000 1.39 +++ java/awt/Component.java 1 Sep 2004 01:31:29 -0000 @@ -4498,7 +4498,7 @@ p *
  • the set of backward traversal * * @return an AWT 1.0 event representing e */ - private Event translateEvent (AWTEvent e) + static Event translateEvent (AWTEvent e) { Component target = (Component) e.getSource (); Event translated = null; Index: java/awt/MenuBar.java =================================================================== RCS file: /cvsroot/classpath/classpath/java/awt/MenuBar.java,v retrieving revision 1.10 diff -u -3 -p -u -r1.10 MenuBar.java --- java/awt/MenuBar.java 3 Feb 2004 17:17:29 -0000 1.10 +++ java/awt/MenuBar.java 1 Sep 2004 01:31:29 -0000 @@ -45,14 +45,19 @@ import java.io.Serializable; import java.util.Enumeration; import java.util.Vector; +import javax.accessibility.Accessible; +import javax.accessibility.AccessibleContext; +import javax.accessibility.AccessibleRole; + /** * This class implements a menu bar in the AWT system. * * @author Aaron M. Renn (address@hidden) * @author Tom Tromey + * @author Andrew John Hughes */ public class MenuBar extends MenuComponent - implements MenuContainer, Serializable + implements MenuContainer, Serializable, Accessible { /* @@ -78,6 +83,14 @@ private Menu helpMenu; */ private Vector menus = new Vector(); + /** + * The accessible context for this component. + * + * @see #getAccessibleContext() + * @serial ignored. + */ + private transient AccessibleContext accessibleContext; + /*************************************************************************/ /* @@ -353,4 +366,56 @@ deleteShortcut(MenuShortcut shortcut) it.deleteShortcut (); } +/** + * Gets the AccessibleContext associated with this MenuBar. + * The context is created, if necessary. + * + * @return the associated context + */ +public AccessibleContext getAccessibleContext() +{ + /* Create the context if this is the first request */ + if (accessibleContext == null) + { + /* Create the context */ + accessibleContext = new AccessibleAWTMenuBar(); + } + return accessibleContext; +} + +/** + * This class provides accessibility support for AWT menu bars. + * + * @author Andrew John Hughes + */ +protected class AccessibleAWTMenuBar + extends AccessibleAWTMenuComponent +{ + + /** + * Compatible with JDK 1.4.2 revision 5 + */ + private static final long serialVersionUID = -8577604491830083815L; + + /** + * This is the default constructor, which simply calls the default + * constructor of the superclass. + */ + protected AccessibleAWTMenuBar() + { + super(); + } + + /** + * Returns the accessible role relating to the menu bar. + * + * @return AccessibleRole.MENU_BAR. + */ + public AccessibleRole getAccessibleRole() + { + return AccessibleRole.MENU_BAR; + } + +} // class AccessibleAWTMenuBar + } // class MenuBar Index: java/awt/MenuComponent.java =================================================================== RCS file: /cvsroot/classpath/classpath/java/awt/MenuComponent.java,v retrieving revision 1.14 diff -u -3 -p -u -r1.14 MenuComponent.java --- java/awt/MenuComponent.java 26 Dec 2003 16:37:27 -0000 1.14 +++ java/awt/MenuComponent.java 1 Sep 2004 01:31:29 -0000 @@ -38,15 +38,23 @@ exception statement from your version. * package java.awt; +import java.awt.event.FocusEvent; +import java.awt.event.FocusListener; import java.awt.peer.MenuComponentPeer; import java.io.Serializable; - -// FIXME: Java 1.0 event model unimplemented +import java.util.Locale; +import javax.accessibility.Accessible; +import javax.accessibility.AccessibleComponent; +import javax.accessibility.AccessibleContext; +import javax.accessibility.AccessibleRole; +import javax.accessibility.AccessibleSelection; +import javax.accessibility.AccessibleStateSet; /** - * This is the superclass of all non-menu AWT widgets. + * This is the superclass of all menu AWT widgets. * * @author Aaron M. Renn (address@hidden) + * @author Andrew John Hughes */ public abstract class MenuComponent implements Serializable { @@ -59,31 +67,100 @@ public abstract class MenuComponent impl private static final long serialVersionUID = -4536902356223894379L; /*************************************************************************/ - + /* * Instance Variables */ - // FIXME: missing serialized fields `nameExplicitlySet', - // `newEventsOnly', and `accessibleContext'. - -// The font for this component -private Font font; - -// The name of the component -private String name; - -// The parent of this component -transient MenuContainer parent; - -// The native peer for this componet -transient MenuComponentPeer peer; - -// The synchronization locking object for this component -private transient Object tree_lock = this; +/** + * The font for this component. + * + * @see #getFont() + * @see #setFont(java.awt.Font) + * @serial the component's font. + */ + private Font font; -// The toolkit for this object -private static transient Toolkit toolkit = Toolkit.getDefaultToolkit(); + /** + * The name of the component. + * + * @see #getName() + * @see #setName(String) + * @serial the component's name. + */ + private String name; + + /** + * The parent of this component. + * + * @see #getParent() + * @see #setParent(java.awt.MenuContainer) + * @serial ignored. + */ + transient MenuContainer parent; + + /** + * The native peer for this component. + * + * @see #getPeer() + * @see #setPeer(java.awt.peer.MenuComponentPeer) + * @serial ignored. + */ + transient MenuComponentPeer peer; + + /** + * The synchronization locking object for this component. + * + * @serial ignored. + */ + private transient Object tree_lock = this; + + /** + * The toolkit for this object. + * + * @see #getToolkit() + * @serial ignored. + */ + private static transient Toolkit toolkit = Toolkit.getDefaultToolkit(); + + /** + * The accessible context for this component. + * + * @see #getAccessibleContext() + * @serial the accessibility information for this component. + */ + private AccessibleContext accessibleContext; + + /** + * Was the name of the component set? This value defaults + * to false and becomes true after a call to setName(). + * Please note that this does not guarantee that name will then + * be non-null, as this may be the value passed to setName(). + * + * @see #setName(String) + * @serial true if the name value has been explicitly set by calling + * setName(). + */ + private boolean nameExplicitlySet; + + /** + * Does this component handle new events? Events will be handled + * by this component if this is true. Otherwise, they will be forwarded + * up the component hierarchy. + * + * @see #dispatchEvent(AWTEvent) + * @serial true if events are to be processed locally. + */ + private boolean newEventsOnly; + + /** + * The focus listener chain handler which deals with focus events for + * the accessible context of this component. + * + * @see AccessibleAWTMenuComponent#addFocusListener(java.awt.event.FocusListener) + * @serial ignored. + */ + private transient FocusListener focusListener; /*************************************************************************/ @@ -157,6 +234,7 @@ public void setName(String name) { this.name = name; + nameExplicitlySet = true; } /*************************************************************************/ @@ -260,13 +338,14 @@ setTreeLock(Object tree_lock) * AWT 1.0 event dispatcher. * * @deprecated Deprecated in favor of dispatchEvent(). + * @return true if the event was dispatched, false otherwise. */ public boolean postEvent(Event event) { - return(false); + // This is overridden by subclasses that support events. + return false; } - /*************************************************************************/ /** @@ -274,17 +353,35 @@ postEvent(Event event) * * @param event The event to dispatch */ -public final void -dispatchEvent(AWTEvent event) +public final void dispatchEvent(AWTEvent event) { // See comment in Component.dispatchEvent(). dispatchEventImpl(event); } -void -dispatchEventImpl(AWTEvent e) + +/** + * Implementation of dispatchEvent. Allows trusted package classes + * to dispatch additional events first. This implementation first + * translates event to an AWT 1.0 event and sends the + * result to address@hidden #postEvent}. The event is then + * passed on to address@hidden #processEvent} for local processing. + * + * @param event the event to dispatch. + */ +void dispatchEventImpl(AWTEvent event) { + Event oldStyleEvent; + // This is overridden by subclasses that support events. + /* Convert AWT 1.1 event to AWT 1.0 event */ + oldStyleEvent = Component.translateEvent(event); + if (oldStyleEvent != null) + { + postEvent(oldStyleEvent); + } + /* Do local processing */ + processEvent(event); } /*************************************************************************/ @@ -298,6 +395,25 @@ dispatchEventImpl(AWTEvent e) protected void processEvent(AWTEvent event) { + /* + Pass a focus event to the focus listener for + the accessibility context. + */ + if (event instanceof FocusEvent) + { + if (focusListener != null) + { + switch (event.id) + { + case FocusEvent.FOCUS_GAINED: + focusListener.focusGained((FocusEvent) event); + break; + case FocusEvent.FOCUS_LOST: + focusListener.focusLost((FocusEvent) event); + break; + } + } + } } /*************************************************************************/ @@ -316,15 +432,884 @@ toString() /*************************************************************************/ /** - * Returns a debugging string for this component - */ + * Returns a debugging string for this component + */ protected String paramString() { return "name=" + getName(); } -// Accessibility API not yet implemented. -// public AccessibleContext getAccessibleContext() +/** + * Gets the AccessibleContext associated with this MenuComponent. + * As an abstract class, we return null. Concrete subclasses should return + * their implementation of the accessibility context. + * + * @return null. + */ + +public AccessibleContext getAccessibleContext() +{ + return null; +} + +/** + * This class provides a base for the accessibility support of menu + * components. + * + * @author Andrew John Hughes + */ +protected abstract class AccessibleAWTMenuComponent + extends AccessibleContext + implements Serializable, AccessibleComponent, AccessibleSelection +{ + + /** + * Compatible with JDK 1.4.2 revision 5 + */ + private static final long serialVersionUID = -4269533416223798698L; + + /** + * This is the default constructor. It should be called by + * concrete subclasses to ensure necessary groundwork is completed. + */ + protected AccessibleAWTMenuComponent() + { + } + + /** + * Replaces or supplements the component's selection with the + * Accessible child at the supplied index. If + * the component supports multiple selection, the child is + * added to the current selection. Otherwise, the current + * selection becomes the specified child. If the child is + * already selected, nothing happens. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param index the index of the specified child within a + * zero-based list of the component's children. + */ + public void addAccessibleSelection(int index) + { + /* Subclasses with children should implement this */ + } + + /** + * Registers the specified focus listener to receive + * focus events from this component. + * + * @param listener the new focus listener. + */ + public void addFocusListener(FocusListener listener) + { + /* + * Chain the new focus listener to the existing chain + * of focus listeners. Each new focus listener is + * coupled via multicasting to the existing chain. + */ + focusListener = AWTEventMulticaster.add(focusListener, listener); + } + + /** + * Clears the component's current selection. Following + * the calling of this method, no children of the component + * will be selected. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + */ + public void clearAccessibleSelection() + { + } + + /** + * Returns true if the specified point lies within the + * component. The supplied co-ordinates are assumed to + * be relative to the co-ordinate system of the component + * itself. Thus, the point (0,0) is the upper left corner + * of this component. + *
    + *
    + * Please note that this method depends on a correctly implemented + * version of the getBounds() method. Subclasses + * must provide the bounding rectangle via getBounds() + * in order for this method to work. + * + * @param point the point to check against this component. + * @return true if the point is within this component. + * @see #getBounds() + */ + public boolean contains(Point point) + { + /* + We can simply return the result of a + test for containment in the bounding rectangle + */ + return getBounds().contains(point); + } + + /** + * Returns the Accessible child of this component present + * at the specified point. The supplied co-ordinates are + * assumed to be relative to the co-ordinate system of this + * component (the parent of any returned accessible). Thus, + * the point (0,0) is the upper left corner of this menu + * component. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param point the point at which the returned accessible + * is located. + * @return null. + */ + public Accessible getAccessibleAt(Point point) + { + return null; + } + + /** + * Returns the Accessible child at the supplied + * index within the list of children of this component. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param index the index of the Accessible child + * to retrieve. + * @return null. + */ + public Accessible getAccessibleChild(int index) + { + return null; + } + + /** + * Returns the number of children of this component which + * implement the Accessible interface. If + * all children of this component are accessible, then + * the returned value will be the same as the number of + * children. + *
    + *
    + * + * @return 0. + */ + public int getAccessibleChildrenCount() + { + return 0; + } + + /** + * Retrieves the AccessibleComponent associated + * with this accessible context and its component. As the + * context itself implements AccessibleComponent, + * this is the return value. + * + * @return the context itself. + */ + public AccessibleComponent getAccessibleComponent() + { + return this; + } + + /** + * Returns the accessible name for this menu component. This + * is the name given to the component, which may be null if + * not set using setName(). + *
    + *
    + * The name is not the most appropriate description of this + * object. Subclasses should preferably provide a more + * accurate description. For example, a File menu could + * have the description `Lists commands related to the + * file system'. + * + * @return a description of the component. Currently, + * this is just the contents of the name property. + * @see MenuComponent#setName(String) + */ + public String getAccessibleDescription() + { + return MenuComponent.this.getName(); + } + + /** + * Retrieves the index of this component within its parent. + * If no parent exists, -1 is returned. + * + * @return -1 as the parent, a MenuContainer + * is not Accessible. + */ + public int getAccessibleIndexInParent() + { + return -1; + } + + /** + * Returns the accessible name of this component. This + * is the name given to the component, which may be null if + * not set using setName(). + *
    + *
    + * The name property is not the most suitable string to return + * for this method. The string should be localized, and + * relevant to the operation of the component. For example, + * it could be the text of a menu item. However, this can + * not be used at this level of abstraction, so it is the + * responsibility of subclasses to provide a more appropriate + * name. + * + * @return a localized name for this component. Currently, this + * is just the contents of the name property. + * @see MenuComponent#setName(String) + */ + public String getAccessibleName() + { + return MenuComponent.this.getName(); + } + + /** + * Returns the Accessible parent of this component. + * As the parent of a MenuComponent is a + * MenuContainer, which doesn't implement + * Accessible, this method returns null. + * + * @return null. + */ + public Accessible getAccessibleParent() + { + return null; + } + + /** + * Returns the accessible role of this component. + *
    + *
    + * The abstract implementation of this method returns + * AccessibleRole.AWT_COMPONENT, + * as the abstract component has no specific role. This + * method should be overridden by concrete subclasses, so + * as to return an appropriate role for the component. + * + * @return AccessibleRole.AWT_COMPONENT. + */ + public AccessibleRole getAccessibleRole() + { + return AccessibleRole.AWT_COMPONENT; + } + + /** + * Retrieves the AccessibleSelection associated + * with this accessible context and its component. As the + * context itself implements AccessibleSelection, + * this is the return value. + * + * @return the context itself. + */ + public AccessibleSelection getAccessibleSelection() + { + return this; + } + + /** + * Retrieves the Accessible selected child + * at the specified index. If there are no selected children + * or the index is outside the range of selected children, + * null is returned. Please note that the index refers + * to the index of the child in the list of selected + * children, and not the index of the child in + * the list of all Accessible children. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param index the index of the selected Accessible + * child. + */ + public Accessible getAccessibleSelection(int index) + { + return null; + } + + /** + * Returns a count of the number of Accessible + * children of this component which are currently selected. + * If there are no children currently selected, 0 is returned. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @return 0. + */ + public int getAccessibleSelectionCount() + { + return 0; + } + + /** + * Retrieves the current state of this component + * in an accessible form. For example, a given component + * may be visible, selected, disabled, etc. + *
    + *
    + * As this class tells us virtually nothing about the component, + * except for its name and font, no state information can be + * provided. This implementation thus returns an empty + * state set, and it is left to concrete subclasses to provide + * a more acceptable and relevant state set. Changes to these + * properties also need to be handled using + * PropertyChangeListeners. + * + * @return an empty AccessibleStateSet. + */ + public AccessibleStateSet getAccessibleStateSet() + { + return new AccessibleStateSet(); + } + + /** + * Returns the background color of the component, or null + * if this property is unsupported. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply returns the + * default system background color used for rendering menus. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @return the default system background color for menus. + * @see #setBackground(java.awt.Color) + */ + public Color getBackground() + { + return SystemColor.menu; + } + + /** + * Returns a Rectangle which represents the + * bounds of this component. The returned rectangle has the + * height and width of the component's bounds, and is positioned + * at a location relative to this component's parent, the + * MenuContainer. null is returned if bounds + * are not supported by the component. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply returns null. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @return null. + * @see #setBounds(java.awt.Rectangle) + */ + public Rectangle getBounds() + { + return null; + } + + /** + * Returns the Cursor displayed when the pointer + * is positioned over this component. Alternatively, null + * is returned if the component doesn't support the cursor + * property. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply returns the default + * system cursor. Concrete subclasses which handle the drawing + * of an onscreen menu component may override this method and provide + * the appropriate information. + * + * @return the default system cursor. + * @see #setCursor(java.awt.Cursor) + */ + public Cursor getCursor() + { + return Cursor.getDefaultCursor(); + } + + /** + * Returns the Font used for text created by this component. + * + * @return the current font. + * @see #setFont(java.awt.Font) + */ + public Font getFont() + { + return MenuComponent.this.getFont(); + } + + /** + * Retrieves information on the rendering and metrics of the supplied + * font. If font metrics are not supported by this component, null + * is returned. + *
    + *
    + * The abstract implementation of this method simply uses the toolkit + * to obtain the FontMetrics. Concrete subclasses may + * find it more efficient to invoke their peer class directly, if one + * is available. + * + * @param font the font about which to retrieve rendering and metric + * information. + * @return the metrics of the given font, as provided by the system + * toolkit. + * @throws NullPointerException if the supplied font was null. + */ + public FontMetrics getFontMetrics(Font font) + { + return MenuComponent.this.getToolkit().getFontMetrics(font); + } + + /** + * Returns the foreground color of the component, or null + * if this property is unsupported. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply returns the + * default system text color used for rendering menus. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @return the default system text color for menus. + * @see #setForeground(java.awt.Color) + */ + public Color getForeground() + { + return SystemColor.menuText; + } + + /** + * Returns the locale currently in use by this component. + *
    + *
    + * This abstract class has no property relating to the + * locale used by the component, so this method simply + * returns the default locale for the current instance + * of the Java Virtual Machine (JVM). Concrete subclasses + * which maintain such a property should override this method + * and provide the locale information more accurately. + * + * @return the default locale for this JVM instance. + */ + public Locale getLocale() + { + return Locale.getDefault(); + } + + /** + * Returns the location of the component, with co-ordinates + * relative to the parent component and using the co-ordinate + * space of the screen. Thus, the point (0,0) is the upper + * left corner of the parent component. + *
    + *
    + * Please note that this method depends on a correctly implemented + * version of the getBounds() method. Subclasses + * must provide the bounding rectangle via getBounds() + * in order for this method to work. + * + * @return the location of the component, relative to its parent. + * @see #setLocation(java.awt.Point) + */ + public Point getLocation() + { + /* Simply return the location of the bounding rectangle */ + return getBounds().getLocation(); + } + + /** + * Returns the location of the component, with co-ordinates + * relative to the screen. Thus, the point (0,0) is the upper + * left corner of the screen. null is returned if the component + * is either not on screen or if this property is unsupported. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply returns null. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @return the location of the component, relative to the screen. + */ + public Point getLocationOnScreen() + { + return null; + } + + /** + * Returns the size of the component. + *
    + *
    + * Please note that this method depends on a correctly implemented + * version of the getBounds() method. Subclasses + * must provide the bounding rectangle via getBounds() + * in order for this method to work. + * + * @return the size of the component. + * @see #setSize(java.awt.Dimension) + */ + public Dimension getSize() + { + /* Simply return the size of the bounding rectangle */ + return getBounds().getSize(); + } + + /** + * Returns true if the accessible child specified by the supplied index + * is currently selected. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param index the index of the accessible child to check for selection. + * @return false. + */ + public boolean isAccessibleChildSelected(int index) + { + return false; + } + + /** + * Returns true if this component is currently enabled. + *
    + *
    + * As this abstract component has no properties related to + * its enabled or disabled state, the implementation of this + * method is left to subclasses. + * + * @return false. + * @see #setEnabled(boolean) + */ + public boolean isEnabled() + { + return false; + } + + /** + * Returns true if this component is included in the traversal + * of the current focus from one component to the other. + *
    + *
    + * As this abstract component has no properties related to + * its ability to accept the focus, the implementation of this + * method is left to subclasses. + * + * @return false. + */ + public boolean isFocusTraversable() + { + return false; + } + + /** + * Returns true if the component is being shown on screen. + * A component is determined to be shown if it is visible, + * and each parent component is also visible. Please note + * that, even when a component is showing, it may still be + * obscured by other components in front. This method only + * determines if the component is being drawn on the screen. + *
    + *
    + * As this abstract component and its parent have no properties + * relating to visibility, the implementation of this method is + * left to subclasses. + * + * @return false. + * @see #isVisible() + */ + public boolean isShowing() + { + return false; + } + + /** + * Returns true if the component is visible. A component may + * be visible but not drawn on the screen if one of its parent + * components is not visible. To determine if the component is + * actually drawn on screen, isShowing() should be + * used. + *
    + *
    + * As this abstract component has no properties relating to its + * visibility, the implementation of this method is left to subclasses. + * + * @return false. + * @see #isShowing() + * @see #setVisible(boolean) + */ + public boolean isVisible() + { + return false; + } + + /** + * Removes the accessible child specified by the supplied index from + * the list of currently selected children. If the child specified + * is not selected, nothing happens. + *
    + *
    + * As the existence of children can not be determined from + * this abstract class, the implementation of this method + * is left to subclasses. + * + * @param index the index of the Accessible child. + */ + public void removeAccessibleSelection(int index) + { + /* Subclasses with children should implement this */ + } + + /** + * Removes the specified focus listener from the list of registered + * focus listeners for this component. + * + * @param listener the listener to remove. + */ + public void removeFocusListener(FocusListener listener) + { + /* Remove the focus listener from the chain */ + focusListener = AWTEventMulticaster.remove(focusListener, listener); + } + + /** + * Requests that this component gains focus. This depends on the + * component being focus traversable. + *
    + *
    + * As this abstract component has no properties relating to its + * focus traversability, or access to a peer with request focusing + * abilities, the implementation of this method is left to subclasses. + */ + public void requestFocus() + { + /* Ignored */ + } + + /** + * Selects all Accessible children of this component which + * it is possible to select. The component needs to support multiple + * selections. + *
    + *
    + * This abstract component provides a simplistic implementation of this + * method, which ignores the ability of the component to support multiple + * selections and simply uses addAccessibleSelection to + * add each Accessible child to the selection. The last + * Accessible component is thus selected for components + * which don't support multiple selections. Concrete implementations should + * override this with a more appopriate and efficient implementation, which + * properly takes into account the ability of the component to support multiple + * selections. + */ + public void selectAllAccessibleSelection() + { + /* Simply call addAccessibleSelection() on all accessible children */ + for (int a = 0; a < getAccessibleChildrenCount(); ++a) + { + addAccessibleSelection(a); + } + } + + /** + * Sets the background color of the component to that specified. + * Unspecified behaviour occurs when null is given as the new + * background color. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply ignores the supplied + * color and continues to use the default system color. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @param color the new color to use for the background. + * @see getBackground() + */ + public void setBackground(Color color) + { + /* Ignored */ + } + + /** + * Sets the height and width of the component, and its position + * relative to this component's parent, to the values specified + * by the supplied rectangle. Unspecified behaviour occurs when + * null is given as the new bounds. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply ignores the new + * rectangle and continues to return null from getBounds(). + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @param rectangle a rectangle which specifies the new bounds of + * the component. + * @see #getBounds() + */ + public void setBounds(Rectangle rectangle) + { + /* Ignored */ + } + + /** + * Sets the Cursor used when the pointer is positioned over the + * component. Unspecified behaviour occurs when null is given as the new + * cursor. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply ignores the new cursor + * and continues to return the default system cursor. Concrete + * subclasses which handle the drawing of an onscreen menu component + * may override this method and provide the appropriate information. + * + * @param cursor the new cursor to use. + * @see #getCursor() + */ + public void setCursor(Cursor cursor) + { + /* Ignored */ + } + + /** + * Sets the enabled/disabled state of this component. + *
    + *
    + * As this abstract component has no properties related to + * its enabled or disabled state, the implementation of this + * method is left to subclasses. + * + * @param enabled true if the component should be enabled, + * false otherwise. + * @see #getEnabled() + */ + public void setEnabled(boolean enabled) + { + /* Ignored */ + } + + /** + * Sets the Font used for text created by this component. + * Unspecified behaviour occurs when null is given as the new + * font. + * + * @param font the new font to use for text. + * @see #getFont() + */ + public void setFont(Font font) + { + /* Call the method of the enclosing component */ + MenuComponent.this.setFont(font); + } + + /** + * Sets the foreground color of the component to that specified. + * Unspecified behaviour occurs when null is given as the new + * background color. + *
    + *
    + * This abstract class knows nothing about how the component + * is drawn on screen, so this method simply ignores the supplied + * color and continues to return the default system text color used + * for rendering menus. + * Concrete subclasses which handle the drawing of an onscreen + * menu component should override this method and provide + * the appropriate information. + * + * @param color the new foreground color. + * @see #getForeground() + */ + public void setForeground(Color color) + { + /* Ignored */ + } + + /** + * Sets the location of the component, with co-ordinates + * relative to the parent component and using the co-ordinate + * space of the screen. Thus, the point (0,0) is the upper + * left corner of the parent component. + *
    + *
    + * Please note that this method depends on a correctly implemented + * version of the getBounds() method. Subclasses + * must provide the bounding rectangle via getBounds() + * in order for this method to work. + * + * @param point the location of the component, relative to its parent. + * @see #getLocation() + */ + public void setLocation(Point point) + { + getBounds().setLocation(point); + } + + /** + * Sets the size of the component. + *
    + *
    + * Please note that this method depends on a correctly implemented + * version of the getBounds() method. Subclasses + * must provide the bounding rectangle via getBounds() + * in order for this method to work. + * + * @param size the new size of the component. + * @see #getSize() + */ + public void setSize(Dimension size) + { + getBounds().setSize(size); + } + + /** + * Sets the visibility state of the component. A component may + * be visible but not drawn on the screen if one of its parent + * components is not visible. To determine if the component is + * actually drawn on screen, isShowing() should be + * used. + *
    + *
    + * As this abstract component has no properties relating to its + * visibility, the implementation of this method is left to subclasses. + * + * @param visibility the new visibility of the component -- true if + * the component is visible, false if not. + * @see #isShowing() + * @see #isVisible() + */ + public void setVisible(boolean visibility) + { + /* Ignored */ + } + +} /* class AccessibleAWTMenuComponent */ + -} // class Component +} // class MenuComponent