com.github.weisj.darklaf.components.tooltip

Class ToolTipContext

java.lang.Object

com.github.weisj.darklaf.components.tooltip.ToolTipContext

public class ToolTipContext
extends Object

Constructor Summary

Constructors

Constructor and Description
ToolTipContext() Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, com.github.weisj.darklaf.util.Alignment centerAlignment) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, com.github.weisj.darklaf.util.Alignment centerAlignment, AlignmentStrategy alignmentStrategy) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, com.github.weisj.darklaf.util.Alignment centerAlignment, AlignmentStrategy alignmentStrategy, boolean alignInside, Function<MouseEvent,Rectangle> toolTipRectSupplier) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, com.github.weisj.darklaf.util.Alignment centerAlignment, boolean alignInside) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, AlignmentStrategy alignmentStrategy) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, AlignmentStrategy alignmentStrategy, boolean alignInside) Create a new tooltip context to ease the creation of custom tooltips.
ToolTipContext(JComponent target, com.github.weisj.darklaf.util.Alignment alignment, boolean alignInside) Create a new tooltip context to ease the creation of custom tooltips.

Method Summary

Modifier and Type	Method and Description
com.github.weisj.darklaf.util.Alignment	getAlignment()
AlignmentStrategy	getAlignmentStrategy()
com.github.weisj.darklaf.util.Alignment	getCenterAlignment()
static ToolTipContext	getDefaultContext()
Point	getFallBackPosition()
JComponent	getTarget()
JToolTip	getToolTip() Get the tooltip.
Point	getToolTipLocation(MouseEvent event)
Point	getToolTipLocation(Point mp, MouseEvent mouseEvent) Calculates the tooltip location.
boolean	isAlignInside()
boolean	isBestFit()
boolean	isIgnoreBorder()
void	removeToolTip()
ToolTipContext	setAlignInside(boolean alignInside) Sets whether the component should be aligned inside or outside the supplied rectangle if the current alignment is not Alignment.CENTER.
ToolTipContext	setAlignment(com.github.weisj.darklaf.util.Alignment alignment) Sets the alignment with respect to the supplied alignment rectangle.
ToolTipContext	setAlignmentStrategy(AlignmentStrategy alignmentStrategy) Set the alignment strategy which determines how the current mouse position is considered when calculating the tooltip location.
ToolTipContext	setApplyComponentInsetsToRect(boolean applyInsetsToRect) Sets whether the insets of the component insets should be subtracted from the area returned by setToolTipRectSupplier(Function).
ToolTipContext	setCenterAlignment(com.github.weisj.darklaf.util.Alignment centerAlignment) When setAlignment(Alignment) is Alignment.CENTER this property will define on what side relative to the center point the tooltip will appear.
static void	setDefaultContext(ToolTipContext defaultContext)
ToolTipContext	setFallBackPositionProvider(Function<ToolTipContext,Point> fallBackPositionProvider)
ToolTipContext	setHideOnExit(boolean hideOnExit) Sets whether the tooltip should be closed if the mouse has left the area set by setInsideArea(Area).
ToolTipContext	setIgnoreBorder(boolean ignoreBorder) Sets whether the border should be ignored when aligning outside.
ToolTipContext	setInsideArea(Area insideRect) Set the area to check if the tooltip should hide.
ToolTipContext	setInsideArea(Rectangle insideRect)
void	setTarget(JComponent target)
void	setToolTip(JToolTip toolTip)
ToolTipContext	setToolTipInsets(Insets insets) Sets insets for the tooltip.
ToolTipContext	setToolTipRectSupplier(Function<MouseEvent,Rectangle> toolTipRectSupplier) Set the supplier for the rectangle which is used to calculate the location of the tooltip.
ToolTipContext	setToolTipStyle(ToolTipStyle style) Set the style of the tooltip.
ToolTipContext	setUpdatePosition(boolean updatePosition) Sets whether the position should be recalculated each time after the popup has been shown.
ToolTipContext	setUseBestFit(boolean bestFit) Sets whether the tooltip should try its best to fit inside the window/screen.
void	updateToolTip()
void	updateToolTipUI()

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolTipContext

