JLabel.AccessibleJLabel (Java SE 14 & JDK 14)
Description: declaration: module: java.desktop, package: javax.swing, class: JLabel, class: AccessibleJLabel
Keywords: javax.swing.JLabel.AccessibleJLabel class

Module java.desktop
Package javax.swing

# Class JLabel.AccessibleJLabel

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.JLabel.AccessibleJLabel

All Implemented Interfaces:
  `Serializable`, `AccessibleComponent`, `AccessibleExtendedComponent`, `AccessibleText`

Enclosing class:
  JLabel

    protected class JLabel.AccessibleJLabel
    extends JComponent.AccessibleJComponent
    implements AccessibleText, AccessibleExtendedComponent

The class used to obtain the accessible role for this object.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the `java.beans` package. Please see `XMLEncoder`.

- ## Nested Class Summary

  ## Nested classes/interfaces declared in class javax.swing.JComponent.AccessibleJComponent

  `JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler`

  ## Nested classes/interfaces declared in class java.awt.Component.AccessibleAWTComponent

  `Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler`

- ## Field Summary

  ### Fields declared in class javax.swing.JComponent.AccessibleJComponent

  `accessibleFocusHandler`

  ### Fields declared in class java.awt.Container.AccessibleAWTContainer

  `accessibleContainerHandler`

  ### Fields declared in class java.awt.Component.AccessibleAWTComponent

  `accessibleAWTComponentHandler, accessibleAWTFocusHandler`

  ### Fields declared in 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 declared in interface javax.accessibility.AccessibleText

  `CHARACTER, SENTENCE, WORD`

