@StudioFacet(xmlElement="inputDialog", caption="InputDialog", description="Prepares and shows input dialogs", defaultProperty="caption", category="Facets", icon="io/jmix/ui/icon/facet/dialog.svg") public interface InputDialogFacet extends Facet, ActionsAwareDialogFacet<InputDialogFacet>, HasSubParts
ActionsAwareDialogFacet.DialogAction<T>, ActionsAwareDialogFacet.DialogActionPerformedEvent<T>
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.
|
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.
|
getActions, setActions
getSubPart
@StudioProperty(type=LOCALIZED_STRING) void setCaption(@Nullable java.lang.String caption)
caption
- caption@Nullable java.lang.String getCaption()
@StudioProperty(type=SIZE) void setWidth(@Nullable java.lang.String width)
width
- widthfloat getWidth()
SizeUnit getWidthSizeUnit()
@StudioProperty(type=SIZE) void setHeight(@Nullable java.lang.String height)
height
- heightfloat getHeight()
SizeUnit getHeightSizeUnit()
@StudioProperty(name="onAction", type=COMPONENT_REF, options="io.jmix.ui.action.Action") void setActionTarget(@Nullable java.lang.String actionId)
actionId
is performed.actionId
- action id@Nullable java.lang.String getActionTarget()
@StudioProperty(name="onButton", type=COMPONENT_REF, options="io.jmix.ui.component.Button") void setButtonTarget(@Nullable java.lang.String buttonId)
actionId
is clicked.buttonId
- button id@Nullable java.lang.String getButtonTarget()
@StudioProperty(type=ENUMERATION) void setDialogActions(@Nullable DialogActions dialogActions)
dialogActions
- one of DialogActions
values@Nullable DialogActions getDialogActions()
io.jmix.core.common.event.Subscription addCloseListener(java.util.function.Consumer<InputDialog.InputDialogCloseEvent> closeListener)
Consumer
as dialog InputDialog.InputDialogCloseEvent
listener.closeListener
- close listenervoid setDialogResultHandler(java.util.function.Consumer<InputDialog.InputDialogResult> dialogResultHandler)
dialogResultHandler
- result handlervoid setValidator(java.util.function.Function<InputDialog.ValidationContext,ValidationErrors> validator)
ValidationErrors
instance. Returned validation errors will be shown with another errors from fields.validator
- validator@StudioElementsGroup(xmlElement="parameters", caption="Parameters", icon="io/jmix/ui/icon/element/parameters.svg") void setParameters(InputParameter... parameters)
parameters
- set of InputParameter
InputDialog create()
InputDialog show()