com.alee.extended.window

Class PopOverPainter<C extends JRootPane,U extends WRootPaneUI>

java.lang.Object

com.alee.painter.AbstractPainter<C,U>

com.alee.laf.menu.AbstractPopupPainter<C,U>

com.alee.extended.window.PopOverPainter<C,U>

Type Parameters:

C - component type

U - component UI type

All Implemented Interfaces:

IPopOverPainter<C,U>, IRootPanePainter<C,U>, PainterShapeProvider<C>, Painter<C,U>, SpecificPainter<C,U>, SwingConstants

public class PopOverPainter<C extends JRootPane,U extends WRootPaneUI>
extends AbstractPopupPainter<C,U>
implements IPopOverPainter<C,U>

Basic painter for WebPopOver component.

Author:

Mikle Garin

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	attached Whether or not popover is attached to invoker component.
protected PopOverDirection	currentDirection Current display direction.
protected WindowFocusListener	focusListener
protected ComponentMoveBehavior	moveAdapter Listeners.
protected boolean	popOverFocused Whether or not popover is focused.
protected PopOverSourcePoint	popOverSourcePoint WebPopOver display source point.
protected PopOverAlignment	preferredAlignment Preferred WebPopOver alignment relative to display source point.
protected PopOverDirection	preferredDirection Preferred direction in which WebPopOver should be displayed.
protected ComponentAdapter	resizeAdapter
protected VisibilityBehavior<C>	windowVisibilityBehavior

Fields inherited from class com.alee.laf.menu.AbstractPopupPainter

background, borderColor, cornerAlignment, cornerSide, cornerWidth, DROPDOWN_BORDER_SHAPE, DROPDOWN_FILL_SHAPE, opacity, popupStyle, relativeCorner, round, shade, shadeOpacity, shadeWidth, shaped, SIMPLE_BORDER_SHAPE, SIMPLE_FILL_SHAPE

Fields inherited from class com.alee.painter.AbstractPainter

component, installed, ltr, propertyChangeListener, sectionPainters, ui

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
PopOverPainter()

Method Summary

Modifier and Type	Method and Description
protected Point	checkBottomCollision(Point location, Dimension ps, Rectangle screenBounds) Checks whether WebPopOver will collide with bottom screen border and modifies location accordingly.
protected Point	checkLeftCollision(Point location, Rectangle screenBounds) Checks whether WebPopOver will collide with left screen border and modifies location accordingly.
protected Point	checkRightCollision(Point location, Dimension ps, Rectangle screenBounds) Checks whether WebPopOver will collide with right screen border and modifies location accordingly.
protected Point	checkTopCollision(Point location, Rectangle screenBounds) Checks whether WebPopOver will collide with top screen border and modifies location accordingly.
void	configure(WebPopOver popOver, Component invoker, Supplier<Rectangle> boundsSupplier, PopOverDirection direction, PopOverAlignment alignment) Configures popover to be displayed as attached to the invoker component and faced to specified direction.
void	configure(WebPopOver popOver, int x, int y) Configures popover to be displayed as unattached at the specified location.
void	configure(WebPopOver popOver, PopOverLocation location) Configures popover to be displayed as unattached at the specified screen location.
protected PopOverDirection	getActualDirection(Rectangle ib, boolean ltr, int cw, Dimension ps, Rectangle screenBounds) Returns actual direction depending on preferred WebPopOver direction, its sizes and source point.
protected Point	getActualLocation(Rectangle ib, boolean ltr, int round, int cw, Dimension ps, Rectangle screenBounds, PopOverDirection actualDirection) Returns actual WebPopOver location.
protected Point	getActualSourcePoint(Rectangle ib, boolean ltr, PopOverDirection direction) Returns actual source point depending on WebPopOver direction and invoker component location on screen.
PopOverDirection	getCurrentDirection() Returns current display direction.
protected float	getCurrentShadeOpacity() Returns current shade opacity.
protected WebPopOver	getPopOver(C c) Returns popover instance for the specified root pane.
PopOverSourcePoint	getPopOverSourcePoint() Returns popup display source point.
PopOverDirection	getPreferredDirection() Returns preferred direction in which WebPopOver should be displayed.
protected int	getRelativeCorner(Rectangle ib, PopOverDirection actualDirection, Point actualLocation) Returns relative corner position.
protected void	installPopOverLocationUpdater(WebPopOver popOver, Component invoker, Supplier<Rectangle> boundsProvider) Installs listeners to update WebPopOver location.
protected void	installPropertiesAndListeners() Installs properties and listeners used by this Painter implementation.
boolean	isDecorated() Returns whether or not this IRootPanePainter implementation will provide window decoration.
boolean	isPopOverFocused() Returns whether this WebPopOver is focus owner or not.
void	setCurrentDirection(PopOverDirection direction) Sets current display direction.
void	setPopOverFocused(boolean focused) Sets whether this WebPopOver is focus owner or not.
void	setPopOverSourcePoint(PopOverSourcePoint popOverSourcePoint) Sets popup display source point.
void	setPreferredDirection(PopOverDirection direction) Sets preferred direction in which WebPopOver should be displayed.
protected void	uninstallPropertiesAndListeners() Uninstalls properties and listeners used by this Painter implementation.
protected void	updatePopOverLocation(WebPopOver popOver, Component invoker) Updates WebPopOver location on screen.
protected void	updatePopOverLocation(WebPopOver popOver, Component invoker, Rectangle invokerBounds) Updates WebPopOver location on screen.
protected void	updatePopOverLocation(WebPopOver popOver, Component invoker, Supplier<Rectangle> boundsProvider) Updates WebPopOver location on screen.

