com.vaadin.componentfactory

Class Popup

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<Popup.PopupModel>

com.vaadin.componentfactory.Popup

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

@Tag(value="vcf-popup")
 @NpmPackage(value="@vaadin-component-factory/vcf-popup",
            version="1.2.8")
 @JsModule(value="./flow-component-renderer.js") @JsModule(value="@vaadin-component-factory/vcf-popup/src/vcf-popup.js")
public class Popup
extends com.vaadin.flow.component.polymertemplate.PolymerTemplate<Popup.PopupModel>

Server-side component for the vcf-popup element.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Popup.PopupModel This model binds properties between java(Popup) and polymer(vcf-popup.html)
static class	Popup.PopupOpenChangedEvent

Constructor Summary

Constructors

Constructor and Description
Popup()

Method Summary

Modifier and Type	Method and Description
void	add(com.vaadin.flow.component.Component... components) Adds the given components into this dialog.
void	addComponentAtIndex(int index, com.vaadin.flow.component.Component component) Adds the given component into this dialog at the given index.
com.vaadin.flow.shared.Registration	addPopupOpenChangedEventListener(com.vaadin.flow.component.ComponentEventListener<Popup.PopupOpenChangedEvent> listener) Adds a listener for PopupOpenChangedEvent events fired by the webcomponent.
String	getFor() Gets the id of target component of this popup, or null if it doesn't have a target.
void	hide() Hiding popup, if it's open.
boolean	isCloseOnClick() gets closeOnClick parameter from popup
boolean	isModeless() Gets modeless value from popup.
boolean	isOpened() Gets the open state from the popup.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	remove(com.vaadin.flow.component.Component... components) Removes components from popup.
void	removeAll() Removes all components from popup
void	setCloseOnClick(boolean close) Sets parameter closeOnClick.
void	setFor(String id) Sets the target component for this popup.
void	setModeless(boolean modeless) Sets the popup to be modeless.
void	setOpened(boolean opened) Opens popup.
void	show() Showing popup, if not showed yet.

Methods inherited from class com.vaadin.flow.component.polymertemplate.PolymerTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModel, getModelType, getModelType, getStateNode, initModel, isSupportedClass

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

Popup

public Popup()

Method Detail

addPopupOpenChangedEventListener

public com.vaadin.flow.shared.Registration addPopupOpenChangedEventListener(com.vaadin.flow.component.ComponentEventListener<Popup.PopupOpenChangedEvent> listener)

Adds a listener for PopupOpenChangedEvent events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

show

public void show()

Showing popup, if not showed yet.

hide

public void hide()

Hiding popup, if it's open.

setOpened

public void setOpened(boolean opened)

Opens popup. If popup is not attached yet will open it after attaching *

Parameters:

opened - true to open the popup

isOpened

public boolean isOpened()

Gets the open state from the popup.

Returns:

the opened property from the popup

setFor

public void setFor(String id)

Sets the target component for this popup.

By default, the context menu can be opened with a left click or touch on the target component.

Parameters:

id - the if of component for this popup, can be null to remove the target

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

getFor

public String getFor()

Gets the id of target component of this popup, or null if it doesn't have a target.

Returns:

the id of target component of this popup

See Also:

setFor(String)

setCloseOnClick

public void setCloseOnClick(boolean close)

Sets parameter closeOnClick. Default if false. If set to true then popup will be closed when clicking on it and on clicking outside popup. If set to false then popup will be closed when clicking outside popup Should be set before binding to dom. setting after binding will make no effect

Parameters:

close - true to close the popup automatically

isCloseOnClick

public boolean isCloseOnClick()

gets closeOnClick parameter from popup

Returns:

closeOnClick parameter from popup

add

public void add(com.vaadin.flow.component.Component... components)

Adds the given components into this dialog.

The elements in the DOM will not be children of the <vcf-popup> element, but will be inserted into an overlay that is attached into the <body>.

Parameters:

components - the components to add

remove

public void remove(com.vaadin.flow.component.Component... components)

Removes components from popup. Components should be in popup, otherwise IllegalArgumentException will be raised

Parameters:

components - the components to remove

removeAll

public void removeAll()

Removes all components from popup

addComponentAtIndex

public void addComponentAtIndex(int index,
                                com.vaadin.flow.component.Component component)

Adds the given component into this dialog at the given index.

The element in the DOM will not be child of the <vcf-popup> element, but will be inserted into an overlay that is attached into the <body>.

Parameters:

index - the index, where the component will be added.

component - the component to add

isModeless

public boolean isModeless()

Gets modeless value from popup.

Returns:

true if popup is modeless, false otherwise

setModeless

public void setModeless(boolean modeless)

Sets the popup to be modeless.

Parameters:

modeless - true if popup should be modeless, false otherwise