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.Boolean>

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

All Implemented Interfaces:

Component

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

Field Summary

Fields

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

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

onValueChanged, onVisibilityChanged

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

onDestroyed, 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
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.api.Icon icon, java.lang.String caption)
static Button<BaseTemplateRecord>	create(org.teamapps.icons.api.Icon icon, java.lang.String caption, Component dropDownComponent)
org.teamapps.dto.UiField	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
Component	getDropDownComponent()
java.lang.Integer	getMinDropDownHeight()
java.lang.Integer	getMinDropDownWidth()
PropertyExtractor<RECORD>	getPropertyExtractor()
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)
Button<RECORD>	setOpenDropDownIfNotSet(boolean openDropDownIfNotSet)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
Button<RECORD>	setTemplate(Template template)
Button<RECORD>	setTemplateRecord(RECORD templateRecord)

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

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

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

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

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(org.teamapps.icons.api.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.api.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 Component

Overrides:

handleUiEvent in class AbstractField<java.lang.Boolean>

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)

getPropertyExtractor

public PropertyExtractor<RECORD> getPropertyExtractor()

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)

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