public ToolTipContext()

Create a new tooltip context to ease the creation of custom tooltips.

ToolTipContext

public ToolTipContext(JComponent target)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      com.github.weisj.darklaf.util.Alignment centerAlignment,
                      AlignmentStrategy alignmentStrategy,
                      boolean alignInside,
                      Function<MouseEvent,Rectangle> toolTipRectSupplier)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

centerAlignment - setCenterAlignment(Alignment)

alignmentStrategy - setAlignmentStrategy(AlignmentStrategy)

alignInside - setAlignInside(boolean)

toolTipRectSupplier - setToolTipRectSupplier(Function)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      com.github.weisj.darklaf.util.Alignment centerAlignment)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

centerAlignment - setCenterAlignment(Alignment)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      boolean alignInside)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

alignInside - setAlignInside(boolean)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      com.github.weisj.darklaf.util.Alignment centerAlignment,
                      boolean alignInside)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

centerAlignment - setCenterAlignment(Alignment)

alignInside - setAlignInside(boolean)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      AlignmentStrategy alignmentStrategy)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

alignmentStrategy - setAlignmentStrategy(AlignmentStrategy)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      com.github.weisj.darklaf.util.Alignment centerAlignment,
                      AlignmentStrategy alignmentStrategy)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

centerAlignment - setCenterAlignment(Alignment)

alignmentStrategy - setAlignmentStrategy(AlignmentStrategy)

ToolTipContext

public ToolTipContext(JComponent target,
                      com.github.weisj.darklaf.util.Alignment alignment,
                      AlignmentStrategy alignmentStrategy,
                      boolean alignInside)

Create a new tooltip context to ease the creation of custom tooltips.

Parameters:

target - the component which the tooltip belongs to.

alignment - setAlignment(Alignment)

alignmentStrategy - setAlignmentStrategy(AlignmentStrategy)

alignInside - setAlignInside(boolean)

Method Detail

getDefaultContext

public static ToolTipContext getDefaultContext()

setDefaultContext

public static void setDefaultContext(ToolTipContext defaultContext)

setToolTipStyle

public ToolTipContext setToolTipStyle(ToolTipStyle style)

Set the style of the tooltip.

Parameters:

style - the tooltip style.

Returns:

this

See Also:

ToolTipStyle

setUpdatePosition

public ToolTipContext setUpdatePosition(boolean updatePosition)

Sets whether the position should be recalculated each time after the popup has been shown. This may be useful if the tooltip should follow the mouse.

Default is false.

Parameters:

updatePosition - true if it should be recalculated.

Returns:

this

setAlignInside

public ToolTipContext setAlignInside(boolean alignInside)

Sets whether the component should be aligned inside or outside the supplied rectangle if the current alignment is not Alignment.CENTER. Default is true

Parameters:

alignInside - true if the tooltip should be aligned inside.

Returns:

this.

See Also:

setAlignment(Alignment), setToolTipRectSupplier(Function)

isIgnoreBorder

public boolean isIgnoreBorder()

isBestFit

public boolean isBestFit()

setAlignment

public ToolTipContext setAlignment(com.github.weisj.darklaf.util.Alignment alignment)

Sets the alignment with respect to the supplied alignment rectangle. When using Alignment.CENTER one can additionally supply an alignment using setCenterAlignment(Alignment). The tooltip will either be aligned outside of the rectangle or inside depending on setAlignInside(boolean).

Parameters:

alignment - the alignment.

Returns:

this.

See Also:

setToolTipRectSupplier(Function)

setCenterAlignment

public ToolTipContext setCenterAlignment(com.github.weisj.darklaf.util.Alignment centerAlignment)

When setAlignment(Alignment) is Alignment.CENTER this property will define on what side relative to the center point the tooltip will appear.

Default is Alignment.NORTH.

Parameters:

