Package org.teamapps.ux.component.field

Class Button<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<java.lang.Void>

org.teamapps.ux.component.field.Button<RECORD>

All Implemented Interfaces:

ClientObject, Component

public class Button<RECORD>
extends AbstractField<java.lang.Void>

Field Summary

Fields

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

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onBlur, onFocus, onValueChanged, onVisibilityChanged

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

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
Button(Template template, RECORD templateRecord)
Button(Template template, RECORD templateRecord, Component dropDownComponent)

Method Summary

Modifier and Type	Method	Description
void	closeDropDown()
static Button<BaseTemplateRecord>	create(java.lang.String caption)
static Button<BaseTemplateRecord>	create(java.lang.String caption, Component dropDownComponent)
static Button<BaseTemplateRecord>	create(org.teamapps.icons.Icon icon, java.lang.String caption)
static Button<BaseTemplateRecord>	create(org.teamapps.icons.Icon icon, java.lang.String caption, Component dropDownComponent)
static Button<BaseTemplateRecord>	create(BaseTemplate template, java.lang.String caption)
static Button<BaseTemplateRecord>	create(BaseTemplate template, org.teamapps.icons.Icon icon, java.lang.String caption)
static Button<BaseTemplateRecord>	create(BaseTemplate template, org.teamapps.icons.Icon icon, java.lang.String caption, Component dropDownComponent)
org.teamapps.dto.UiField	createUiComponent()
Component	getDropDownComponent()
java.lang.Integer	getMinDropDownHeight()
java.lang.Integer	getMinDropDownWidth()
java.lang.String	getOnClickJavaScript()
PropertyProvider<RECORD>	getPropertyProvider()
Template	getTemplate()
RECORD	getTemplateRecord()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isOpenDropDownIfNotSet()
Button<RECORD>	setColor(org.teamapps.common.format.Color color)
Button<RECORD>	setDropDownComponent(Component dropDownComponent)
Button<RECORD>	setMinDropDownHeight(java.lang.Integer minDropDownHeight)
Button<RECORD>	setMinDropDownSize(java.lang.Integer minDropDownWidth, java.lang.Integer minDropDownHeight)
Button<RECORD>	setMinDropDownWidth(java.lang.Integer minDropDownWidth)
void	setOnClickJavaScript(java.lang.String onClickJavaScript)
Button<RECORD>	setOpenDropDownIfNotSet(boolean openDropDownIfNotSet)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setPropertyProvider(PropertyProvider<RECORD> propertyProvider)
Button<RECORD>	setTemplate(Template template)
Button<RECORD>	setTemplateRecord(RECORD templateRecord)

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, convertUiValueToUxValue, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isEmptyValue, isRequired, isValid, isValueChangedByClient, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validate

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

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, 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

onClicked

public final Event<java.lang.Void> onClicked

onDropDownOpened

public final Event<java.lang.Void> onDropDownOpened

Constructor Detail

Button

public Button(Template template,
              RECORD templateRecord,
              Component dropDownComponent)

Button

public Button(Template template,
              RECORD templateRecord)

Method Detail

create

public static Button<BaseTemplateRecord> create(BaseTemplate template,
                                                org.teamapps.icons.Icon icon,
                                                java.lang.String caption,
                                                Component dropDownComponent)

create

public static Button<BaseTemplateRecord> create(BaseTemplate template,
                                                org.teamapps.icons.Icon icon,
                                                java.lang.String caption)

create

public static Button<BaseTemplateRecord> create(BaseTemplate template,
                                                java.lang.String caption)

create

public static Button<BaseTemplateRecord> create(org.teamapps.icons.Icon icon,
                                                java.lang.String caption,
                                                Component dropDownComponent)

create

public static Button<BaseTemplateRecord> create(java.lang.String caption,
                                                Component dropDownComponent)

create

public static Button<BaseTemplateRecord> create(org.teamapps.icons.Icon icon,
                                                java.lang.String caption)

create

public static Button<BaseTemplateRecord> create(java.lang.String caption)

createUiComponent

public org.teamapps.dto.UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

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

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<java.lang.Void>

getTemplate

public Template getTemplate()

setTemplate

public Button<RECORD> setTemplate(Template template)

getTemplateRecord

public RECORD getTemplateRecord()

setTemplateRecord

public Button<RECORD> setTemplateRecord(RECORD templateRecord)

setColor

public Button<RECORD> setColor(org.teamapps.common.format.Color color)

getPropertyProvider

public PropertyProvider<RECORD> getPropertyProvider()

setPropertyProvider

public void setPropertyProvider(PropertyProvider<RECORD> propertyProvider)

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

getMinDropDownWidth

public java.lang.Integer getMinDropDownWidth()

setMinDropDownWidth

public Button<RECORD> setMinDropDownWidth(java.lang.Integer minDropDownWidth)

getMinDropDownHeight

public java.lang.Integer getMinDropDownHeight()

setMinDropDownHeight

public Button<RECORD> setMinDropDownHeight(java.lang.Integer minDropDownHeight)

setMinDropDownSize

public Button<RECORD> setMinDropDownSize(java.lang.Integer minDropDownWidth,
                                         java.lang.Integer minDropDownHeight)

isOpenDropDownIfNotSet

public boolean isOpenDropDownIfNotSet()

setOpenDropDownIfNotSet

public Button<RECORD> setOpenDropDownIfNotSet(boolean openDropDownIfNotSet)

getDropDownComponent

public Component getDropDownComponent()

setDropDownComponent

public Button<RECORD> setDropDownComponent(Component dropDownComponent)

closeDropDown

public void closeDropDown()

getOnClickJavaScript

public java.lang.String getOnClickJavaScript()

setOnClickJavaScript

public void setOnClickJavaScript(java.lang.String onClickJavaScript)