io.jmix.ui.component.impl

Class InputDialogFacetImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.InputDialogFacetImpl

All Implemented Interfaces:

ActionsAwareDialogFacet<InputDialogFacet>, Facet, HasSubParts, InputDialogFacet

public class InputDialogFacetImpl
extends AbstractFacet
implements InputDialogFacet

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.ActionsAwareDialogFacet

ActionsAwareDialogFacet.DialogAction<T>, ActionsAwareDialogFacet.DialogActionPerformedEvent<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	actionId
protected java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>>	actions
protected java.lang.String	buttonId
protected java.lang.String	caption
protected java.util.List<java.util.function.Consumer<InputDialog.InputDialogCloseEvent>>	closeListeners
protected DialogActions	dialogActions
protected java.util.function.Consumer<InputDialog.InputDialogResult>	dialogResultHandler
protected SizeWithUnit	height
protected InputDialog	inputDialog
protected InputParameter[]	parameters
protected java.util.function.Function<InputDialog.ValidationContext,ValidationErrors>	validator
protected SizeWithUnit	width

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor and Description
InputDialogFacetImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> closeListener) Adds the given Consumer as dialog InputDialog.InputDialogCloseEvent listener.
InputDialog	create() Creates InputDialog.
protected InputDialogAction	createAction(ActionsAwareDialogFacet.DialogAction<InputDialogFacet> action)
protected InputDialogAction[]	createActions(java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> actions)
java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>>	getActions()
java.lang.String	getActionTarget()
java.lang.String	getButtonTarget()
java.lang.String	getCaption()
DialogActions	getDialogActions()
float	getHeight()
SizeUnit	getHeightSizeUnit()
java.lang.Object	getSubPart(java.lang.String name)
float	getWidth()
SizeUnit	getWidthSizeUnit()
protected void	internalRemoveCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> closeListener)
void	setActions(java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> actions) Sets dialog actions.
void	setActionTarget(java.lang.String actionId) Sets that dialog should be shown when action with id actionId is performed.
void	setButtonTarget(java.lang.String buttonId) Sets that dialog should be shown when button with id actionId is clicked.
void	setCaption(java.lang.String caption) Sets dialog caption.
void	setDialogActions(DialogActions dialogActions) Defines a set of predefined actions to use in dialog.
void	setDialogResultHandler(java.util.function.Consumer<InputDialog.InputDialogResult> dialogResultHandler) Sets input dialog result handler.
void	setHeight(java.lang.String height) Sets dialog height.
void	setOwner(Frame owner) Sets owner frame (Window or Fragment) to the facet.
void	setParameters(InputParameter... parameters) Sets input dialog parameters.
void	setValidator(java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator) Sets additional handler for field validation.
void	setWidth(java.lang.String width) Sets dialog width.
InputDialog	show() Shows InputDialog.
protected void	subscribe()
protected void	subscribeOnAction(Frame owner)
protected void	subscribeOnButton(Frame owner)

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId

Field Detail

caption

protected java.lang.String caption

width

protected SizeWithUnit width

height

protected SizeWithUnit height

parameters

protected InputParameter[] parameters

actionId

protected java.lang.String actionId

buttonId

protected java.lang.String buttonId

dialogActions

protected DialogActions dialogActions

dialogResultHandler

protected java.util.function.Consumer<InputDialog.InputDialogResult> dialogResultHandler

actions

protected java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> actions

validator

protected java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator

closeListeners

protected java.util.List<java.util.function.Consumer<InputDialog.InputDialogCloseEvent>> closeListeners

inputDialog

protected InputDialog inputDialog

Constructor Detail

InputDialogFacetImpl

public InputDialogFacetImpl()

Method Detail

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Description copied from interface: InputDialogFacet

Sets dialog caption.

Specified by:

setCaption in interface InputDialogFacet

Parameters:

caption - caption

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface InputDialogFacet

Returns:

dialog caption

setWidth

public void setWidth(@Nullable
                     java.lang.String width)

Description copied from interface: InputDialogFacet

Sets dialog width.

Specified by:

setWidth in interface InputDialogFacet

Parameters:

width - width

getWidth

public float getWidth()

Specified by:

getWidth in interface InputDialogFacet

Returns:

dialog width

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Specified by:

getWidthSizeUnit in interface InputDialogFacet

Returns:

dialog width size unit

setHeight

public void setHeight(@Nullable
                      java.lang.String height)

Description copied from interface: InputDialogFacet

