Class PopupHelper
- java.lang.Object
-
- com.inductiveautomation.ignition.client.util.gui.popup.PopupHelper
-
public class PopupHelper extends java.lang.Object
This class uses a lower-level implementation of Popup than the similar JPopupMenuHelper class does. This can help when popups get nested.
-
-
Field Summary
Fields Modifier and Type Field Description static java.awt.Insets
DEFAULT_CLOSE_INSETS
-
Constructor Summary
Constructors Constructor Description PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents)
PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents, boolean addCloseButton)
PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents, boolean addCloseButton, java.awt.Insets closeInsets)
PopupHelper(javax.swing.JComponent invoker, javax.swing.JComponent popupContents)
PopupHelper(javax.swing.JComponent invoker, javax.swing.JComponent popupContents, boolean addCloseButton, java.awt.Insets closeInsets)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bind()
Adds mouse handling to the invoking component to show the popup.void
doTogglePopup(java.awt.event.MouseEvent e)
Toggles popup visibilityjava.lang.Runnable
getCloseListener()
PopupLocation
getLocation()
PopupTrigger
getTrigger()
void
hidePopup()
protected javax.swing.JComponent
initializeContentPanel(javax.swing.JComponent content)
boolean
isAcceptInputFocus()
boolean
isShowing()
void
setAcceptInputFocus(boolean acceptInputFocus)
void
setCloseListener(java.lang.Runnable closeListener)
Set a runnable to be called when the popup is closed.void
setInvoker(javax.swing.JComponent invoker)
Set the invoking component.void
setLocation(PopupLocation location)
void
setTrigger(PopupTrigger trigger)
Set when the popup is show (for use with bind())protected void
showPopup(java.awt.event.MouseEvent e)
void
unbind()
Removes the mouse handling added by bind()
-
-
-
Constructor Detail
-
PopupHelper
public PopupHelper(javax.swing.JComponent invoker, javax.swing.JComponent popupContents)
-
PopupHelper
public PopupHelper(javax.swing.JComponent invoker, javax.swing.JComponent popupContents, boolean addCloseButton, java.awt.Insets closeInsets)
-
PopupHelper
public PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents)
-
PopupHelper
public PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents, boolean addCloseButton)
-
PopupHelper
public PopupHelper(javax.swing.JComponent invoker, java.util.function.Supplier<javax.swing.JComponent> popupContents, boolean addCloseButton, java.awt.Insets closeInsets)
-
-
Method Detail
-
initializeContentPanel
protected javax.swing.JComponent initializeContentPanel(javax.swing.JComponent content)
-
setCloseListener
public void setCloseListener(java.lang.Runnable closeListener)
Set a runnable to be called when the popup is closed.
-
getCloseListener
public java.lang.Runnable getCloseListener()
-
setTrigger
public void setTrigger(PopupTrigger trigger)
Set when the popup is show (for use with bind())
-
getTrigger
public PopupTrigger getTrigger()
-
setLocation
public void setLocation(PopupLocation location)
-
getLocation
public PopupLocation getLocation()
-
isAcceptInputFocus
public boolean isAcceptInputFocus()
-
setAcceptInputFocus
public void setAcceptInputFocus(boolean acceptInputFocus)
-
setInvoker
public void setInvoker(javax.swing.JComponent invoker)
Set the invoking component. Shouldn't be re-set after the consructor if using the bind() method of controlling the popup. Can be used if doTogglePopup(MouseEvent) is being called directly.
-
bind
public void bind()
Adds mouse handling to the invoking component to show the popup. Popup is shown either when the PopupTrigger matches.
-
unbind
public void unbind()
Removes the mouse handling added by bind()
-
isShowing
public boolean isShowing()
-
doTogglePopup
public void doTogglePopup(java.awt.event.MouseEvent e)
Toggles popup visibility
-
hidePopup
public void hidePopup()
-
showPopup
protected void showPopup(java.awt.event.MouseEvent e)
-
-