pl.fhframework.model.forms

Class Button

java.lang.Object

pl.fhframework.model.forms.Component

pl.fhframework.model.forms.FormElement

pl.fhframework.model.forms.FormElementWithAriaSupport

pl.fhframework.model.forms.FormElementWithConfirmationSupport

pl.fhframework.model.forms.Button

All Implemented Interfaces:

Cloneable, pl.fhframework.aspects.snapshots.model.IUnmanagedUseCaseParameter, IHasBoundableLabel, IDesignEventSource, IEventSource, Boundable, IChangeableByClient, Styleable, TableComponent<Button>

@Control(parents={PanelGroup.class,Column.class,ColumnOptimized.class,Tab.class,pl.fhframework.model.forms.Form.class,ButtonGroup.class,Group.class,Row.class,Footer.class,Repeater.class},
         invalidParents=Table.class,
         canBeDesigned=true)
 @DocumentedComponent(category=BUTTONS_AND_OTHER,
                     documentationExample=true,
                     value="Button which represents HTML input",
                     icon="fa fa-square")
 @DesignerControl(defaultWidth=2)
public class Button
extends FormElementWithConfirmationSupport
implements TableComponent<Button>, Styleable, IHasBoundableLabel

Class representing xml component of Button. Every field represents xml attribute of button tag. Example <Button label="button_1"/>. Every field is parsed as json for javascript. If field should be ingored by JSON, use @JsonIgnore. There can be used any annotations for json generator.

Nested Class Summary

Nested classes/interfaces inherited from class pl.fhframework.model.forms.Component

Component.ComponentAttr, Component.IGenerationUtils

Nested classes/interfaces inherited from interface pl.fhframework.model.forms.Styleable

Styleable.Style

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_LABEL
static String	ATTR_ON_CLICK
static String	ATTR_STYLE
static String	TYPE_NAME

Fields inherited from class pl.fhframework.model.forms.FormElementWithConfirmationSupport

CONFIRATION_MSG_ATTR

Fields inherited from class pl.fhframework.model.forms.FormElementWithAriaSupport

ariaLabel, ariaLabelBinding, ATTR_ARIA_LABEL

Fields inherited from class pl.fhframework.model.forms.FormElement

htmlAccessibilityRole

Fields inherited from class pl.fhframework.model.forms.Component

ACCESSIBILITY, RESOLUTION_SIZE

Fields inherited from interface pl.fhframework.events.IDesignEventSource

ON_DROP_COMPONENT, ON_RESIZE_COMPONENT

Constructor Summary

Constructors

Constructor and Description
Button(Form form)

Method Summary

Modifier and Type	Method and Description
Button	createNewSameComponent() Create a new component of the same type.
void	doCopy(Table table, Map<String,String> iteratorReplacements, Button clonedButton) Copies values of attributes with replaced iterators in bindings and actions to a new component of the same type.
protected List<ActionBinding>	getAvailablityAffectingActions()
Optional<ActionBinding>	getEventHandler(InMessageEventData eventData)
String	getType()
void	init()
protected boolean	processStyleBinding(ElementChanges elementChanges, boolean refreshView)
void	setOnClick(ActionBinding onClick)
IActionCallbackContext	setOnClick(IActionCallback callback)
ElementChanges	updateView()

Methods inherited from class pl.fhframework.model.forms.FormElementWithConfirmationSupport

getConfirmationMsg, getConfirmationMsgBinding, getConfirmOnEvent, processConfirmationMsgBinding, setConfirmationMsg, setConfirmationMsgBinding, setConfirmOnEvent, updateModel

Methods inherited from class pl.fhframework.model.forms.FormElementWithAriaSupport

getAriaLabel, getAriaLabelBinding, setAriaLabelBinding, updateAriaLabelView

Methods inherited from class pl.fhframework.model.forms.FormElement

