Class GuaranteedProgressMonitor.AccessibleProgressMonitor

  • All Implemented Interfaces:
    java.beans.PropertyChangeListener, java.util.EventListener, javax.accessibility.AccessibleText, javax.swing.event.ChangeListener
    Enclosing class:
    GuaranteedProgressMonitor

    protected class GuaranteedProgressMonitor.AccessibleProgressMonitor
    extends javax.accessibility.AccessibleContext
    implements javax.accessibility.AccessibleText, javax.swing.event.ChangeListener, java.beans.PropertyChangeListener
    AccessibleProgressMonitor implements accessibility support for the ProgressMonitor class.
    Since:
    1.5
    • Field Summary

      • Fields inherited from class javax.accessibility.AccessibleContext

        ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent
      • Fields inherited from interface javax.accessibility.AccessibleText

        CHARACTER, SENTENCE, WORD
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AccessibleProgressMonitor()
      AccessibleProgressMonitor constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.accessibility.Accessible getAccessibleChild​(int i)
      Returns the specified Accessible child of the object.
      int getAccessibleChildrenCount()
      Returns the number of accessible children of the object.
      javax.accessibility.AccessibleComponent getAccessibleComponent()
      Gets the AccessibleComponent associated with this object that has a graphical representation.
      java.lang.String getAccessibleDescription()
      Gets the accessibleDescription property of this object.
      int getAccessibleIndexInParent()
      Gets the 0-based index of this object in its accessible parent.
      java.lang.String getAccessibleName()
      Gets the accessibleName property of this object.
      javax.accessibility.Accessible getAccessibleParent()
      Gets the Accessible parent of this object.
      javax.accessibility.AccessibleRole getAccessibleRole()
      Gets the role of this object.
      javax.accessibility.AccessibleStateSet getAccessibleStateSet()
      Gets the state set of this object.
      javax.accessibility.AccessibleText getAccessibleText()
      Gets the AccessibleText associated with this object presenting text on the display.
      javax.accessibility.AccessibleValue getAccessibleValue()
      Gets the AccessibleValue associated with this object that supports a Numerical value.
      java.lang.String getAfterIndex​(int part, int index)
      Returns the String after a given index.
      java.lang.String getAtIndex​(int part, int index)
      Returns the String at a given index.
      java.lang.String getBeforeIndex​(int part, int index)
      Returns the String before a given index.
      int getCaretPosition()
      Returns the zero-based offset of the caret.
      javax.swing.text.AttributeSet getCharacterAttribute​(int i)
      Returns the AttributeSet for a given character at a given index
      java.awt.Rectangle getCharacterBounds​(int i)
      Determines the bounding box of the character at the given index into the string.
      int getCharCount()
      Returns the number of characters (valid indicies)
      int getIndexAtPoint​(java.awt.Point p)
      Given a point in local coordinates, return the zero-based index of the character under that Point.
      java.util.Locale getLocale()
      Gets the locale of the component.
      java.lang.String getSelectedText()
      Returns the portion of the text that is selected.
      int getSelectionEnd()
      Returns the end offset within the selected text.
      int getSelectionStart()
      Returns the start offset within the selected text.
      void propertyChange​(java.beans.PropertyChangeEvent e)
      This method gets called when a bound property is changed.
      void stateChanged​(javax.swing.event.ChangeEvent e)
      Invoked when the target of the listener has changed its state.
      • Methods inherited from class javax.accessibility.AccessibleContext

        addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AccessibleProgressMonitor

        protected AccessibleProgressMonitor()
        AccessibleProgressMonitor constructor
    • Method Detail

      • stateChanged

        public void stateChanged​(javax.swing.event.ChangeEvent e)
        Invoked when the target of the listener has changed its state.
        Specified by:
        stateChanged in interface javax.swing.event.ChangeListener
        Parameters:
        e - a ChangeEvent object. Must not be null.
        Throws:
        java.lang.NullPointerException - if the parameter is null.
      • propertyChange

        public void propertyChange​(java.beans.PropertyChangeEvent e)
        This method gets called when a bound property is changed.
        Specified by:
        propertyChange in interface java.beans.PropertyChangeListener
        Parameters:
        e - A PropertyChangeEvent object describing the event source and the property that has changed. Must not be null.
        Throws:
        java.lang.NullPointerException - if the parameter is null.
      • getAccessibleName

        public java.lang.String getAccessibleName()
        Gets the accessibleName property of this object. The accessibleName property of an object is a localized String that designates the purpose of the object. For example, the accessibleName property of a label or button might be the text of the label or button itself. In the case of an object that doesn't display its name, the accessibleName should still be set. For example, in the case of a text field used to enter the name of a city, the accessibleName for the en_US locale could be 'city.'
        Overrides:
        getAccessibleName in class javax.accessibility.AccessibleContext
        Returns:
        the localized name of the object; null if this object does not have a name
        See Also:
        AccessibleContext.setAccessibleName(java.lang.String)
      • getAccessibleDescription

        public java.lang.String getAccessibleDescription()
        Gets the accessibleDescription property of this object. The accessibleDescription property of this object is a short localized phrase describing the purpose of the object. For example, in the case of a 'Cancel' button, the accessibleDescription could be 'Ignore changes and close dialog box.'
        Overrides:
        getAccessibleDescription in class javax.accessibility.AccessibleContext
        Returns:
        the localized description of the object; null if this object does not have a description
        See Also:
        AccessibleContext.setAccessibleDescription(java.lang.String)
      • getAccessibleRole

        public javax.accessibility.AccessibleRole getAccessibleRole()
        Gets the role of this object. The role of the object is the generic purpose or use of the class of this object. For example, the role of a push button is AccessibleRole.PUSH_BUTTON. The roles in AccessibleRole are provided so component developers can pick from a set of predefined roles. This enables assistive technologies to provide a consistent interface to various tweaked subclasses of components (e.g., use AccessibleRole.PUSH_BUTTON for all components that act like a push button) as well as distinguish between sublasses that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes and AccessibleRole.RADIO_BUTTON for radio buttons).

        Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate.

        Specified by:
        getAccessibleRole in class javax.accessibility.AccessibleContext
        Returns:
        an instance of AccessibleRole describing the role of the object
        See Also:
        AccessibleRole
      • getAccessibleStateSet

        public javax.accessibility.AccessibleStateSet getAccessibleStateSet()
        Gets the state set of this object. The AccessibleStateSet of an object is composed of a set of unique AccessibleStates. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_STATE_PROPERTY property.
        Specified by:
        getAccessibleStateSet in class javax.accessibility.AccessibleContext
        Returns:
        an instance of AccessibleStateSet containing the current state set of the object
        See Also:
        AccessibleStateSet, AccessibleState, AccessibleContext.addPropertyChangeListener(java.beans.PropertyChangeListener)
      • getAccessibleParent

        public javax.accessibility.Accessible getAccessibleParent()
        Gets the Accessible parent of this object.
        Overrides:
        getAccessibleParent in class javax.accessibility.AccessibleContext
        Returns:
        the Accessible parent of this object; null if this object does not have an Accessible parent
      • getAccessibleIndexInParent

        public int getAccessibleIndexInParent()
        Gets the 0-based index of this object in its accessible parent.
        Specified by:
        getAccessibleIndexInParent in class javax.accessibility.AccessibleContext
        Returns:
        the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.
        See Also:
        getAccessibleParent(), getAccessibleChildrenCount(), getAccessibleChild(int)
      • getAccessibleChildrenCount

        public int getAccessibleChildrenCount()
        Returns the number of accessible children of the object.
        Specified by:
        getAccessibleChildrenCount in class javax.accessibility.AccessibleContext
        Returns:
        the number of accessible children of the object.
      • getAccessibleChild

        public javax.accessibility.Accessible getAccessibleChild​(int i)
        Returns the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on.
        Specified by:
        getAccessibleChild in class javax.accessibility.AccessibleContext
        Parameters:
        i - zero-based index of child
        Returns:
        the Accessible child of the object
        See Also:
        getAccessibleChildrenCount()
      • getLocale

        public java.util.Locale getLocale()
                                   throws java.awt.IllegalComponentStateException
        Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.
        Specified by:
        getLocale in class javax.accessibility.AccessibleContext
        Returns:
        this component's locale. If this component does not have a locale, the locale of its parent is returned.
        Throws:
        java.awt.IllegalComponentStateException - If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.
      • getAccessibleComponent

        public javax.accessibility.AccessibleComponent getAccessibleComponent()
        Gets the AccessibleComponent associated with this object that has a graphical representation.
        Overrides:
        getAccessibleComponent in class javax.accessibility.AccessibleContext
        Returns:
        AccessibleComponent if supported by object; else return null
        See Also:
        AccessibleComponent
      • getAccessibleValue

        public javax.accessibility.AccessibleValue getAccessibleValue()
        Gets the AccessibleValue associated with this object that supports a Numerical value.
        Overrides:
        getAccessibleValue in class javax.accessibility.AccessibleContext
        Returns:
        AccessibleValue if supported by object; else return null
        See Also:
        AccessibleValue
      • getAccessibleText

        public javax.accessibility.AccessibleText getAccessibleText()
        Gets the AccessibleText associated with this object presenting text on the display.
        Overrides:
        getAccessibleText in class javax.accessibility.AccessibleContext
        Returns:
        AccessibleText if supported by object; else return null
        See Also:
        AccessibleText
      • getIndexAtPoint

        public int getIndexAtPoint​(java.awt.Point p)
        Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.
        Specified by:
        getIndexAtPoint in interface javax.accessibility.AccessibleText
        Parameters:
        p - the Point in local coordinates
        Returns:
        the zero-based index of the character under Point p; if Point is invalid return -1.
      • getCharacterBounds

        public java.awt.Rectangle getCharacterBounds​(int i)
        Determines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.
        Specified by:
        getCharacterBounds in interface javax.accessibility.AccessibleText
        Parameters:
        i - the index into the String
        Returns:
        the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.
      • getCharCount

        public int getCharCount()
        Returns the number of characters (valid indicies)
        Specified by:
        getCharCount in interface javax.accessibility.AccessibleText
        Returns:
        the number of characters
      • getCaretPosition

        public int getCaretPosition()
        Returns the zero-based offset of the caret. Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).
        Specified by:
        getCaretPosition in interface javax.accessibility.AccessibleText
        Returns:
        the zero-based offset of the caret.
      • getAtIndex

        public java.lang.String getAtIndex​(int part,
                                           int index)
        Returns the String at a given index.
        Specified by:
        getAtIndex in interface javax.accessibility.AccessibleText
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getAfterIndex

        public java.lang.String getAfterIndex​(int part,
                                              int index)
        Returns the String after a given index.
        Specified by:
        getAfterIndex in interface javax.accessibility.AccessibleText
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getBeforeIndex

        public java.lang.String getBeforeIndex​(int part,
                                               int index)
        Returns the String before a given index.
        Specified by:
        getBeforeIndex in interface javax.accessibility.AccessibleText
        Parameters:
        part - the CHARACTER, WORD, or SENTENCE to retrieve
        index - an index within the text
        Returns:
        the letter, word, or sentence
      • getCharacterAttribute

        public javax.swing.text.AttributeSet getCharacterAttribute​(int i)
        Returns the AttributeSet for a given character at a given index
        Specified by:
        getCharacterAttribute in interface javax.accessibility.AccessibleText
        Parameters:
        i - the zero-based index into the text
        Returns:
        the AttributeSet of the character
      • getSelectionStart

        public int getSelectionStart()
        Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.
        Specified by:
        getSelectionStart in interface javax.accessibility.AccessibleText
        Returns:
        the index into the text of the start of the selection
      • getSelectionEnd

        public int getSelectionEnd()
        Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.
        Specified by:
        getSelectionEnd in interface javax.accessibility.AccessibleText
        Returns:
        the index into teh text of the end of the selection
      • getSelectedText

        public java.lang.String getSelectedText()
        Returns the portion of the text that is selected.
        Specified by:
        getSelectedText in interface javax.accessibility.AccessibleText
        Returns:
        the String portion of the text that is selected