Methods inherited from class com.alee.laf.menu.AbstractPopupPainter

createDropdownCornerShape, createDropdownShape, createSimpleShape, getBackgroundColor, getBorder, getBorderColor, getBorderShape, getCachedShapeSettings, getComponentBackground, getCornerAlignment, getCornerSide, getCornerWidth, getDropdownCornerShape, getOpacity, getPopupStyle, getRelativeCorner, getRound, getShadeBounds, getShadeOpacity, getShadeWidth, getSideWidth, isOpaque, paint, paintBackground, paintBorder, paintShade, paintSimplePopup, paintTransparentPopup, provideShape, setBorderColor, setCornerAlignment, setCornerSide, setCornerWidth, setOpacity, setPopupStyle, setRelativeCorner, setRound, setShadeOpacity, setShadeWidth

Methods inherited from class com.alee.painter.AbstractPainter

afterInstall, afterUninstall, asList, beforeInstall, beforeUninstall, borderChange, contains, getBaseline, getBaselineResizeBehavior, getCompleteBorder, getInstalledSectionPainters, getPreferredSize, getSectionPainters, install, installPropertyChangeListener, installSectionPainter, installSectionPainters, isInstalled, isSectionPainter, isSettingsUpdateAllowed, orientationChange, paintSection, propertyChanged, repaint, repaint, repaint, revalidate, saveOrientation, uninstall, uninstallPropertyChangeListener, uninstallSectionPainter, uninstallSectionPainters, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.painter.Painter

contains, getBaseline, getBaselineResizeBehavior, getPreferredSize, install, isInstalled, isOpaque, paint, uninstall

Field Detail

moveAdapter

protected transient ComponentMoveBehavior moveAdapter

Listeners.

focusListener

protected transient WindowFocusListener focusListener

resizeAdapter

protected transient ComponentAdapter resizeAdapter

windowVisibilityBehavior

protected transient VisibilityBehavior<C extends JRootPane> windowVisibilityBehavior

popOverFocused

protected boolean popOverFocused

Whether or not popover is focused.

attached

protected boolean attached

Whether or not popover is attached to invoker component.

popOverSourcePoint

protected PopOverSourcePoint popOverSourcePoint

WebPopOver display source point.

preferredDirection

protected PopOverDirection preferredDirection

Preferred direction in which WebPopOver should be displayed.

currentDirection

protected PopOverDirection currentDirection

Current display direction.

preferredAlignment

protected PopOverAlignment preferredAlignment

Preferred WebPopOver alignment relative to display source point.

Constructor Detail

PopOverPainter

public PopOverPainter()

Method Detail

installPropertiesAndListeners

protected void installPropertiesAndListeners()

