com.helger.photon.bootstrap4.tooltip

Class BootstrapTooltip

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.script.AbstractHCScript<IMPLTYPE>

com.helger.html.hc.html.script.AbstractHCScriptInline<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>

com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady

com.helger.photon.bootstrap4.tooltip.BootstrapTooltip

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<com.helger.html.hc.IHCNode>, com.helger.commons.traits.IGenericImplTrait<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.html.IHCElement<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.html.IHCHasCSSClasses<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.html.IHCHasCSSStyles<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.html.script.IHCScript<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.html.script.IHCScriptInline<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.IHCHasID<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>, com.helger.html.hc.IHCNode, Serializable

@OutOfBandNode
public class BootstrapTooltip
extends com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady

Bootstrap Tooltip

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ANIMATION
static EBootstrapTooltipBoundary	DEFAULT_BOUNDARY
static EBootstrapTooltipFallbackPlacement	DEFAULT_FALLBACK_PLACEMENT
static boolean	DEFAULT_HTML
static EBootstrapTooltipPosition	DEFAULT_PLACEMENT
static Set<EBootstrapTooltipTrigger>	DEFAULT_TRIGGER
static String	JS_EVENT_HIDDEN This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
static String	JS_EVENT_HIDE This event is fired immediately when the hide instance method has been called.
static String	JS_EVENT_INSERTED This event is fired after the show.bs.tooltip event when the tooltip template has been added to the DOM.
static String	JS_EVENT_SHOW This event fires immediately when the show instance method is called.
static String	JS_EVENT_SHOWN This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).

Fields inherited from class com.helger.html.hc.html.script.AbstractHCScriptInline

DEFAULT_EMIT_AFTER_FILES

Fields inherited from class com.helger.html.hc.html.script.AbstractHCScript

DEFAULT_TYPE

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor and Description
BootstrapTooltip(com.helger.html.hc.html.IHCElement<?> aElement)
BootstrapTooltip(com.helger.html.jquery.IJQuerySelector aSelector)

Method Summary

Modifier and Type	Method and Description
EBootstrapTooltipBoundary	getBoundary()
com.helger.html.jquery.IJQuerySelector	getContainer()
int	getDelayHide()
int	getDelayShow()
EBootstrapTooltipFallbackPlacement	getFallbackPlacement()
com.helger.html.jscode.JSAssocArray	getJSOptions()
String	getOffset()
com.helger.html.jscode.JSAnonymousFunction	getPlacementFunction()
EBootstrapTooltipPosition	getPlacementPosition()
String	getSelector()
com.helger.html.jscode.JSAnonymousFunction	getTooltipTitleFunction()
String	getTooltipTitleString()
com.helger.commons.collection.impl.ICommonsList<EBootstrapTooltipTrigger>	getTrigger()
boolean	isAnimation()
boolean	isHTML()
com.helger.html.jscode.JSInvocation	jsAttach()
com.helger.html.jscode.JSInvocation	jsDisable()
com.helger.html.jscode.JSInvocation	jsDispose()
com.helger.html.jscode.JSInvocation	jsEnable()
com.helger.html.jscode.JSInvocation	jsHide()
com.helger.html.jscode.JSInvocation	jsInvoke()
com.helger.html.jscode.JSInvocation	jsShow()
com.helger.html.jscode.JSInvocation	jsToggle()
com.helger.html.jscode.JSInvocation	jsToggleEnabled()
com.helger.html.jscode.JSInvocation	jsUpdate()
protected void	onFinalizeNodeState(com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings, com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)
BootstrapTooltip	setAnimation(boolean bAnimation)
BootstrapTooltip	setBoundary(EBootstrapTooltipBoundary eBoundary)
BootstrapTooltip	setContainer(com.helger.html.EHTMLElement eContainer)
BootstrapTooltip	setContainer(com.helger.html.jquery.IJQuerySelector aContainer)
BootstrapTooltip	setDelay(int nDelay)
BootstrapTooltip	setDelay(int nShowDelay, int nHideDelay)
BootstrapTooltip	setFallbackPlacement(EBootstrapTooltipFallbackPlacement eFallbackPlacement)
BootstrapTooltip	setHTML(boolean bHTML)
BootstrapTooltip	setOffset(int nOffset)
BootstrapTooltip	setOffset(String sOffset)
BootstrapTooltip	setPlacement(EBootstrapTooltipPosition ePosition)
BootstrapTooltip	setPlacement(com.helger.html.jscode.JSAnonymousFunction aFunction)
BootstrapTooltip	setSelector(String sSelector)
BootstrapTooltip	setTooltipTitle(com.helger.html.hc.IHCNode aTooltipTitle)
BootstrapTooltip	setTooltipTitle(com.helger.html.jscode.JSAnonymousFunction aFunction)
BootstrapTooltip	setTooltipTitle(String sTitle)
BootstrapTooltip	setTrigger(Collection<EBootstrapTooltipTrigger> aTrigger)
BootstrapTooltip	setTrigger(EBootstrapTooltipTrigger... aTrigger)

