Class ImageHyperlink

  • All Implemented Interfaces:
    Drawable

    public class ImageHyperlink
    extends Hyperlink
    This class extends hyperlink widget by adding the capability to render an image relative to the text. If no text has been set, only image will be shown. Images for hover and active states can be set in addition to the normal state image.

    When image is taller than the text, additional style can be provided to control vertical alignment (supported values are SWT.TOP, SWT.BOTTOM and SWT.CENTER).

    The class does not need to be subclassed but it is allowed to do so if some aspect of the image hyperlink needs to be modified.

    Styles:
    SWT.WRAP, SWT.BOTTOM, SWT.TOP, SWT.MIDDLE, SWT.LEFT, SWT.RIGHT
    Since:
    3.0
    • Field Detail

      • textSpacing

        public int textSpacing
        Amount of pixels between the image and the text (default is 5).
    • Constructor Detail

      • ImageHyperlink

        public ImageHyperlink​(Composite parent,
                              int style)
        Creates the image hyperlink instance.
        Parameters:
        parent - the control parent
        style - the control style (SWT.WRAP, BOTTOM, TOP, MIDDLE, LEFT, RIGHT)
    • Method Detail

      • paintHyperlink

        protected void paintHyperlink​(GC gc)
        Description copied from class: Hyperlink
        Paints the hyperlink text.
        Overrides:
        paintHyperlink in class Hyperlink
        Parameters:
        gc - graphic context
      • paintHyperlink

        protected void paintHyperlink​(GC gc,
                                      Rectangle bounds)
      • getActiveImage

        public Image getActiveImage()
        Returns active image.
        Returns:
        active image or null if not set.
      • setActiveImage

        public void setActiveImage​(Image activeImage)
        Sets the image to show when link is activated.
        Parameters:
        activeImage -
      • getHoverImage

        public Image getHoverImage()
        Returns the hover image.
        Returns:
        hover image or null if not set.
      • setHoverImage

        public void setHoverImage​(Image hoverImage)
        Sets the image to show when link is hover state (on mouse over).
        Parameters:
        hoverImage -
      • getImage

        public Image getImage()
        Returns the image to show in the normal state.
        Returns:
        normal image or null if not set.
      • setImage

        public void setImage​(Image image)
        Sets the image to show when link is in the normal state.
        Parameters:
        image -
      • setEnabled

        public void setEnabled​(boolean enabled)
        Description copied from class: Control
        Enables the receiver if the argument is true, and disables it otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.
        Overrides:
        setEnabled in class AbstractHyperlink
        Parameters:
        enabled - the new enabled state