Sets dialog height.

Specified by:

setHeight in interface InputDialogFacet

Parameters:

height - height

getHeight

public float getHeight()

Specified by:

getHeight in interface InputDialogFacet

Returns:

dialog height

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Specified by:

getHeightSizeUnit in interface InputDialogFacet

Returns:

dialog height size unit

getActionTarget

@Nullable
public java.lang.String getActionTarget()

Specified by:

getActionTarget in interface InputDialogFacet

Returns:

id of action that triggers dialog

setActionTarget

public void setActionTarget(@Nullable
                            java.lang.String actionId)

Description copied from interface: InputDialogFacet

Sets that dialog should be shown when action with id actionId is performed.

Specified by:

setActionTarget in interface InputDialogFacet

Parameters:

actionId - action id

getButtonTarget

@Nullable
public java.lang.String getButtonTarget()

Specified by:

getButtonTarget in interface InputDialogFacet

Returns:

id of button that triggers dialog

setButtonTarget

public void setButtonTarget(@Nullable
                            java.lang.String buttonId)

Description copied from interface: InputDialogFacet

Sets that dialog should be shown when button with id actionId is clicked.

Specified by:

setButtonTarget in interface InputDialogFacet

Parameters:

buttonId - button id

setDialogActions

public void setDialogActions(@Nullable
                             DialogActions dialogActions)

Description copied from interface: InputDialogFacet

Defines a set of predefined actions to use in dialog.

Specified by:

setDialogActions in interface InputDialogFacet

Parameters:

dialogActions - one of DialogActions values

getDialogActions

@Nullable
public DialogActions getDialogActions()

Specified by:

getDialogActions in interface InputDialogFacet

Returns:

set of predefined actions used in dialog

setParameters

public void setParameters(InputParameter... parameters)

Description copied from interface: InputDialogFacet

Sets input dialog parameters.

Specified by:

setParameters in interface InputDialogFacet

Parameters:

parameters - set of InputParameter

setActions

public void setActions(@Nullable
                       java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> actions)

Description copied from interface: ActionsAwareDialogFacet

Sets dialog actions.

Specified by:

setActions in interface ActionsAwareDialogFacet<InputDialogFacet>

Parameters:

actions - actions

getActions

@Nullable
public java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> getActions()

Specified by:

getActions in interface ActionsAwareDialogFacet<InputDialogFacet>

Returns:

dialog actions

addCloseListener

public io.jmix.core.common.event.Subscription addCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> closeListener)

Description copied from interface: InputDialogFacet

Adds the given Consumer as dialog InputDialog.InputDialogCloseEvent listener.

Specified by:

addCloseListener in interface InputDialogFacet

Parameters:

closeListener - close listener

Returns:

close event subscription

internalRemoveCloseListener

protected void internalRemoveCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> closeListener)

setDialogResultHandler

public void setDialogResultHandler(java.util.function.Consumer<InputDialog.InputDialogResult> dialogResultHandler)

Description copied from interface: InputDialogFacet

Sets input dialog result handler.

Specified by:

setDialogResultHandler in interface InputDialogFacet

Parameters:

dialogResultHandler - result handler

setValidator

public void setValidator(java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator)

Description copied from interface: InputDialogFacet

Sets additional handler for field validation. It receives input dialog context and must return ValidationErrors instance. Returned validation errors will be shown with another errors from fields.

Specified by:

setValidator in interface InputDialogFacet

Parameters:

validator - validator

getSubPart

@Nullable
public java.lang.Object getSubPart(java.lang.String name)

Specified by:

getSubPart in interface HasSubParts

create

public InputDialog create()

Description copied from interface: InputDialogFacet

Creates InputDialog.

Specified by:

create in interface InputDialogFacet

Returns:

input dialog instance

show

public InputDialog show()

Description copied from interface: InputDialogFacet

Shows InputDialog.

Specified by:

show in interface InputDialogFacet

setOwner

public void setOwner(@Nullable
                     Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

subscribe

protected void subscribe()

subscribeOnAction

protected void subscribeOnAction(Frame owner)

subscribeOnButton

protected void subscribeOnButton(Frame owner)

createActions

protected InputDialogAction[] createActions(@Nullable
                                            java.util.Collection<ActionsAwareDialogFacet.DialogAction<InputDialogFacet>> actions)

createAction

protected InputDialogAction createAction(ActionsAwareDialogFacet.DialogAction<InputDialogFacet> action)