getHeight, getHint, getHintBinding, getHintPlacement, getHintTrigger, getHintType, getHorizontalAlign, getHtmlAccessibilityRole, getInlineStyle, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleClasses, getVerticalAlign, getWidth, getWrapperStyle, isPush, refreshElementToForm, refreshView, refreshView, setHeight, setHintBinding, setHintPlacement, setHintTrigger, setHintType, setHorizontalAlign, setHtmlAccessibilityRole, setInlineStyle, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPush, setStyleClasses, setVerticalAlign, setWidth, setWrapperStyle, tryParseAttributeInPixelOrPercentageUnit, tryParseAttributeInPixelUnit, tryParseAttributeInPixelUnit

Methods inherited from class pl.fhframework.model.forms.Component

areModelValuesTheSame, areValuesTheSame, calculateAvailability, clone, convertBindingValueToString, convertBindingValueToString, convertValue, convertValueToString, convertValueToString, createAdHocModelBinding, equals, finalizeReading, generateId, getAccessibilityRules, getAvailability, getAvailabilityModelBinding, getBindingContext, getEventProcessingForm, getForm, getGeneratedIdPrefix, getGenerationUtils, getGroupingParentComponent, getId, getOnDesignerToolboxDrop, getRawId, hashCode, isArtificial, isGeneratedId, isInitDone, isInvisible, isStopProcessingUpdateView, onProcessingFinish, onProcessingStart, postClone, preConfigureClear, prepareEventDataArgument, refreshAvailability, resetInitDone, setArtificial, setAvailability, setAvailabilityModelBinding, setBindingContext, setGenerationUtils, setGroupingParentComponent, setId, setInvisible, setOnDesignerToolboxDrop, setOnDesignerToolboxDrop, setRawId, setStopProcessingUpdateView, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.fhframework.model.forms.TableComponent

doCopy, getCopy, getCopy

Methods inherited from interface pl.fhframework.core.forms.IHasBoundableLabel

getLabelModelBinding

Methods inherited from interface pl.fhframework.model.forms.Boundable

getOptionalFormatter, updateBinding, updateBinding, updateBindingForValue, updateBindingForValue

Methods inherited from interface pl.fhframework.events.IDesignEventSource

isDesignActionAllowed, isDesignDeletable

Methods inherited from interface pl.fhframework.events.IEventSource

isModificationEvent

Field Detail

ATTR_LABEL

public static final String ATTR_LABEL

See Also:

Constant Field Values

ATTR_STYLE

public static final String ATTR_STYLE

See Also:

Constant Field Values

ATTR_ON_CLICK

public static final String ATTR_ON_CLICK

See Also:

Constant Field Values

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

Button

public Button(Form form)

Method Detail

init

public void init()

Overrides:

init in class FormElementWithConfirmationSupport

getType

public String getType()

Overrides:

getType in class Component

getEventHandler

public Optional<ActionBinding> getEventHandler(InMessageEventData eventData)

Specified by:

getEventHandler in interface IEventSource

Overrides:

getEventHandler in class Component

updateView

public ElementChanges updateView()

Overrides:

updateView in class FormElementWithConfirmationSupport

processStyleBinding

protected boolean processStyleBinding(ElementChanges elementChanges,
                                      boolean refreshView)

createNewSameComponent

public Button createNewSameComponent()

Description copied from interface: TableComponent

Create a new component of the same type.

Specified by:

createNewSameComponent in interface TableComponent<Button>

Returns:

a new component of the same type

doCopy

public void doCopy(Table table,
                   Map<String,String> iteratorReplacements,
                   Button clonedButton)

Description copied from interface: TableComponent

Copies values of attributes with replaced iterators in bindings and actions to a new component of the same type.

Specified by:

doCopy in interface TableComponent<Button>

Parameters:

table - table

iteratorReplacements - iterator replacements

clonedButton - a new component of the same type

getAvailablityAffectingActions

protected List<ActionBinding> getAvailablityAffectingActions()

Overrides:

getAvailablityAffectingActions in class Component

setOnClick

public IActionCallbackContext setOnClick(IActionCallback callback)

setOnClick

public void setOnClick(ActionBinding onClick)