Description copied from class: AbstractPainter

Installs properties and listeners used by this Painter implementation. Override this method instead of AbstractPainter.install(JComponent, ComponentUI) to install additional properties and listeners.

Overrides:

installPropertiesAndListeners in class AbstractPopupPainter<C extends JRootPane,U extends WRootPaneUI>

uninstallPropertiesAndListeners

protected void uninstallPropertiesAndListeners()

Description copied from class: AbstractPainter

Uninstalls properties and listeners used by this Painter implementation. Override this method instead of AbstractPainter.uninstall(JComponent, ComponentUI) to uninstall additional properties and listeners.

Overrides:

uninstallPropertiesAndListeners in class AbstractPopupPainter<C extends JRootPane,U extends WRootPaneUI>

isDecorated

public boolean isDecorated()

Description copied from interface: IRootPanePainter

Returns whether or not this IRootPanePainter implementation will provide window decoration. todo This method might not be necessary outside of implementation anymore

Specified by:

isDecorated in interface IRootPanePainter<C extends JRootPane,U extends WRootPaneUI>

Returns:

true if this IRootPanePainter implementation will provide window decoration, false otherwise

isPopOverFocused

public boolean isPopOverFocused()

Returns whether this WebPopOver is focus owner or not.

Returns:

true if this WebPopOver is focus owner, false otherwise

setPopOverFocused

public void setPopOverFocused(boolean focused)

Sets whether this WebPopOver is focus owner or not.

Parameters:

focused - whether this WebPopOver is focus owner or not

getCurrentShadeOpacity

protected float getCurrentShadeOpacity()

Description copied from class: AbstractPopupPainter

Returns current shade opacity. This part moved to a separate method to make it simple to override without touching the actual opacity value.

Overrides:

getCurrentShadeOpacity in class AbstractPopupPainter<C extends JRootPane,U extends WRootPaneUI>

Returns:

current shade opacity

getPopOverSourcePoint

public PopOverSourcePoint getPopOverSourcePoint()

Returns popup display source point.

Returns:

popup display source point

setPopOverSourcePoint

public void setPopOverSourcePoint(PopOverSourcePoint popOverSourcePoint)

Sets popup display source point.

Parameters:

popOverSourcePoint - popup display source point

getPreferredDirection

public PopOverDirection getPreferredDirection()

Returns preferred direction in which WebPopOver should be displayed.

Returns:

preferred direction in which WebPopOver should be displayed

setPreferredDirection

public void setPreferredDirection(PopOverDirection direction)

Sets preferred direction in which WebPopOver should be displayed.

Parameters:

direction - preferred direction in which WebPopOver should be displayed

getCurrentDirection

public PopOverDirection getCurrentDirection()

Returns current display direction.

Returns:

current display direction

setCurrentDirection

public void setCurrentDirection(PopOverDirection direction)

Sets current display direction.

Parameters:

direction - current display direction

configure

public void configure(WebPopOver popOver,
                      PopOverLocation location)

Description copied from interface: IPopOverPainter

Configures popover to be displayed as unattached at the specified screen location.

Specified by:

configure in interface IPopOverPainter<C extends JRootPane,U extends WRootPaneUI>

Parameters:

popOver - popover to configure

location - location on screen

configure

public void configure(WebPopOver popOver,
                      int x,
                      int y)

Description copied from interface: IPopOverPainter

Configures popover to be displayed as unattached at the specified location.

Specified by:

configure in interface IPopOverPainter<C extends JRootPane,U extends WRootPaneUI>

Parameters:

popOver - popover to configure

x - X location

y - Y location

configure

public void configure(WebPopOver popOver,
                      Component invoker,
                      Supplier<Rectangle> boundsSupplier,
                      PopOverDirection direction,
                      PopOverAlignment alignment)

Description copied from interface: IPopOverPainter

Configures popover to be displayed as attached to the invoker component and faced to specified direction. Popover will also be using the specified alignment type when it possible according to its position on the screen. Popover opened in this way will always auto-follow invoker's ancestor window on the screen when it is moved.

Specified by:

configure in interface IPopOverPainter<C extends JRootPane,U extends WRootPaneUI>

Parameters:

popOver - popover to configure

invoker - invoker component

boundsSupplier - source area provider

direction - preferred display direction

alignment - preferred display alignment

updatePopOverLocation

protected void updatePopOverLocation(WebPopOver popOver,
                                     Component invoker,
                                     Supplier<Rectangle> boundsProvider)

Updates WebPopOver location on screen.

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

boundsProvider - source area bounds provider

updatePopOverLocation

protected void updatePopOverLocation(WebPopOver popOver,
                                     Component invoker)

Updates WebPopOver location on screen.

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

updatePopOverLocation

protected void updatePopOverLocation(WebPopOver popOver,
                                     Component invoker,
                                     Rectangle invokerBounds)

Updates WebPopOver location on screen.

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

invokerBounds - invoker component bounds on screen

installPopOverLocationUpdater

protected void installPopOverLocationUpdater(WebPopOver popOver,
                                             Component invoker,
                                             Supplier<Rectangle> boundsProvider)

Installs listeners to update WebPopOver location.

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

boundsProvider - source area bounds provider

getRelativeCorner

protected int getRelativeCorner(Rectangle ib,
                                PopOverDirection actualDirection,
                                Point actualLocation)

Returns relative corner position.

Parameters:

ib - invoker component bounds on screen

actualDirection - actual WebPopOver direction

actualLocation - actual WebPopOver location

Returns:

relative corner position

getActualLocation

protected Point getActualLocation(Rectangle ib,
                                  boolean ltr,
                                  int round,
                                  int cw,
                                  Dimension ps,
                                  Rectangle screenBounds,
                                  PopOverDirection actualDirection)

Returns actual WebPopOver location. Shade width is not yet taken into account within this location.

Parameters:

ib - invoker component bounds on screen

ltr - whether LTR orientation is active or not

round - corners round

cw - corner width

ps - WebPopOver size without shadow widths

screenBounds - screen bounds

actualDirection - actual WebPopOver direction

Returns:

actual WebPopOver location

checkTopCollision

protected Point checkTopCollision(Point location,
                                  Rectangle screenBounds)

Checks whether WebPopOver will collide with top screen border and modifies location accordingly.

Parameters:

location - approximate WebPopOver location

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

checkBottomCollision

protected Point checkBottomCollision(Point location,
                                     Dimension ps,
                                     Rectangle screenBounds)

Checks whether WebPopOver will collide with bottom screen border and modifies location accordingly.

Parameters:

location - approximate WebPopOver location

ps - WebPopOver size without shadow widths

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

checkLeftCollision

protected Point checkLeftCollision(Point location,
                                   Rectangle screenBounds)

Checks whether WebPopOver will collide with left screen border and modifies location accordingly.

Parameters:

location - approximate WebPopOver location

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

checkRightCollision

protected Point checkRightCollision(Point location,
                                    Dimension ps,
                                    Rectangle screenBounds)

Checks whether WebPopOver will collide with right screen border and modifies location accordingly.

Parameters:

location - approximate WebPopOver location

ps - WebPopOver size without shadow widths

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

getActualDirection

protected PopOverDirection getActualDirection(Rectangle ib,
                                              boolean ltr,
                                              int cw,
                                              Dimension ps,
                                              Rectangle screenBounds)

Returns actual direction depending on preferred WebPopOver direction, its sizes and source point.

Parameters:

ib - invoker component bounds on screen

ltr - whether LTR orientation is active or not

cw - corner with

ps - WebPopOver size without shadow widths

screenBounds - screen bounds

Returns:

actual WebPopOver direction

getActualSourcePoint

protected Point getActualSourcePoint(Rectangle ib,
                                     boolean ltr,
                                     PopOverDirection direction)

Returns actual source point depending on WebPopOver direction and invoker component location on screen.

Parameters:

ib - invoker component bounds on screen

ltr - whether LTR orientation is active or not

direction - WebPopOver direction @return actual source point

Returns:

actual source point depending on WebPopOver direction and invoker component location on screen

getPopOver

protected final WebPopOver getPopOver(C c)

Returns popover instance for the specified root pane.

Parameters:

c - root pane

Returns:

popover instance for the specified root pane