Package io.jmix.ui.component.impl

Class PopupViewImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixPopupView>

io.jmix.ui.component.impl.PopupViewImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, PopupView

public class PopupViewImpl
extends AbstractComponent<JmixPopupView>
implements PopupView

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	PopupViewImpl.EmptyContent
protected class	PopupViewImpl.PopupContent

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

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

PopupView.PopupPosition, PopupView.PopupVisibilityEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected String	minimizedValue
protected Component	popupContent
protected com.vaadin.shared.Registration	popupVisibilityListenerRegistration

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

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

Constructor Summary

Constructors

Constructor	Description
PopupViewImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addPopupVisibilityListener(Consumer<PopupView.PopupVisibilityEvent> listener)
protected void	attachToFrame(Component childComponent)
protected JmixPopupView	createComponent()
protected void	detachFromFrame(Component childComponent)
String	getMinimizedValue()
Component	getPopupContent()
PopupView.PopupPosition	getPopupPosition()	return PopupPosition or null if position is set via PopupView.setPopupPosition(PopupPosition)
int	getPopupPositionLeft()
int	getPopupPositionTop()
protected void	internalRemovePopupVisibilityListener(Consumer<PopupView.PopupVisibilityEvent> listener)
boolean	isCaptionAsHtml()
boolean	isHideOnMouseOut()
boolean	isPopupVisible()
void	setCaption(String caption)	Sets the component's caption.
void	setCaptionAsHtml(boolean value)	Sets whether the caption is rendered as HTML.
void	setFrame(Frame frame)
void	setHideOnMouseOut(boolean value)	Sets possibility to close popup window on cursor out.
void	setIcon(String icon)	Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
protected void	setIconStyle()
void	setMinimizedValue(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 value)	Sets visibility for the popup window.
void	setStyleName(String name)	Sets one or more style names of the component, replacing any previous styles.

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

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIconFromSet, setId, setParent, setResponsive, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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.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, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

getFrame

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

getCaption

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

getDescription, setDescription

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

getIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

popupContent

protected Component popupContent

minimizedValue

protected String minimizedValue

popupVisibilityListenerRegistration

protected com.vaadin.shared.Registration popupVisibilityListenerRegistration

Constructor Details

PopupViewImpl

public PopupViewImpl()

Method Details

createComponent

protected JmixPopupView createComponent()

addPopupVisibilityListener

public Subscription addPopupVisibilityListener(Consumer<PopupView.PopupVisibilityEvent> listener)

Specified by:

addPopupVisibilityListener in interface PopupView

internalRemovePopupVisibilityListener

protected void internalRemovePopupVisibilityListener(Consumer<PopupView.PopupVisibilityEvent> listener)

setPopupContent

public void setPopupContent(@Nullable
 Component popupContent)

Description copied from interface: PopupView

Sets inner content for the popup window.

Specified by:

setPopupContent in interface PopupView

Parameters:

popupContent - popup component.

attachToFrame

protected void attachToFrame(Component childComponent)

detachFromFrame

protected void detachFromFrame(Component childComponent)

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<JmixPopupView>

getPopupContent

@Nullable
public Component getPopupContent()

Specified by:

getPopupContent in interface PopupView

Returns:

popup content component.

setPopupVisible

public void setPopupVisible(boolean value)

Description copied from interface: PopupView

Sets visibility for the popup window.

Specified by:

setPopupVisible in interface PopupView

Parameters:

value - popup visibility.

setHideOnMouseOut

public void setHideOnMouseOut(boolean value)

Description copied from interface: PopupView

Sets possibility to close popup window on cursor out.

Specified by:

setHideOnMouseOut in interface PopupView

Parameters:

value - popup hide option.

isHideOnMouseOut

public boolean isHideOnMouseOut()

Specified by:

isHideOnMouseOut in interface PopupView

Returns:

true if popup window closes on cursor out.

isPopupVisible

public boolean isPopupVisible()

Specified by:

isPopupVisible in interface PopupView

Returns:

true if popup is visible.

setMinimizedValue

public void setMinimizedValue(String minimizedValue)

Description copied from interface: PopupView

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

Specified by:

setMinimizedValue in interface PopupView

Parameters:

minimizedValue - label text.

getMinimizedValue

public String getMinimizedValue()

Specified by:

getMinimizedValue in interface PopupView

Returns:

value of the label of component.

setCaptionAsHtml

public void setCaptionAsHtml(boolean value)

Description copied from interface: HasHtmlCaption

Sets whether the caption is rendered as HTML.

Specified by:

setCaptionAsHtml in interface HasHtmlCaption

Specified by:

setCaptionAsHtml in interface PopupView

Overrides:

setCaptionAsHtml in class AbstractComponent<JmixPopupView>

Parameters:

value - true if the caption is rendered as HTML, false if rendered as plain text

See Also:

• Component.HasCaption.setCaption(String)

isCaptionAsHtml

public boolean isCaptionAsHtml()

Specified by:

isCaptionAsHtml in interface HasHtmlCaption

Specified by:

isCaptionAsHtml in interface PopupView

Overrides:

isCaptionAsHtml in class AbstractComponent<JmixPopupView>

Returns:

true if the caption is rendered as HTML, false if rendered as plain text

setPopupPosition

public void setPopupPosition(int top,
 int left)

Description copied from interface: PopupView

Sets the popup position.

Specified by:

setPopupPosition in interface PopupView

Parameters:

top - the top popup position in pixels

left - the left popup position in pixels

setPopupPositionTop

public void setPopupPositionTop(int top)

Description copied from interface: PopupView

Sets the top popup position.

Specified by:

setPopupPositionTop in interface PopupView

Parameters:

top - the top popup position in pixels

getPopupPositionTop

public int getPopupPositionTop()

Specified by:

getPopupPositionTop in interface PopupView

Returns:

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

setPopupPositionLeft

public void setPopupPositionLeft(int left)

Description copied from interface: PopupView

Sets the left popup position.

Specified by:

setPopupPositionLeft in interface PopupView

Parameters:

left - the left popup position in pixels

getPopupPositionLeft

public int getPopupPositionLeft()

Specified by:

getPopupPositionLeft in interface PopupView

Returns:

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

setPopupPosition

public void setPopupPosition(@Nullable
 PopupView.PopupPosition position)

Description copied from interface: PopupView

Sets the popup position.

Specified by:

setPopupPosition in interface PopupView

Parameters:

position - the popup position

getPopupPosition

@Nullable
public PopupView.PopupPosition getPopupPosition()

Description copied from interface: PopupView

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

Specified by:

getPopupPosition in interface PopupView

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Overrides:

setCaption in class AbstractComponent<JmixPopupView>

Parameters:

caption - the new component's caption

setIcon

public void setIcon(@Nullable
 String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

Overrides:

setIcon in class AbstractComponent<JmixPopupView>

setStyleName

public void setStyleName(@Nullable
 String name)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Overrides:

setStyleName in class AbstractComponent<JmixPopupView>

Parameters:

name - one or more style names separated by space.

setIconStyle

protected void setIconStyle()