org.eclipse.swt.accessibility.AccessibleTextExtendedAdapter

class extends AccessibleTextAdapter implements AccessibleTextExtendedListener 17 members

This adapter class provides default implementations for the methods in the AccessibleTextExtendedListener interface.

Classes that wish to deal with AccessibleTextExtended events can extend this class and override only the methods that they are interested in.

Constructors

new

new ( )

Java: <init>()

Instance Methods

add_selection

add_selection ( AccessibleTextEvent e )

Java: addSelection(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Adds a text selection.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] start - the 0 based offset of the first character of the new selection [in] end - the 0 based offset after the last character of the new selection [out] result - set to `ACC#OK` if the text selection was added

caret_offset=

caret_offset= ( AccessibleTextEvent e )

Java: setCaretOffset(org.eclipse.swt.accessibility.AccessibleTextEvent e) · also: set_caret_offset

Sets the position of the caret.

The caret position is that of the character logically following it, e.g. to the right of it in a left to right language. The caret is actually placed to the leading side of the character with that offset. An offset of 0 places the caret so that the next insertion goes before the first character. An offset of getCharacterCount places the caret so that the next insertion goes after the last character.

Setting the caret position may or may not alter the current selection. A change of the selection is notified to the accessibility event listeners with an EVENT_TEXT_SELECTION_CHANGED event.

When the new caret position differs from the old one, this is notified to the accessibility event listeners with an EVENT_TEXT_CARET_MOVED event.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] offset - the new offset of the caret [out] result - set to `ACC#OK` if the caret position was set

get_character_count

get_character_count ( AccessibleTextEvent e )

