public interface PopupView extends Component.HasCaption, Component.BelongToFrame, Component.HasIcon, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer
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.
|
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
Subscription |
addPopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener) |
java.lang.String |
getMinimizedValue() |
Component |
getPopupContent() |
PopupView.PopupPosition |
getPopupPosition()
|
int |
getPopupPositionLeft() |
int |
getPopupPositionTop() |
boolean |
isCaptionAsHtml() |
boolean |
isHideOnMouseOut() |
boolean |
isPopupVisible() |
void |
removePopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener)
Deprecated.
Use
Subscription instead |
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 |
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)
Set visibility for the popup window.
|
getFrame, setFrame
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
static final java.lang.String NAME
void setPopupVisible(boolean popupVisible)
popupVisible
- popup visibility.boolean isPopupVisible()
void setMinimizedValue(java.lang.String minimizedValue)
minimizedValue
- label text.java.lang.String getMinimizedValue()
void setPopupContent(Component popupContent)
popupContent
- popup component.Component getPopupContent()
void setHideOnMouseOut(boolean hideOnMouseOut)
hideOnMouseOut
- popup hide option.boolean isHideOnMouseOut()
void setCaptionAsHtml(boolean captionAsHtml)
setCaptionAsHtml
in interface HasHtmlCaption
captionAsHtml
- true if we want to show caption as HTML.Component.HasCaption.setCaption(String)
boolean isCaptionAsHtml()
isCaptionAsHtml
in interface HasHtmlCaption
void setPopupPosition(int top, int left)
top
- the top popup position in pixelsleft
- the left popup position in pixelsvoid setPopupPositionTop(int top)
top
- the top popup position in pixelsint getPopupPositionTop()
setPopupPosition(int, int)
void setPopupPositionLeft(int left)
left
- the left popup position in pixelsint getPopupPositionLeft()
setPopupPosition(int, int)
void setPopupPosition(PopupView.PopupPosition position)
position
- the popup positionPopupView.PopupPosition getPopupPosition()
Subscription addPopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener)
@Deprecated void removePopupVisibilityListener(java.util.function.Consumer<PopupView.PopupVisibilityEvent> listener)
Subscription
insteadlistener
- a listener to remove