Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.util.tip
Class BrowserTip

java.lang.Object
  extended by eu.esdihumboldt.hale.ui.util.tip.BrowserTip

public class BrowserTip
extends Object

Browser tip

Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Constructor Summary
BrowserTip(int toolTipWidth, int toolTipHeight, boolean plainText)
          Create a browser tip using its own ScheduledExecutorService
BrowserTip(int toolTipWidth, int toolTipHeight, boolean plainText, ScheduledExecutorService scheduleService)
          Create a browser tip with using given ScheduledExecutorService
 
Method Summary
 int getHeightAdjustment()
           
static void hideToolTip(org.eclipse.swt.widgets.Shell shell)
          Hide the tool tip
 void setHeightAdjustment(int heightAdjustment)
           
 org.eclipse.swt.widgets.Shell showToolTip(org.eclipse.swt.widgets.Control control, int posx, int posy, String toolTip)
          Show the tool tip
 org.eclipse.swt.widgets.Shell showToolTip(org.eclipse.swt.widgets.Control control, int posx, int posy, String toolTip, org.eclipse.swt.graphics.Rectangle addBounds, org.eclipse.swt.widgets.Control addBoundsControl)
          Show the tool tip
static boolean toolTipVisible(org.eclipse.swt.widgets.Shell shell)
          Determines if the tool tip is visible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BrowserTip

public BrowserTip(int toolTipWidth,
                  int toolTipHeight,
                  boolean plainText)
Create a browser tip using its own ScheduledExecutorService

Parameters:
toolTipWidth - the maximum with
toolTipHeight - the maximum height
plainText - if the content will be plain text instead of HTML

BrowserTip

public BrowserTip(int toolTipWidth,
                  int toolTipHeight,
                  boolean plainText,
                  ScheduledExecutorService scheduleService)
Create a browser tip with using given ScheduledExecutorService

Parameters:
toolTipWidth - the maximum with
toolTipHeight - the maximum height
plainText - if the content will be plain text instead of HTML
scheduleService - the scheduled executor service to use, if null a service will be created
Method Detail

showToolTip

public org.eclipse.swt.widgets.Shell showToolTip(org.eclipse.swt.widgets.Control control,
                                                 int posx,
                                                 int posy,
                                                 String toolTip)
Show the tool tip

Parameters:
control - the tip control
posx - the x-position
posy - the y-position
toolTip - the tool tip string
Returns:
the tool shell

showToolTip

public org.eclipse.swt.widgets.Shell showToolTip(org.eclipse.swt.widgets.Control control,
                                                 int posx,
                                                 int posy,
                                                 String toolTip,
                                                 org.eclipse.swt.graphics.Rectangle addBounds,
                                                 org.eclipse.swt.widgets.Control addBoundsControl)
Show the tool tip

Parameters:
control - the tip control
posx - the x-position
posy - the y-position
toolTip - the tool tip string
addBounds - additional bounds that will be treated as if in the tooltip (the tooltip won't hide if the cursor is inside these bounds), may be null
addBoundsControl - the control the addBounds coordinates are relative to, null if addBounds is in display coordinates or no addBounds is provided
Returns:
the tool shell

hideToolTip

public static void hideToolTip(org.eclipse.swt.widgets.Shell shell)
Hide the tool tip

Parameters:
shell - the tip shell

toolTipVisible

public static boolean toolTipVisible(org.eclipse.swt.widgets.Shell shell)
Determines if the tool tip is visible

Parameters:
shell - the tip shell
Returns:
if the tool tip is visible

getHeightAdjustment

public int getHeightAdjustment()
Returns:
the heightAdjustment

setHeightAdjustment

public void setHeightAdjustment(int heightAdjustment)
Parameters:
heightAdjustment - the heightAdjustment to set

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d