com.haulmont.cuba.gui.components

Interface InputDialogFacet

All Superinterfaces:

ActionsAwareDialogFacet<InputDialogFacet>, Facet, HasSubParts

@StudioFacet(xmlElement="inputDialog",
             caption="Input Dialog",
             description="Prepares and shows input dialogs",
             defaultProperty="caption",
             category="Facets",
             icon="icon/dialog.svg",
             documentationURL="https://doc.cuba-platform.com/manual-%VERSION%/gui_InputDialogFacet.html")
public interface InputDialogFacet
extends Facet, ActionsAwareDialogFacet<InputDialogFacet>, HasSubParts

Prepares and shows input dialogs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InputDialogFacet.CloseEvent Event that is fired when InputDialog is closed.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ActionsAwareDialogFacet

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

Method Summary

Modifier and Type	Method and Description
Subscription	addCloseListener(java.util.function.Consumer<InputDialogFacet.CloseEvent> closeListener) Adds the given Consumer as dialog InputDialog.InputDialogCloseEvent listener.
InputDialog	create() Creates InputDialog.
java.lang.String	getActionTarget()
java.lang.String	getButtonTarget()
java.lang.String	getCaption()
DialogActions	getDialogActions()
float	getHeight()
SizeUnit	getHeightSizeUnit()
float	getWidth()
SizeUnit	getWidthSizeUnit()
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	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.

Methods inherited from interface com.haulmont.cuba.gui.components.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsAwareDialogFacet

getActions, setActions

Methods inherited from interface com.haulmont.cuba.gui.components.HasSubParts

getSubPart

Method Detail

setCaption

@StudioProperty(type=LOCALIZED_STRING)
void setCaption(java.lang.String caption)

Sets dialog caption.

Parameters:

caption - caption

getCaption

java.lang.String getCaption()

Returns:

dialog caption

setWidth

@StudioProperty(type=SIZE)
void setWidth(java.lang.String width)

Sets dialog width.

Parameters:

width - width

getWidth

float getWidth()

Returns:

dialog width

getWidthSizeUnit

SizeUnit getWidthSizeUnit()

Returns:

dialog width size unit

setHeight

@StudioProperty(type=SIZE)
void setHeight(java.lang.String height)

Sets dialog height.

Parameters:

height - height

getHeight

float getHeight()

Returns:

dialog height

getHeightSizeUnit

SizeUnit getHeightSizeUnit()

Returns:

dialog height size unit

setActionTarget

@StudioProperty(name="onAction",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Action")
void setActionTarget(java.lang.String actionId)

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

Parameters:

actionId - action id

getActionTarget

java.lang.String getActionTarget()

Returns:

id of action that triggers dialog

setButtonTarget

@StudioProperty(name="onButton",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Button")
void setButtonTarget(java.lang.String buttonId)

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

Parameters:

buttonId - button id

getButtonTarget

java.lang.String getButtonTarget()

Returns:

id of button that triggers dialog

setDialogActions

@StudioProperty(type=ENUMERATION)
void setDialogActions(DialogActions dialogActions)

Defines a set of predefined actions to use in dialog.

Parameters:

dialogActions - one of DialogActions values

getDialogActions

DialogActions getDialogActions()

Returns:

set of predefined actions used in dialog

addCloseListener

Subscription addCloseListener(java.util.function.Consumer<InputDialogFacet.CloseEvent> closeListener)

Adds the given Consumer as dialog InputDialog.InputDialogCloseEvent listener.

Parameters:

closeListener - close listener

Returns:

close event subscription

setDialogResultHandler

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

Sets input dialog result handler.

Parameters:

dialogResultHandler - result handler

setValidator

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

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.

Parameters:

validator - validator

setParameters

void setParameters(InputParameter... parameters)

Sets input dialog parameters.

Parameters:

parameters - set of InputParameter

create

InputDialog create()

Creates InputDialog.

Returns:

input dialog instance

show

InputDialog show()

Shows InputDialog.