Package org.teamapps.ux.component.toolbutton

Class ToolButton

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.toolbutton.ToolButton

All Implemented Interfaces:

ClientObject, Component

public class ToolButton
extends AbstractComponent

Field Summary

Fields

Modifier and Type	Field	Description
Event<java.lang.Void>	onClick
Event<java.lang.Void>	onDropDownOpened

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
ToolButton(org.teamapps.icons.Icon<?,?> icon)
ToolButton(org.teamapps.icons.Icon<?,?> icon, java.lang.String popoverText)
ToolButton(org.teamapps.icons.Icon<?,?> icon, java.lang.String popoverText, Component dropDownComponent)

Method Summary

Modifier and Type	Method	Description
void	closeDropDown()
org.teamapps.dto.UiComponent	createUiComponent()
java.lang.String	getCaption()
Component	getDropDownComponent()
org.teamapps.icons.Icon<?,?>	getIcon()
java.lang.Integer	getIconSize()
java.lang.Integer	getMinDropDownHeight()
java.lang.Integer	getMinDropDownWidth()
java.lang.String	getPopoverText()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isGrayOutIfNotHovered()
boolean	isOpenDropDownIfNotSet()
void	setCaption(java.lang.String caption)
void	setDropDownComponent(Component dropDownComponent)
void	setGrayOutIfNotHovered(boolean grayOutIfNotHovered)
void	setIcon(org.teamapps.icons.Icon<?,?> icon)
void	setIconSize(java.lang.Integer iconSize)
void	setMinDropDownHeight(java.lang.Integer minDropDownHeight)
void	setMinDropDownWidth(java.lang.Integer minDropDownWidth)
void	setOpenDropDownIfNotSet(boolean openDropDownIfNotSet)
void	setPopoverText(java.lang.String popoverText)

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, setVisible, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.ClientObject

handleUiQuery

Methods inherited from interface org.teamapps.ux.component.Component

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Field Detail

onDropDownOpened

public final Event<java.lang.Void> onDropDownOpened

onClick

public final Event<java.lang.Void> onClick

Constructor Detail

ToolButton

public ToolButton(org.teamapps.icons.Icon<?,?> icon)

ToolButton

public ToolButton(org.teamapps.icons.Icon<?,?> icon,
                  java.lang.String popoverText)

ToolButton

public ToolButton(org.teamapps.icons.Icon<?,?> icon,
                  java.lang.String popoverText,
                  Component dropDownComponent)

Method Detail

isGrayOutIfNotHovered

public boolean isGrayOutIfNotHovered()

setGrayOutIfNotHovered

public void setGrayOutIfNotHovered(boolean grayOutIfNotHovered)

createUiComponent

public org.teamapps.dto.UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

getIcon

public org.teamapps.icons.Icon<?,?> getIcon()

setIcon

public void setIcon(org.teamapps.icons.Icon<?,?> icon)

getIconSize

public java.lang.Integer getIconSize()

setIconSize

public void setIconSize(java.lang.Integer iconSize)

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String caption)

getPopoverText

public java.lang.String getPopoverText()

setPopoverText

public void setPopoverText(java.lang.String popoverText)

isOpenDropDownIfNotSet

public boolean isOpenDropDownIfNotSet()

setOpenDropDownIfNotSet

public void setOpenDropDownIfNotSet(boolean openDropDownIfNotSet)

getDropDownComponent

public Component getDropDownComponent()

setDropDownComponent

public void setDropDownComponent(Component dropDownComponent)

getMinDropDownWidth

public java.lang.Integer getMinDropDownWidth()

setMinDropDownWidth

public void setMinDropDownWidth(java.lang.Integer minDropDownWidth)

getMinDropDownHeight

public java.lang.Integer getMinDropDownHeight()

setMinDropDownHeight

public void setMinDropDownHeight(java.lang.Integer minDropDownHeight)

closeDropDown

public void closeDropDown()