- ## Constructor Summary

  Constructors
  Modifier | Constructor | Description
  --- | --- | ---
  `protected` | `AccessibleJLabel()` |

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `AccessibleIcon[]` | `getAccessibleIcon()` | Get the AccessibleIcons associated with this object if one or more exist.
  `AccessibleKeyBinding` | `getAccessibleKeyBinding()` | Returns key bindings associated with this object
  `String` | `getAccessibleName()` | Get the accessible name of this object.
  `AccessibleRelationSet` | `getAccessibleRelationSet()` | Get the AccessibleRelationSet associated with this object if one exists.
  `AccessibleRole` | `getAccessibleRole()` | Get the role of this object.
  `String` | `getAfterIndex​(int part, int index)` | Returns the String after a given index.
  `String` | `getAtIndex​(int part, int index)` | Returns the String at a given index.
  `String` | `getBeforeIndex​(int part, int index)` | Returns the String before a given index.
  `int` | `getCaretPosition()` | Return the zero-based offset of the caret.
  `AttributeSet` | `getCharacterAttribute​(int i)` | Return the AttributeSet for a given character at a given index
  `Rectangle` | `getCharacterBounds​(int i)` | Returns the bounding box of the character at the given index in the string.
  `int` | `getCharCount()` | Return the number of characters (valid indicies)
  `int` | `getIndexAtPoint​(Point p)` | Given a point in local coordinates, return the zero-based index of the character under that Point.
  `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.
  `String` | `getTitledBorderText()` | Returns the titled border text
  `String` | `getToolTipText()` | Returns the tool tip text

  ### Methods declared in class javax.swing.JComponent.AccessibleJComponent

  `addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleStateSet, getBorderTitle, removePropertyChangeListener`

  ### Methods declared in class java.awt.Container.AccessibleAWTContainer

  `getAccessibleAt`

  ### Methods declared in class java.awt.Component.AccessibleAWTComponent

  `addFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible`

  ### Methods declared in class javax.accessibility.AccessibleContext

  `firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent`

  ### Methods declared in class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods declared in interface javax.accessibility.AccessibleComponent

  `addFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible`

- ## Constructor Details

  - ### AccessibleJLabel

    protected AccessibleJLabel()

- ## Method Details

  - ### getAccessibleName

    public String getAccessibleName()
    Get the accessible name of this object.
    Overrides:
      `getAccessibleName` in class `JComponent.AccessibleJComponent`
    Returns:
      the localized name of the object -- can be null if this object does not have a name
    See Also:
      `AccessibleContext.setAccessibleName(java.lang.String)`

  - ### getAccessibleRole

    public AccessibleRole getAccessibleRole()
    Get the role of this object.
    Overrides:
      `getAccessibleRole` in class `JComponent.AccessibleJComponent`
    Returns:
      an instance of AccessibleRole describing the role of the object
    See Also:
      `AccessibleRole`

  - ### getAccessibleIcon

    public AccessibleIcon[] getAccessibleIcon()
    Get the AccessibleIcons associated with this object if one or more exist. Otherwise return null.
    Overrides:
      `getAccessibleIcon` in class `AccessibleContext`
    Returns:
      an array of `AccessibleIcon` if supported by object; otherwise return `null`
    Since:
      1.3
    See Also:
      `AccessibleIcon`

  - ### getAccessibleRelationSet

    public AccessibleRelationSet getAccessibleRelationSet()
    Get the AccessibleRelationSet associated with this object if one exists. Otherwise return null.
    Overrides:
      `getAccessibleRelationSet` in class `AccessibleContext`
    Returns:
      an `AccessibleRelationSet` if supported by object; otherwise return `null`
    Since:
      1.3
    See Also:
      `AccessibleRelation`

  - ### getIndexAtPoint

    public int getIndexAtPoint​(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 `AccessibleText`
    Parameters:
      `p` - the Point in local coordinates
    Returns:
      the zero-based index of the character under Point p; if Point is invalid returns -1.
    Since:
      1.3

  - ### getCharacterBounds

    public Rectangle getCharacterBounds​(int i)
    Returns the bounding box of the character at the given index in the string. The bounds are returned in local coordinates. If the index is invalid, `null` is returned.
    Specified by:
      `getCharacterBounds` in interface `AccessibleText`
    Parameters:
      `i` - the index into the String
    Returns:
      the screen coordinates of the character's bounding box. If the index is invalid, `null` is returned.
    Since:
      1.3

  - ### getCharCount

    public int getCharCount()
    Return the number of characters (valid indicies)
    Specified by:
      `getCharCount` in interface `AccessibleText`
    Returns:
      the number of characters
    Since:
      1.3

  - ### getCaretPosition

    public int getCaretPosition()
    Return 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 `AccessibleText`
    Returns:
      the zero-based offset of the caret.
    Since:
      1.3

  - ### getAtIndex

    public String getAtIndex​(int part, int index)
    Returns the String at a given index.
    Specified by:
      `getAtIndex` in interface `AccessibleText`
    Parameters:
      `part` - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
      `index` - an index within the text >= 0
    Returns:
      the letter, word, or sentence, null for an invalid index or part
    Since:
      1.3

  - ### getAfterIndex

    public String getAfterIndex​(int part, int index)
    Returns the String after a given index.
    Specified by:
      `getAfterIndex` in interface `AccessibleText`
    Parameters:
      `part` - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
      `index` - an index within the text >= 0
    Returns:
      the letter, word, or sentence, null for an invalid index or part
    Since:
      1.3

  - ### getBeforeIndex

    public String getBeforeIndex​(int part, int index)
    Returns the String before a given index.
    Specified by:
      `getBeforeIndex` in interface `AccessibleText`
    Parameters:
      `part` - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
      `index` - an index within the text >= 0
    Returns:
      the letter, word, or sentence, null for an invalid index or part
    Since:
      1.3

  - ### getCharacterAttribute

    public AttributeSet getCharacterAttribute​(int i)
    Return the AttributeSet for a given character at a given index
    Specified by:
      `getCharacterAttribute` in interface `AccessibleText`
    Parameters:
      `i` - the zero-based index into the text
    Returns:
      the AttributeSet of the character
    Since:
      1.3

  - ### 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 `AccessibleText`
    Returns:
      the index into the text of the start of the selection
    Since:
      1.3

  - ### 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 `AccessibleText`
    Returns:
      the index into the text of the end of the selection
    Since:
      1.3

  - ### getSelectedText

    public String getSelectedText()
    Returns the portion of the text that is selected.
    Specified by:
      `getSelectedText` in interface `AccessibleText`
    Returns:
      the String portion of the text that is selected
    Since:
      1.3

  - ### getToolTipText

    public String getToolTipText()
    Returns the tool tip text
    Specified by:
      `getToolTipText` in interface `AccessibleExtendedComponent`
    Overrides:
      `getToolTipText` in class `JComponent.AccessibleJComponent`
    Returns:
      the tool tip text, if supported, of the object; otherwise, null
    Since:
      1.4

  - ### getTitledBorderText

    public String getTitledBorderText()
    Returns the titled border text
    Specified by:
      `getTitledBorderText` in interface `AccessibleExtendedComponent`
    Overrides:
      `getTitledBorderText` in class `JComponent.AccessibleJComponent`
    Returns:
      the titled border text, if supported, of the object; otherwise, null
    Since:
      1.4

  - ### getAccessibleKeyBinding

    public AccessibleKeyBinding getAccessibleKeyBinding()
    Returns key bindings associated with this object
    Specified by:
      `getAccessibleKeyBinding` in interface `AccessibleExtendedComponent`
    Overrides:
      `getAccessibleKeyBinding` in class `JComponent.AccessibleJComponent`
    Returns:
      the key bindings, if supported, of the object; otherwise, null
    Since:
      1.4
    See Also:
      `AccessibleKeyBinding`