Module io.github.tonywasher.joceanus.tethys.core

Package io.github.tonywasher.joceanus.tethys.api.button

Interface TethysUIButton

All Superinterfaces:

OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent

All Known Implementing Classes:

TethysUICoreButton

public interface TethysUIButton
extends OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>, TethysUIComponent

Tethys Button.

The EventProvider fires the following events.

• TethysUIEvent.PRESSED is fired when a button is pressed

Method Summary

Modifier and Type	Method	Description
int	getIconSize()	Obtain icon size.
void	setIcon(TethysUIArrowIconId pIcon)	Set icon for button.
void	setIcon(TethysUIIcon pIcon)	Set icon for button.
void	setIcon(TethysUIIconId pId)	Set icon for button.
void	setIconAndText()	Set Icon and Text.
void	setIconOnly()	Set Icon only.
void	setIconSize(int pSize)	Set the icon size.
void	setNullMargins()	Set Null Margins.
void	setText(String pText)	Set text for button.
void	setTextAndIcon()	Set Text And Icon.
void	setTextOnly()	Set Text Only.
void	setToolTip(String pTip)	Set toolTip for button.

Methods inherited from interface io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar.OceanusEventProvider

getEventRegistrar

Methods inherited from interface io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent

getBorderPadding, getBorderTitle, getId, getNode, getUnderlying, setBorderPadding, setBorderTitle, setEnabled, setPreferredHeight, setPreferredWidth, setVisible

Method Details

getIconSize

int getIconSize()

Obtain icon size.

Returns:

the size

setIconSize

void setIconSize(int pSize)

Set the icon size.

Parameters:

pSize - the size to set

setText

void setText(String pText)

Set text for button.

Parameters:

pText - the text

setIcon

void setIcon(TethysUIIconId pId)

Set icon for button.

Parameters:

pId - the icon Id

setIcon

void setIcon(TethysUIArrowIconId pIcon)

Set icon for button.

Parameters:

pIcon - the icon

setIcon

void setIcon(TethysUIIcon pIcon)

Set icon for button.

Parameters:

pIcon - the icon

setToolTip

void setToolTip(String pTip)

Set toolTip for button.

Parameters:

pTip - the toolTip

setNullMargins

void setNullMargins()

Set Null Margins.

setIconOnly

void setIconOnly()

Set Icon only.

setTextAndIcon

void setTextAndIcon()

Set Text And Icon.

setIconAndText

void setIconAndText()

Set Icon and Text.

setTextOnly

void setTextOnly()

Set Text Only.