Methods inherited from class com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady

getOnDocumentReadyCode, setOnDocumentReadyCode, setOnDocumentReadyCode, toString

Methods inherited from class com.helger.html.hc.html.script.AbstractHCScriptInline

canConvertToMicroNode, fillMicroElement, getJSCode, getJSCodeProvider, getMode, isEmitAfterFiles, setEmitAfterFiles, setInlineScript, setJSCodeProvider, setMode

Methods inherited from class com.helger.html.hc.html.script.AbstractHCScript

getCharset, getCrossOrigin, getIntegrity, getType, setCharset, setCrossOrigin, setIntegrity, setType

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onConsistencyCheck, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNodeState, getPlainText, hasChildren, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.html.hc.html.script.IHCScript

getCharset, getCrossOrigin, getIntegrity, getType, setCharset, setCharset, setCrossOrigin, setIntegrity, setType

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable

Methods inherited from interface com.helger.html.hc.IHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Field Detail

JS_EVENT_SHOW

public static final String JS_EVENT_SHOW

This event fires immediately when the show instance method is called.

See Also:

Constant Field Values

JS_EVENT_SHOWN

public static final String JS_EVENT_SHOWN

This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).

See Also:

Constant Field Values

JS_EVENT_HIDE

public static final String JS_EVENT_HIDE

This event is fired immediately when the hide instance method has been called.

See Also:

Constant Field Values

JS_EVENT_HIDDEN

public static final String JS_EVENT_HIDDEN

This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).

See Also:

Constant Field Values

JS_EVENT_INSERTED

public static final String JS_EVENT_INSERTED

This event is fired after the show.bs.tooltip event when the tooltip template has been added to the DOM.

See Also:

Constant Field Values

DEFAULT_ANIMATION

public static final boolean DEFAULT_ANIMATION

See Also:

Constant Field Values

DEFAULT_HTML

public static final boolean DEFAULT_HTML

See Also:

Constant Field Values

DEFAULT_PLACEMENT

public static final EBootstrapTooltipPosition DEFAULT_PLACEMENT

DEFAULT_TRIGGER

@CodingStyleguideUnaware
public static final Set<EBootstrapTooltipTrigger> DEFAULT_TRIGGER

DEFAULT_FALLBACK_PLACEMENT

public static final EBootstrapTooltipFallbackPlacement DEFAULT_FALLBACK_PLACEMENT

DEFAULT_BOUNDARY

public static final EBootstrapTooltipBoundary DEFAULT_BOUNDARY

Constructor Detail

BootstrapTooltip

public BootstrapTooltip(@Nonnull
                        com.helger.html.hc.html.IHCElement<?> aElement)

BootstrapTooltip

public BootstrapTooltip(@Nonnull
                        com.helger.html.jquery.IJQuerySelector aSelector)

Method Detail

isAnimation

public boolean isAnimation()

setAnimation

@Nonnull
public BootstrapTooltip setAnimation(boolean bAnimation)

isHTML

public boolean isHTML()

setHTML

@Nonnull
public BootstrapTooltip setHTML(boolean bHTML)

getPlacementPosition

@Nullable
public EBootstrapTooltipPosition getPlacementPosition()

getPlacementFunction

@Nullable
public com.helger.html.jscode.JSAnonymousFunction getPlacementFunction()

setPlacement

@Nonnull
public BootstrapTooltip setPlacement(@Nonnull
                                               EBootstrapTooltipPosition ePosition)

setPlacement

@Nonnull
public BootstrapTooltip setPlacement(@Nonnull
                                               com.helger.html.jscode.JSAnonymousFunction aFunction)

Parameters:

aFunction - Callback function that is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.

Returns:

this

getSelector

@Nullable
public String getSelector()

setSelector

@Nonnull
public BootstrapTooltip setSelector(@Nullable
                                              String sSelector)

getTooltipTitleString

@Nullable
public String getTooltipTitleString()

getTooltipTitleFunction

@Nullable
public com.helger.html.jscode.JSAnonymousFunction getTooltipTitleFunction()

setTooltipTitle

@Nonnull
public BootstrapTooltip setTooltipTitle(@Nullable
                                                  String sTitle)

setTooltipTitle

@Nonnull
public BootstrapTooltip setTooltipTitle(@Nullable
                                                  com.helger.html.hc.IHCNode aTooltipTitle)

setTooltipTitle

@Nonnull
public BootstrapTooltip setTooltipTitle(@Nullable
                                                  com.helger.html.jscode.JSAnonymousFunction aFunction)

Parameters:

aFunction - Callback function with 1 parameter: (this.$element[0])

Returns:

this

getTrigger

@Nullable
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<EBootstrapTooltipTrigger> getTrigger()

setTrigger

@Nonnull
public BootstrapTooltip setTrigger(@Nullable
                                             EBootstrapTooltipTrigger... aTrigger)

setTrigger

@Nonnull
public BootstrapTooltip setTrigger(@Nullable
                                             Collection<EBootstrapTooltipTrigger> aTrigger)

getDelayShow

@Nonnegative
public int getDelayShow()

getDelayHide

@Nonnegative
public int getDelayHide()

setDelay

@Nonnull
public BootstrapTooltip setDelay(@Nonnegative
                                           int nDelay)

setDelay

@Nonnull
public BootstrapTooltip setDelay(@Nonnegative
                                           int nShowDelay,
                                           @Nonnegative
                                           int nHideDelay)

getContainer

@Nullable
public com.helger.html.jquery.IJQuerySelector getContainer()

setContainer

@Nonnull
public BootstrapTooltip setContainer(@Nonnull
                                               com.helger.html.EHTMLElement eContainer)

setContainer

@Nonnull
public BootstrapTooltip setContainer(@Nullable
                                               com.helger.html.jquery.IJQuerySelector aContainer)

getOffset

@Nullable
public String getOffset()

setOffset

@Nonnull
public BootstrapTooltip setOffset(@Nullable
                                            String sOffset)

setOffset

@Nonnull
public BootstrapTooltip setOffset(int nOffset)

getFallbackPlacement

@Nullable
public EBootstrapTooltipFallbackPlacement getFallbackPlacement()

setFallbackPlacement

@Nonnull
public BootstrapTooltip setFallbackPlacement(@Nullable
                                                       EBootstrapTooltipFallbackPlacement eFallbackPlacement)

getBoundary

@Nullable
public EBootstrapTooltipBoundary getBoundary()

setBoundary

@Nonnull
public BootstrapTooltip setBoundary(@Nullable
                                              EBootstrapTooltipBoundary eBoundary)

getJSOptions

@Nonnull
public com.helger.html.jscode.JSAssocArray getJSOptions()

jsInvoke

@Nonnull
public com.helger.html.jscode.JSInvocation jsInvoke()

jsAttach

@Nonnull
public com.helger.html.jscode.JSInvocation jsAttach()

jsShow

@Nonnull
public com.helger.html.jscode.JSInvocation jsShow()

jsHide

@Nonnull
public com.helger.html.jscode.JSInvocation jsHide()

jsToggle

@Nonnull
public com.helger.html.jscode.JSInvocation jsToggle()

jsDispose

@Nonnull
public com.helger.html.jscode.JSInvocation jsDispose()

jsEnable

@Nonnull
public com.helger.html.jscode.JSInvocation jsEnable()

jsDisable

@Nonnull
public com.helger.html.jscode.JSInvocation jsDisable()

jsToggleEnabled

@Nonnull
public com.helger.html.jscode.JSInvocation jsToggleEnabled()

jsUpdate

@Nonnull
public com.helger.html.jscode.JSInvocation jsUpdate()

onFinalizeNodeState

protected void onFinalizeNodeState(@Nonnull
                                   com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings,
                                   @Nonnull
                                   com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)

Overrides:

onFinalizeNodeState in class com.helger.html.hc.html.AbstractHCElement<com.helger.html.hc.html.script.HCScriptInlineOnDocumentReady>