com.alee.extended.window

Class PopOverPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

java.lang.Object

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

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

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

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

IPopOverPainter<E,U>, IPopupPainter<E,U>, IRootPanePainter<E,U>, PainterShapeProvider<E>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods, javax.swing.SwingConstants

public class PopOverPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>
extends AbstractPopupPainter<E,U>
implements IPopOverPainter<E,U>

Basic painter for WebPopOver component. It is used as default WebPopOver painter.

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 java.awt.event.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 java.awt.event.ComponentAdapter	resizeAdapter

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

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, listeners, ltr, propertyChangeListener, 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 java.awt.Point	checkBottomCollision(java.awt.Point location, java.awt.Dimension ps, java.awt.Rectangle screenBounds) Checks whether WebPopOver will collide with bottom screen border and modifies location accordingly.
protected java.awt.Point	checkLeftCollision(java.awt.Point location, java.awt.Rectangle screenBounds) Checks whether WebPopOver will collide with left screen border and modifies location accordingly.
protected java.awt.Point	checkRightCollision(java.awt.Point location, java.awt.Dimension ps, java.awt.Rectangle screenBounds) Checks whether WebPopOver will collide with right screen border and modifies location accordingly.
protected java.awt.Point	checkTopCollision(java.awt.Point location, java.awt.Rectangle screenBounds) Checks whether WebPopOver will collide with top screen border and modifies location accordingly.
void	configure(WebPopOver popOver, java.awt.Component invoker, com.alee.utils.swing.DataProvider<java.awt.Rectangle> boundsProvider, PopOverDirection direction, PopOverAlignment alignment) Displays WebPopOver attached to the invoker component area and faced to specified direction.
void	configure(WebPopOver popOver, int x, int y) Displays unattached WebPopOver at the specified location.
void	configure(WebPopOver popOver, PopOverLocation location) Displays unattached WebPopOver at the specified screen location.
protected PopOverDirection	getActualDirection(java.awt.Rectangle ib, boolean ltr, int cw, java.awt.Dimension ps, java.awt.Rectangle screenBounds) Returns actual direction depending on preferred WebPopOver direction, its sizes and source point.
protected java.awt.Point	getActualLocation(java.awt.Rectangle ib, boolean ltr, int round, int cw, java.awt.Dimension ps, java.awt.Rectangle screenBounds, PopOverDirection actualDirection) Returns actual WebPopOver location.
protected java.awt.Point	getActualSourcePoint(java.awt.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(E 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(java.awt.Rectangle ib, PopOverDirection actualDirection, java.awt.Point actualLocation) Returns relative corner position.
void	install(E c, U ui) Called when painter is installed onto some component.
protected void	installPopOverLocationUpdater(WebPopOver popOver, java.awt.Component invoker, com.alee.utils.swing.DataProvider<java.awt.Rectangle> boundsProvider) Installs listeners to update WebPopOver location.
boolean	isDecorated() Returns whether or not this painter will provide appropriate 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.
void	uninstall(E c, U ui) Called when painter is installed into some component.
protected void	updatePopOverLocation(WebPopOver popOver, java.awt.Component invoker) Updates WebPopOver location on screen.
protected void	updatePopOverLocation(WebPopOver popOver, java.awt.Component invoker, com.alee.utils.swing.DataProvider<java.awt.Rectangle> boundsProvider) Updates WebPopOver location on screen.
protected void	updatePopOverLocation(WebPopOver popOver, java.awt.Component invoker, java.awt.Rectangle invokerBounds) Updates WebPopOver location on screen.

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

createDropdownCornerShape, createDropdownShape, createSimpleShape, getBackgroundColor, getBorderColor, getBorders, 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

addPainterListener, b, borderChange, getCompleteBorder, getPreferredSize, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, propertyChange, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, 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

addPainterListener, getBorders, getPreferredSize, isOpaque, paint, removePainterListener

Field Detail

moveAdapter

protected ComponentMoveBehavior moveAdapter

Listeners.

focusListener

protected java.awt.event.WindowFocusListener focusListener

resizeAdapter

protected java.awt.event.ComponentAdapter resizeAdapter

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

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Overrides:

install in class AbstractPopupPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Overrides:

uninstall in class AbstractPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

isDecorated

public boolean isDecorated()

Description copied from interface: IRootPanePainter

Returns whether or not this painter will provide appropriate window decoration.

Specified by:

isDecorated in interface IRootPanePainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Returns:

true if this painter will provide appropriate 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<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

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)

Displays unattached WebPopOver at the specified screen location.

Specified by:

configure in interface IPopOverPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Parameters:

popOver - WebPopOver to configure

location - WebPopOver location on screen

configure

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

Displays unattached WebPopOver at the specified location.

Specified by:

configure in interface IPopOverPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Parameters:

popOver - WebPopOver to configure

x - WebPopOver X location

y - WebPopOver Y location

configure

public void configure(WebPopOver popOver,
                      java.awt.Component invoker,
                      com.alee.utils.swing.DataProvider<java.awt.Rectangle> boundsProvider,
                      PopOverDirection direction,
                      PopOverAlignment alignment)

Displays WebPopOver attached to the invoker component area and faced to specified direction. It will also be aligned using the specified alignment type when possible. WebPopOver opened in this way will always auto-follow invoker's ancestor window.

Specified by:

configure in interface IPopOverPainter<E extends javax.swing.JRootPane,U extends WebRootPaneUI>

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

boundsProvider - source area bounds provider

direction - preferred display direction

alignment - preferred display alignment

updatePopOverLocation

protected void updatePopOverLocation(WebPopOver popOver,
                                     java.awt.Component invoker,
                                     com.alee.utils.swing.DataProvider<java.awt.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,
                                     java.awt.Component invoker)

Updates WebPopOver location on screen.

Parameters:

popOver - WebPopOver to configure

invoker - invoker component

updatePopOverLocation

protected void updatePopOverLocation(WebPopOver popOver,
                                     java.awt.Component invoker,
                                     java.awt.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,
                                             java.awt.Component invoker,
                                             com.alee.utils.swing.DataProvider<java.awt.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(java.awt.Rectangle ib,
                                PopOverDirection actualDirection,
                                java.awt.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 java.awt.Point getActualLocation(java.awt.Rectangle ib,
                                           boolean ltr,
                                           int round,
                                           int cw,
                                           java.awt.Dimension ps,
                                           java.awt.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 shade widths

screenBounds - screen bounds

actualDirection - actual WebPopOver direction

Returns:

actual WebPopOver location

checkTopCollision

protected java.awt.Point checkTopCollision(java.awt.Point location,
                                           java.awt.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 java.awt.Point checkBottomCollision(java.awt.Point location,
                                              java.awt.Dimension ps,
                                              java.awt.Rectangle screenBounds)

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

Parameters:

location - approximate WebPopOver location

ps - WebPopOver size without shade widths

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

checkLeftCollision

protected java.awt.Point checkLeftCollision(java.awt.Point location,
                                            java.awt.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 java.awt.Point checkRightCollision(java.awt.Point location,
                                             java.awt.Dimension ps,
                                             java.awt.Rectangle screenBounds)

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

Parameters:

location - approximate WebPopOver location

ps - WebPopOver size without shade widths

screenBounds - screen bounds

Returns:

either modified or unmodified WebPopOver location

getActualDirection

protected PopOverDirection getActualDirection(java.awt.Rectangle ib,
                                              boolean ltr,
                                              int cw,
                                              java.awt.Dimension ps,
                                              java.awt.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 shade widths

screenBounds - screen bounds

Returns:

actual WebPopOver direction

getActualSourcePoint

protected java.awt.Point getActualSourcePoint(java.awt.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(E c)

Returns popover instance for the specified root pane.

Parameters:

c - root pane

Returns:

popover instance for the specified root pane