bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleHyperlinkAdapter.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2016 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.accessibility;
  15
  16 /**
  17  * This adapter class provides default implementations for the
  18  * methods in the <code>AccessibleHyperlinkListener</code> interface.
  19  * <p>
  20  * Classes that wish to deal with <code>AccessibleHyperlink</code> events can
  21  * extend this class and override only the methods that they are
  22  * interested in.
  23  * </p>
  24  *
  25  * @see AccessibleHyperlinkListener
  26  * @see AccessibleHyperlinkEvent
  27  *
  28  * @since 3.6
  29  */
  30 public class AccessibleHyperlinkAdapter implements AccessibleHyperlinkListener {
  31         /**
  32          * Returns the anchor for the link at the specified index.
  33          *
  34          * @param e an event object containing the following fields:<ul>
  35          * <li>[in] index - a 0 based index identifying the anchor if this object
  36          *              has more than one link, as in the case of an image map</li>
  37          * <li>[typical out] result - the returned anchor</li>
  38          * <li>[optional out] accessible - the returned anchor.
  39          *              Note: The returned anchor can either be a string or an accessible.
  40          *              For example, for a text link this could be the substring of the containing string
  41          *              where the substring is overridden with link behavior, and for an image link this could be
  42          *              the accessible for the image.</li>
  43          * </ul>
  44          */
  45         @Override
  46         public void getAnchor(AccessibleHyperlinkEvent e) {}
  47
  48         /**
  49          * Returns the target of the link at the specified index.
  50          *
  51          * @param e an event object containing the following fields:<ul>
  52          * <li>[in] index - a 0 based index identifying the anchor if this object
  53          *              has more than one link, as in the case of an image map</li>
  54          * <li>[typical out] result - the returned target</li>
  55          * <li>[optional out] accessible - the returned target.
  56          *              Note: The returned target can either be a string or an accessible.
  57          *              For example, this could be a string URI, or the accessible for the target
  58          *              object to be activated when the link is activated.</li>
  59          * </ul>
  60          */
  61         @Override
  62         public void getAnchorTarget(AccessibleHyperlinkEvent e) {}
  63
  64         /**
  65          * Returns the 0 based character offset at which the textual representation of the hyperlink starts.
  66          * <p>
  67          * The returned value is related to the AccessibleTextExtended interface of the object that
  68          * owns this hyperlink.
  69          * </p>
  70          *
  71          * @param e an event object containing the following fields:<ul>
  72          * <li>[out] index</li>
  73          * </ul>
  74          */
  75         @Override
  76         public void getStartIndex(AccessibleHyperlinkEvent e) {}
  77
  78         /**
  79          * Returns the 0 based character offset at which the textual representation of the hyperlink ends.
  80          * <p>
  81          * The returned value is related to the AccessibleTextExtended interface of the object that
  82          * owns this hyperlink. The character at the index is not part of the hypertext.
  83          * </p>
  84          *
  85          * @param e an event object containing the following fields:<ul>
  86          * <li>[out] index</li>
  87          * </ul>
  88          */
  89         @Override
  90         public void getEndIndex(AccessibleHyperlinkEvent e) {}
  91 }