Package io.jmix.ui.component.impl

Class OptionDialogFacetImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.OptionDialogFacetImpl

All Implemented Interfaces:

ActionsAwareDialogFacet<OptionDialogFacet>, Facet, HasSubParts, OptionDialogFacet

public class OptionDialogFacetImpl
extends AbstractFacet
implements OptionDialogFacet

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	Description
protected String	actionId
protected Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>>	actions
protected String	buttonId
protected String	caption
protected ContentMode	contentMode
protected SizeWithUnit	height
protected boolean	htmlSanitizerEnabled
protected String	message
protected String	styleName
protected SizeWithUnit	width
protected WindowMode	windowMode

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

id, owner

Constructor Summary

Constructors

Constructor	Description
OptionDialogFacetImpl()

Method Summary

Modifier and Type	Method	Description
protected BaseAction	createAction(ActionsAwareDialogFacet.DialogAction<OptionDialogFacet> action)
protected Action[]	createActions()
Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>>	getActions()
String	getActionTarget()
String	getButtonTarget()
String	getCaption()
ContentMode	getContentMode()
float	getHeight()
SizeUnit	getHeightSizeUnit()
String	getMessage()
String	getStyleName()
Object	getSubPart(String name)
float	getWidth()
SizeUnit	getWidthSizeUnit()
WindowMode	getWindowMode()
boolean	isHtmlSanitizerEnabled()
void	setActions(Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>> actions)	Sets dialog actions.
void	setActionTarget(String actionId)	Sets that dialog should be shown when action with id actionId is performed.
void	setButtonTarget(String buttonId)	Sets that dialog should be shown when button with id actionId is clicked.
void	setCaption(String caption)	Sets dialog caption.
void	setContentMode(ContentMode contentMode)	Sets dialog message content mode.
void	setHeight(String height)	Sets dialog height.
void	setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)	Sets whether html sanitizer is enabled or not for dialog content.
void	setMessage(String message)	Sets dialog message.
void	setOwner(Frame owner)	Sets owner frame (Window or Fragment) to the facet.
void	setStyleName(String styleName)	Sets dialog style name.
void	setWidth(String width)	Sets dialog width.
void	setWindowMode(WindowMode windowMode)	Sets the mode of the dialog window
void	show()	Shows dialog.
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 Details

caption

protected String caption

message

protected String message

width

protected SizeWithUnit width

height

protected SizeWithUnit height

styleName

protected String styleName

contentMode

protected ContentMode contentMode

windowMode

protected WindowMode windowMode

actionId

protected String actionId

buttonId

protected String buttonId

actions

protected Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>> actions

htmlSanitizerEnabled

protected boolean htmlSanitizerEnabled

Constructor Details

OptionDialogFacetImpl

public OptionDialogFacetImpl()

Method Details

setActions

public void setActions(@Nullable
 Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>> actions)

Description copied from interface: ActionsAwareDialogFacet

Sets dialog actions.

Specified by:

setActions in interface ActionsAwareDialogFacet<OptionDialogFacet>

Parameters:

actions - actions

getActions

@Nullable
public Collection<ActionsAwareDialogFacet.DialogAction<OptionDialogFacet>> getActions()

Specified by:

getActions in interface ActionsAwareDialogFacet<OptionDialogFacet>

Returns:

dialog actions

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: OptionDialogFacet

Sets dialog caption.

Specified by:

setCaption in interface OptionDialogFacet

Parameters:

caption - caption

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface OptionDialogFacet

Returns:

dialog caption

setMessage

public void setMessage(@Nullable
 String message)

Description copied from interface: OptionDialogFacet

Sets dialog message.

Specified by:

setMessage in interface OptionDialogFacet

Parameters:

message - message

getMessage

@Nullable
public String getMessage()

Specified by:

getMessage in interface OptionDialogFacet

Returns:

dialog message

setContentMode

public void setContentMode(ContentMode contentMode)

Description copied from interface: OptionDialogFacet

Sets dialog message content mode.

Specified by:

setContentMode in interface OptionDialogFacet

Parameters:

contentMode - content mode

getContentMode

public ContentMode getContentMode()

Specified by:

getContentMode in interface OptionDialogFacet

Returns:

dialog message content mode

setWindowMode

public void setWindowMode(WindowMode windowMode)

Description copied from interface: OptionDialogFacet

Sets the mode of the dialog window

Specified by:

setWindowMode in interface OptionDialogFacet

Parameters:

windowMode - the mode of the dialog window

getWindowMode

public WindowMode getWindowMode()

Specified by:

getWindowMode in interface OptionDialogFacet

Returns:

the mode of the dialog window

setStyleName

public void setStyleName(String styleName)

Description copied from interface: OptionDialogFacet

Sets dialog style name.

Specified by:

setStyleName in interface OptionDialogFacet

Parameters:

styleName - style name

getStyleName

@Nullable
public String getStyleName()

Specified by:

getStyleName in interface OptionDialogFacet

Returns:

dialog style name

setWidth

public void setWidth(@Nullable
 String width)

Description copied from interface: OptionDialogFacet

Sets dialog width.

Specified by:

setWidth in interface OptionDialogFacet

Parameters:

width - width

getWidth

public float getWidth()

Specified by:

getWidth in interface OptionDialogFacet

Returns:

dialog width

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Specified by:

getWidthSizeUnit in interface OptionDialogFacet

Returns:

dialog width size unit

setHeight

public void setHeight(@Nullable
 String height)

Description copied from interface: OptionDialogFacet

Sets dialog height.

Specified by:

setHeight in interface OptionDialogFacet

Parameters:

height - height

getHeight

public float getHeight()

Specified by:

getHeight in interface OptionDialogFacet

Returns:

dialog height

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Specified by:

getHeightSizeUnit in interface OptionDialogFacet

Returns:

dialog height size unit

getActionTarget

@Nullable
public String getActionTarget()

Specified by:

getActionTarget in interface OptionDialogFacet

Returns:

id of action that triggers dialog

setActionTarget

public void setActionTarget(@Nullable
 String actionId)

Description copied from interface: OptionDialogFacet

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

Specified by:

setActionTarget in interface OptionDialogFacet

Parameters:

actionId - action id

getButtonTarget

@Nullable
public String getButtonTarget()

Specified by:

getButtonTarget in interface OptionDialogFacet

Returns:

id of button that triggers dialog

setButtonTarget

public void setButtonTarget(@Nullable
 String buttonId)

Description copied from interface: OptionDialogFacet

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

Specified by:

setButtonTarget in interface OptionDialogFacet

Parameters:

buttonId - button id

setHtmlSanitizerEnabled

public void setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)

Description copied from interface: OptionDialogFacet

Sets whether html sanitizer is enabled or not for dialog content.

Specified by:

setHtmlSanitizerEnabled in interface OptionDialogFacet

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Specified by:

isHtmlSanitizerEnabled in interface OptionDialogFacet

Returns:

html sanitizer is enabled for dialog content

show

public void show()

Description copied from interface: OptionDialogFacet

Shows dialog.

Specified by:

show in interface OptionDialogFacet

getSubPart

@Nullable
public Object getSubPart(String name)

Specified by:

getSubPart in interface HasSubParts

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 Action[] createActions()

createAction

protected BaseAction createAction(ActionsAwareDialogFacet.DialogAction<OptionDialogFacet> action)