Java: getCharacterCount(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the total number of characters in the text.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [out] count - the total number of characters

get_hyperlink

get_hyperlink ( AccessibleTextEvent e )

Java: getHyperlink(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the specified hyperlink.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] index - the 0 based index of the hyperlink to return [out] accessible - the specified hyperlink object, or null if the index is invalid

get_hyperlink_count

get_hyperlink_count ( AccessibleTextEvent e )

Java: getHyperlinkCount(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the number of links and link groups contained within this hypertext paragraph.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [out] count - the number of links and link groups within this hypertext paragraph, or 0 if there are none

get_hyperlink_index

get_hyperlink_index ( AccessibleTextEvent e )

Java: getHyperlinkIndex(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the index of the hyperlink that is associated with this character offset.

This is the case when a link spans the given character index.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] offset - the 0 based offset of the character for which to return the link index [out] index - the 0 based index of the hyperlink that is associated with this character offset, or -1 if the offset is not in a link

get_offset_at_point

get_offset_at_point ( AccessibleTextEvent e )

Java: getOffsetAtPoint(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the offset of the character under the specified point.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] x - the X value in display coordinates for which to look up the offset of the character that is rendered on the display at that point [in] y - the position's Y value for which to look up the offset of the character that is rendered on the display at that point [out] offset - the 0 based offset of the character under the given point, or -1 if the point is invalid or there is no character under the point

get_ranges

get_ranges ( AccessibleTextEvent e )

Java: getRanges(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the text range(s) contained within the given bounding box.

Partially visible characters are included in the returned ranges.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] x - the X coordinate of the top left corner of the bounding box, in display relative coordinates [in] y - the Y coordinate of the top left corner of the bounding box, in display relative coordinates [in] width - the width of the bounding box [in] height - the height of the bounding box [typical out] start - the 0 based offset of the first character of the substring in the bounding box [typical out] end - the 0 based offset after the last character of the substring in the bounding box [optional out] ranges - an array of pairs specifying the start and end offsets of each range, if the text range is clipped by the bounding box

get_selection

get_selection ( AccessibleTextEvent e )

Java: getSelection(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the character offsets of the specified text selection.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] index - the 0 based index of the selection [out] start - the 0 based offset of first selected character [out] end - the 0 based offset after the last selected character

get_selection_count

get_selection_count ( AccessibleTextEvent e )

Java: getSelectionCount(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the number of active non-contiguous selections.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [out] count - the number of active non-contiguous selections

get_text

get_text ( AccessibleTextEvent e )

Java: getText(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns a substring and its range for the given range, count and boundary type.

Returns the substring of the specified boundary type that is located count positions from the given character range. Also returns the start and end offsets of the returned substring.

For example, if the boundary type is TEXT_BOUNDARY_WORD, then the complete word that is located count words from the specified range is returned. If count is negative, then return the word that is count words before start. If count is positive, then return the word that is count words after end. If count is zero, start and end are the same, so return the word at start.

The whole text can be requested by passing start == 0 and end == getCharacterCount, TEXT_BOUNDARY_ALL, and 0 for count. Alternatively the whole text can be requested by calling AccessibleControlListener.getValue().

If start and end are valid, but no suitable word (or other boundary type) is found, the returned string is null and the returned range is degenerate (start == end).

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] type - the boundary type of the substring to return. One of: `ACC#TEXT_BOUNDARY_CHAR` `ACC#TEXT_BOUNDARY_WORD` `ACC#TEXT_BOUNDARY_SENTENCE` `ACC#TEXT_BOUNDARY_PARAGRAPH` `ACC#TEXT_BOUNDARY_LINE` `ACC#TEXT_BOUNDARY_ALL` [in,out] start - the 0 based offset of first character of the substring [in,out] end - the 0 based offset after the last character of the substring [in,out] count - the number of boundary type units to move to find the substring: in - look count units before start if count < 0, or after end if count > 0. Look at start if count == 0 out - the actual number of boundary type units that were moved. This may be fewer than the input count [out] result - the requested substring. This may be empty or null when no appropriate substring is found, or if the type is invalid.

get_text_bounds

get_text_bounds ( AccessibleTextEvent e )

Java: getTextBounds(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the bounding box(es) of the specified text range in display coordinates.

Typically, the text range will represent a single character, i.e. end - start = 1, therefore providers should optimize for this case.

Note: The virtual character after the last character of the represented text, i.e. the one at offset getCharacterCount, is a special case. It represents the current input position and will therefore typically be queried by AT more often than other positions. Because it does not represent an existing character its bounding box is defined in relation to preceding characters. It should be roughly equivalent to the bounding box of some character when inserted at the end of the text; its height typically being the maximal height of all the characters in the text or the height of the preceding character, its width being at least one pixel so that the bounding box is not degenerate.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] start - the 0 based offset of the first character of the substring in the bounding box [in] end - the 0 based offset after the last character of the substring in the bounding box [typical out] x - the X coordinate of the top left corner of the bounding box of the specified substring [typical out] y - the Y coordinate of the top left corner of the bounding box of the specified substring [typical out] width - the width of the bounding box of the specified substring [typical out] height - the height of the bounding box of the specified substring [optional out] rectangles - a set of disjoint bounding rectangles, if the specified text range includes partial lines

get_visible_ranges

get_visible_ranges ( AccessibleTextEvent e )

Java: getVisibleRanges(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Returns the visible text range(s).

Partially visible characters are included in the returned ranges.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [typical out] start - the 0 based offset of the first character of the visible substring [typical out] end - the 0 based offset after the last character of the visible substring [optional out] ranges - an array of pairs specifying the start and end offsets of each range, if the visible text range is clipped

remove_selection

remove_selection ( AccessibleTextEvent e )

Java: removeSelection(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Deselects a range of text.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] index - the 0 based index of selection to remove [out] result - set to `ACC#OK` if the range of text was deselected

scroll_text

scroll_text ( AccessibleTextEvent e )

Java: scrollText(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Scrolls a specific part of a substring according to the scroll type.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] start - the 0 based offset of the first character of the substring [in] end - the 0 based offset after the last character of the substring [in] type - a scroll type indicating where the substring should be placed on the screen. One of: `ACC#SCROLL_TYPE_TOP_LEFT` `ACC#SCROLL_TYPE_BOTTOM_RIGHT` `ACC#SCROLL_TYPE_TOP_EDGE` `ACC#SCROLL_TYPE_BOTTOM_EDGE` `ACC#SCROLL_TYPE_LEFT_EDGE` `ACC#SCROLL_TYPE_RIGHT_EDGE` `ACC#SCROLL_TYPE_ANYWHERE` `ACC#SCROLL_TYPE_POINT` [optional in] x - for SCROLL_TYPE_POINT, the X coordinate of the destination point in display coordinates [optional in] y - for SCROLL_TYPE_POINT, the Y coordinate of the destination point in display coordinates [out] result - set to `ACC#OK` if the text was scrolled

selection=

selection= ( AccessibleTextEvent e )

Java: setSelection(org.eclipse.swt.accessibility.AccessibleTextEvent e) · also: set_selection

Changes the bounds of an existing selection.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: [in] index - the 0 based index of the selection to change [in] start - the new 0 based offset of the first character of the selection [in] end - the new 0 based offset after the last character of the selection [out] result - set to `ACC#OK` if the selection was set

Inherited

from AccessibleTextAdapter

get_caret_offset

get_caret_offset ( AccessibleTextEvent e )

Java: getCaretOffset(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Sent when an accessibility client requests the current character offset of the text caret. The default behavior is to do nothing.

Return the caret offset in the offset field of the event object.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: childID [IN] - an identifier specifying a child of the control offset [OUT] - the current offset of the text caret

get_selection_range

get_selection_range ( AccessibleTextEvent e )

Java: getSelectionRange(org.eclipse.swt.accessibility.AccessibleTextEvent e)

Sent when an accessibility client requests the range of the current text selection. The default behavior is to do nothing.

Return the selection start offset and non-negative length in the offset and length fields of the event object.

name	type	description
e	org.eclipse.swt.accessibility.AccessibleTextEvent	an event object containing the following fields: childID [IN] - an identifier specifying a child of the control offset [OUT] - the offset of the current text selection length [OUT] - the length of the current text selection

Packages 38

JRuby