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:

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

onDestroyed, onRendered

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
org.teamapps.dto.UiComponent	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
Component	getDropDownComponent()
org.teamapps.icons.api.Icon	getIcon()
java.lang.Integer	getMinDropDownHeight()
java.lang.Integer	getMinDropDownWidth()
java.lang.String	getPopoverText()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isGrayOutIfNotHovered()
boolean	isOpenDropDownIfNotSet()
void	setDropDownComponent(Component dropDownComponent)
void	setGrayOutIfNotHovered(boolean grayOutIfNotHovered)
void	setIcon(org.teamapps.icons.api.Icon icon)
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

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, 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.Component

setCssStyle

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.api.Icon icon)

ToolButton

public ToolButton(org.teamapps.icons.api.Icon icon,
                  java.lang.String popoverText)

ToolButton

public ToolButton(org.teamapps.icons.api.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.api.Icon getIcon()

setIcon

public void setIcon(org.teamapps.icons.api.Icon icon)

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)

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent