io.jmix.ui.component

Interface PopupView

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

All Known Implementing Classes:

PopupViewImpl

@StudioComponent(caption="PopupView",
                 category="Components",
                 xmlElement="popupView",
                 icon="io/jmix/ui/icon/component/popupView.svg",
                 canvasBehaviour=BUTTON,
                 canvasText="New Minimized Value",
                 canvasTextProperty="minimizedValue",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/popup-view.html")
public interface PopupView
extends Component.HasCaption, Component.BelongToFrame, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

A component for displaying a two different views to data. The minimized view is normally used to render the component, and when it is clicked the full view is displayed on a popup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PopupView.PopupPosition Popup position.
static class	PopupView.PopupVisibilityEvent Event sent when the visibility of the popup changes.

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

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addPopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener)
java.lang.String	getMinimizedValue()
Component	getPopupContent()
PopupView.PopupPosition	getPopupPosition() return PopupPosition or null if position is set via setPopupPosition(PopupPosition)
int	getPopupPositionLeft()
int	getPopupPositionTop()
boolean	isCaptionAsHtml()
boolean	isHideOnMouseOut()
boolean	isPopupVisible()
void	setCaptionAsHtml(boolean captionAsHtml) Sets caption rendering as HTML.
void	setHideOnMouseOut(boolean hideOnMouseOut) Sets possibility to close popup window on cursor out.
void	setMinimizedValue(java.lang.String minimizedValue) Sets value for the label of component.
void	setPopupContent(Component popupContent) Sets inner content for the popup window.
void	setPopupPosition(int top, int left) Sets the popup position.
void	setPopupPosition(PopupView.PopupPosition position) Sets the popup position.
void	setPopupPositionLeft(int left) Sets the left popup position.
void	setPopupPositionTop(int top) Sets the top popup position.
void	setPopupVisible(boolean popupVisible) Sets visibility for the popup window.

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

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

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setPopupVisible

void setPopupVisible(boolean popupVisible)

Sets visibility for the popup window.

Parameters:

popupVisible - popup visibility.

isPopupVisible

boolean isPopupVisible()

Returns:

true if popup is visible.

setMinimizedValue

@StudioProperty(type=LOCALIZED_STRING)
void setMinimizedValue(java.lang.String minimizedValue)

Sets value for the label of component. Value of the label can contain HTML.

Parameters:

minimizedValue - label text.

getMinimizedValue

java.lang.String getMinimizedValue()

Returns:

value of the label of component.

setPopupContent

void setPopupContent(@Nullable
                     Component popupContent)

Sets inner content for the popup window.

Parameters:

popupContent - popup component.

getPopupContent

@Nullable
Component getPopupContent()

Returns:

popup content component.

setHideOnMouseOut

@StudioProperty(defaultValue="true",
                initialValue="false")
void setHideOnMouseOut(boolean hideOnMouseOut)

Sets possibility to close popup window on cursor out.

Parameters:

hideOnMouseOut - popup hide option.

isHideOnMouseOut

boolean isHideOnMouseOut()

Returns:

true if popup window closes on cursor out.

setCaptionAsHtml

void setCaptionAsHtml(boolean captionAsHtml)

Sets caption rendering as HTML.

Specified by:

setCaptionAsHtml in interface HasHtmlCaption

Parameters:

captionAsHtml - true if we want to show caption as HTML.

See Also:

Component.HasCaption.setCaption(String)

isCaptionAsHtml

boolean isCaptionAsHtml()

Specified by:

isCaptionAsHtml in interface HasHtmlCaption

Returns:

true if caption is shown as HTML.

setPopupPosition

void setPopupPosition(int top,
                      int left)

Sets the popup position.

Parameters:

top - the top popup position in pixels

left - the left popup position in pixels

setPopupPositionTop

@StudioProperty(name="popupTop",
                defaultValue="-1")
void setPopupPositionTop(int top)

Sets the top popup position.

Parameters:

top - the top popup position in pixels

getPopupPositionTop

int getPopupPositionTop()

Returns:

top popup position if position is set via setPopupPosition(int, int)

setPopupPositionLeft

@StudioProperty(name="popupLeft",
                defaultValue="-1")
void setPopupPositionLeft(int left)

Sets the left popup position.

Parameters:

left - the left popup position in pixels

getPopupPositionLeft

int getPopupPositionLeft()

Returns:

left popup position if position is set via setPopupPosition(int, int)

setPopupPosition

@StudioProperty(type=ENUMERATION,
                defaultValue="DEFAULT",
                options={"DEFAULT","TOP_LEFT","TOP_CENTER","TOP_RIGHT","MIDDLE_LEFT","MIDDLE_CENTER","MIDDLE_RIGHT","BOTTOM_LEFT","BOTTOM_CENTER","BOTTOM_RIGHT"})
void setPopupPosition(@Nullable
                                                                                                                                                                                                                                                                   PopupView.PopupPosition position)

Sets the popup position.

Parameters:

position - the popup position

getPopupPosition

@Nullable
PopupView.PopupPosition getPopupPosition()

return PopupPosition or null if position is set via setPopupPosition(PopupPosition)

addPopupVisibilityListener

io.jmix.core.common.event.Subscription addPopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener)