com.haulmont.cuba.gui.components

Interface PopupView

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasIcon

public interface PopupView
extends Component.HasCaption, Component.BelongToFrame, Component.HasIcon

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PopupView.PopupVisibilityEvent This event is received by the PopupVisibilityListeners when the visibility of the popup changes.
static interface	PopupView.PopupVisibilityListener Popup window visibility change listener.

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addPopupVisibilityListener(PopupView.PopupVisibilityListener listener)
java.lang.String	getMinimizedValue()
Component	getPopupContent()
boolean	isCaptionAsHtml()
boolean	isHideOnMouseOut()
boolean	isPopupVisible()
void	removePopupVisibilityListener(PopupView.PopupVisibilityListener listener)
void	setCaptionAsHtml(boolean captionAsHtml) Set caption rendering as HTML.
void	setHideOnMouseOut(boolean hideOnMouseOut) Set possibility to close popup window on cursor out.
void	setMinimizedValue(java.lang.String minimizedValue) Set value for the label of component.
void	setPopupContent(Component popupContent) Set inner content for the popup window.
void	setPopupVisible(boolean popupVisible) Set visibility for the popup window.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setPopupVisible

void setPopupVisible(boolean popupVisible)

Set visibility for the popup window.

Parameters:

popupVisible - popup visibility.

isPopupVisible

boolean isPopupVisible()

Returns:

true if popup is visible.

setMinimizedValue

void setMinimizedValue(java.lang.String minimizedValue)

Set 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(Component popupContent)

Set inner content for the popup window.

Parameters:

popupContent - popup component.

getPopupContent

Component getPopupContent()

Returns:

popup content component.

setHideOnMouseOut

void setHideOnMouseOut(boolean hideOnMouseOut)

Set 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)

Set caption rendering as HTML.

Parameters:

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

isCaptionAsHtml

boolean isCaptionAsHtml()

Returns:

true if caption is shown as HTML.

addPopupVisibilityListener

void addPopupVisibilityListener(PopupView.PopupVisibilityListener listener)

removePopupVisibilityListener

void removePopupVisibilityListener(PopupView.PopupVisibilityListener listener)