centerAlignment - the center alignment.

Returns:

this

setAlignmentStrategy

public ToolTipContext setAlignmentStrategy(AlignmentStrategy alignmentStrategy)

Set the alignment strategy which determines how the current mouse position is considered when calculating the tooltip location.

Default will be AlignmentStrategy.COMPONENT_BOTH.

Parameters:

alignmentStrategy - the alignment strategy.

Returns:

this

See Also:

AlignmentStrategy

setHideOnExit

public ToolTipContext setHideOnExit(boolean hideOnExit)

Sets whether the tooltip should be closed if the mouse has left the area set by setInsideArea(Area).

Default is false.

Parameters:

hideOnExit - true if tooltip should hide.

Returns:

this.

setToolTipRectSupplier

public ToolTipContext setToolTipRectSupplier(Function<MouseEvent,Rectangle> toolTipRectSupplier)

Set the supplier for the rectangle which is used to calculate the location of the tooltip. The coordinates should be relative to the components origin.

Default will be the component bounding rectangle.

Parameters:

toolTipRectSupplier - rectangle supplier method.

Returns:

this

updateToolTip

public void updateToolTip()

setInsideArea

public ToolTipContext setInsideArea(Area insideRect)

Set the area to check if the tooltip should hide. If the mouse is outside of the area the the tooltip hides if setHideOnExit(boolean) is true.

Defaults to

Parameters:

insideRect - the area to check.

Returns:

this.

setApplyComponentInsetsToRect

public ToolTipContext setApplyComponentInsetsToRect(boolean applyInsetsToRect)

Sets whether the insets of the component insets should be subtracted from the area returned by setToolTipRectSupplier(Function).

Default is false.

Parameters:

applyInsetsToRect - true if they should be applied.

Returns:

this.

setInsideArea

public ToolTipContext setInsideArea(Rectangle insideRect)

Parameters:

insideRect - the rectangle to check.

Returns:

this

See Also:

setInsideArea(Area)

setToolTipInsets

public ToolTipContext setToolTipInsets(Insets insets)

Sets insets for the tooltip.

Parameters:

insets - the insets to set.

Returns:

this.

getToolTipLocation

public Point getToolTipLocation(MouseEvent event)

setIgnoreBorder

public ToolTipContext setIgnoreBorder(boolean ignoreBorder)

Sets whether the border should be ignored when aligning outside. If true the tooltip is aligned w.r.t. to the content rect and not the component bounds.

Parameters:

ignoreBorder - true if border insets should be ignored.

Returns:

this.

setUseBestFit

public ToolTipContext setUseBestFit(boolean bestFit)

Sets whether the tooltip should try its best to fit inside the window/screen.

Parameters:

bestFit - true if best fit adjustments should be made.

Returns:

this.

getToolTipLocation

public Point getToolTipLocation(Point mp,
                                MouseEvent mouseEvent)

Calculates the tooltip location.

Parameters:

mp - the mouse position in the target component coordinate space.

mouseEvent - the mouse event.

Returns:

the tooltip location.

See Also:

JComponent.getToolTipLocation(MouseEvent)

getTarget

public JComponent getTarget()

setTarget

public void setTarget(JComponent target)

getToolTip

public JToolTip getToolTip()

Get the tooltip.

Returns:

the tooltip.

See Also:

JComponent.createToolTip()

updateToolTipUI

public void updateToolTipUI()

removeToolTip

public void removeToolTip()

getAlignment

public com.github.weisj.darklaf.util.Alignment getAlignment()

getCenterAlignment

public com.github.weisj.darklaf.util.Alignment getCenterAlignment()

getAlignmentStrategy

public AlignmentStrategy getAlignmentStrategy()

isAlignInside

public boolean isAlignInside()

setToolTip

public void setToolTip(JToolTip toolTip)

getFallBackPosition

public Point getFallBackPosition()

setFallBackPositionProvider

public ToolTipContext setFallBackPositionProvider(Function<ToolTipContext,Point> fallBackPositionProvider)