com.alee.laf.menu

Class AbstractPopupPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

java.lang.Object

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

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

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

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

Direct Known Subclasses:

PopOverPainter, PopupMenuPainter

public abstract class AbstractPopupPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
extends AbstractPainter<E,U>
implements PainterShapeProvider<E>, javax.swing.SwingConstants

Base painter for any type of popup components. It is generally used for WebPopupMenuUI default styling but might also be used in other cases.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	borderColor
protected int	cornerAlignment
protected int	cornerSide
protected int	cornerWidth
protected static java.lang.String	DROPDOWN_BORDER_SHAPE
protected static java.lang.String	DROPDOWN_FILL_SHAPE
protected float	opacity
protected PopupStyle	popupStyle Style settings.
protected int	relativeCorner
protected int	round
protected NinePatchIcon	shade
protected float	shadeOpacity
protected int	shadeWidth
protected boolean	shaped Runtime variables.
protected static java.lang.String	SIMPLE_BORDER_SHAPE
protected static java.lang.String	SIMPLE_FILL_SHAPE Shape cache keys.

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
AbstractPopupPainter()

Method Summary

Modifier and Type	Method and Description
protected java.awt.geom.GeneralPath	createDropdownCornerShape(E popupMenu, java.awt.Dimension menuSize, boolean fill) Creates and returns dropdown style corner shape.
protected java.awt.geom.GeneralPath	createDropdownShape(E popup, java.awt.Dimension popupSize, boolean fill) Creates and returns dropdown style shape.
protected java.awt.geom.GeneralPath	createSimpleShape(E popup, java.awt.Dimension popupSize, boolean fill) Creates and returns simple popup shape.
protected java.awt.Color	getBackgroundColor(E popup) Returns popup background color.
java.awt.Color	getBorderColor() Returns popup border color.
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
protected java.awt.Shape	getBorderShape(E popup, java.awt.Dimension popupSize, boolean fill) Returns popup border shape.
protected java.lang.Object[]	getCachedShapeSettings(E popup, java.awt.Dimension popupSize) Returns an array of shape settings cached along with the shape.
protected java.awt.Color	getComponentBackground(E popup) Returns popup background color.
int	getCornerAlignment() Returns dropdown corner alignment.
int	getCornerSide() Returns dropdown style corner side.
int	getCornerWidth() Returns popup dropdown style corner width.
protected float	getCurrentShadeOpacity() Returns current shade opacity.
protected java.awt.Shape	getDropdownCornerShape(E popupMenu, java.awt.Dimension menuSize, boolean fill) Returns dropdown style corner shape.
float	getOpacity() Returns popup background opacity.
PopupStyle	getPopupStyle() Returns popup style.
int	getRelativeCorner() Returns relative dropdown corner position.
int	getRound() Returns popup border corners rounding.
protected java.awt.Rectangle	getShadeBounds(java.awt.Dimension popupSize) Returns popup shade bounds.
float	getShadeOpacity() Returns popup shade opacity.
int	getShadeWidth() Returns popup shade width.
protected int	getSideWidth() Returns popup side space width.
void	install(E c, U ui) Called when painter is installed onto some component.
java.lang.Boolean	isOpaque() Returns whether visual data provided by this painter is opaque or not.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E popup, U ui) Paints visual data using component graphics context.
protected void	paintBackground(java.awt.Graphics2D g2d, E popup, java.awt.Dimension popupSize) Paints popup background fill.
protected void	paintBorder(java.awt.Graphics2D g2d, E popup, java.awt.Dimension popupSize) Paints popup border.
protected void	paintShade(java.awt.Graphics2D g2d, E popup, java.awt.Dimension popupSize) Paints popup shade.
protected void	paintSimplePopup(java.awt.Graphics2D g2d, E popup) Paints simple popup version.
protected void	paintTransparentPopup(java.awt.Graphics2D g2d, E popup) Paints transparent popup version.
java.awt.Shape	provideShape(E component, java.awt.Rectangle bounds) Returns painted component shape.
void	setBorderColor(java.awt.Color color) Sets popup border color.
void	setCornerAlignment(int cornerAlignment) Sets dropdown corner alignment.
void	setCornerSide(int cornerSide) Sets dropdown style corner side.
void	setCornerWidth(int width) Sets popup dropdown style corner width.
void	setOpacity(float opacity) Sets popup background opacity.
void	setPopupStyle(PopupStyle style) Sets popup style.
void	setRelativeCorner(int relativeCorner) Sets relative dropdown corner position.
void	setRound(int round) Sets popup border corners rounding.
void	setShadeOpacity(float opacity) Sets popup shade opacity.
void	setShadeWidth(int width) Sets popup shade width.

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, uninstall, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_FILL_SHAPE

protected static final java.lang.String SIMPLE_FILL_SHAPE

Shape cache keys.

See Also:

Constant Field Values

SIMPLE_BORDER_SHAPE

protected static final java.lang.String SIMPLE_BORDER_SHAPE

See Also:

Constant Field Values

DROPDOWN_FILL_SHAPE

protected static final java.lang.String DROPDOWN_FILL_SHAPE

See Also:

Constant Field Values

DROPDOWN_BORDER_SHAPE

protected static final java.lang.String DROPDOWN_BORDER_SHAPE

See Also:

Constant Field Values

popupStyle

protected PopupStyle popupStyle

Style settings.

borderColor

protected java.awt.Color borderColor

round

protected int round

shadeWidth

protected int shadeWidth

shadeOpacity

protected float shadeOpacity

cornerWidth

protected int cornerWidth

opacity

protected float opacity

shaped

protected boolean shaped

Runtime variables.

cornerSide

protected int cornerSide

relativeCorner

protected int relativeCorner

cornerAlignment

protected int cornerAlignment

shade

protected NinePatchIcon shade

Constructor Detail

AbstractPopupPainter

public AbstractPopupPainter()

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.JComponent,U extends javax.swing.plaf.ComponentUI>

Overrides:

install in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

c - component this painter is being installed onto

ui - component UI

getPopupStyle

public PopupStyle getPopupStyle()

Returns popup style.

Returns:

popup style

setPopupStyle

public void setPopupStyle(PopupStyle style)

Sets popup style.

Parameters:

style - new popup style

getBorderColor

public java.awt.Color getBorderColor()

Returns popup border color.

Returns:

popup border color

setBorderColor

public void setBorderColor(java.awt.Color color)

Sets popup border color.

Parameters:

color - new popup border color

getRound

public int getRound()

Returns popup border corners rounding.

Returns:

popup border corners rounding

setRound

public void setRound(int round)

Sets popup border corners rounding.

Parameters:

round - new popup border corners rounding

getShadeWidth

public int getShadeWidth()

Returns popup shade width.

Returns:

popup shade width

setShadeWidth

public void setShadeWidth(int width)

Sets popup shade width.

Parameters:

width - new popup shade width

getShadeOpacity

public float getShadeOpacity()

Returns popup shade opacity.

Returns:

popup shade opacity

setShadeOpacity

public void setShadeOpacity(float opacity)

Sets popup shade opacity.

Parameters:

opacity - new popup shade opacity

getCornerWidth

public int getCornerWidth()

Returns popup dropdown style corner width.

Returns:

popup dropdown style corner width

setCornerWidth

public void setCornerWidth(int width)

Sets popup dropdown style corner width.

Parameters:

width - popup dropdown style corner width

getOpacity

public float getOpacity()

Returns popup background opacity.

Returns:

popup background opacity

setOpacity

public void setOpacity(float opacity)

Sets popup background opacity.

Parameters:

opacity - popup background opacity

getCornerSide

public int getCornerSide()

Returns dropdown style corner side.

Returns:

dropdown style corner side

setCornerSide

public void setCornerSide(int cornerSide)

Sets dropdown style corner side.

Parameters:

cornerSide - dropdown style corner side

getRelativeCorner

public int getRelativeCorner()

Returns relative dropdown corner position.

Returns:

relative dropdown corner position

setRelativeCorner

public void setRelativeCorner(int relativeCorner)

Sets relative dropdown corner position.

Parameters:

relativeCorner - relative dropdown corner position

getCornerAlignment

public int getCornerAlignment()

Returns dropdown corner alignment.

Returns:

dropdown corner alignment

setCornerAlignment

public void setCornerAlignment(int cornerAlignment)

Sets dropdown corner alignment.

Parameters:

cornerAlignment - dropdown corner alignment

provideShape

public java.awt.Shape provideShape(E component,
                                   java.awt.Rectangle bounds)

Description copied from interface: PainterShapeProvider

Returns painted component shape.

Specified by:

provideShape in interface PainterShapeProvider<E extends javax.swing.JComponent>

Parameters:

component - component to process

bounds - bounds for painter visual data

Returns:

painted component shape

isOpaque

public java.lang.Boolean isOpaque()

Description copied from interface: Painter

Returns whether visual data provided by this painter is opaque or not. Returned value might affect component opacity depending on painter support inside that component UI. Simply return null if you don't want to change default component opacity.

Specified by:

isOpaque in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Overrides:

isOpaque in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Returns:

true if visual data provided by this painter is opaque, false otherwise

getBorders

public java.awt.Insets getBorders()

Description copied from interface: Painter

Returns borders required for visual data provided by this painter. These borders should not include possible component margin and padding, only borders provided by painter. These borders are added to component's margin and padding when the final component border is calculated. These borders should not take component orientation into account, painter will take care of it later.

You may pass null in case additional borders aren't needed for this painter.

Specified by:

getBorders in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Overrides:

getBorders in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Returns:

borders required for visual data provided by this painter or null in case those aren't needed

paint

public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E popup,
                  U ui)

Description copied from interface: Painter

Paints visual data using component graphics context. Provided graphics context and component are taken directly from component UI paint method.

It is highly recommended to honor provided painting bounds to avoid painting issues. These bounds might be representing full component size or contain just a small portion of the component.

Specified by:

paint in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

Parameters:

g2d - graphics context

bounds - painting bounds

popup - painted component

ui - painted component UI

paintTransparentPopup

protected void paintTransparentPopup(java.awt.Graphics2D g2d,
                                     E popup)

Paints transparent popup version. This one is used when popup component can be transparent, otherwise a simple popup version is painted.

Parameters:

g2d - graphics context

popup - popup component

paintSimplePopup

protected void paintSimplePopup(java.awt.Graphics2D g2d,
                                E popup)

Paints simple popup version. This one is used when popup component is opaque.

Parameters:

g2d - graphics context

popup - popup component

paintShade

protected void paintShade(java.awt.Graphics2D g2d,
                          E popup,
                          java.awt.Dimension popupSize)

Paints popup shade.

Parameters:

g2d - graphics context

popup - popup component

popupSize - popup size

getCurrentShadeOpacity

protected float getCurrentShadeOpacity()

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

Returns:

current shade opacity

paintBackground

protected void paintBackground(java.awt.Graphics2D g2d,
                               E popup,
                               java.awt.Dimension popupSize)

Paints popup background fill.

Parameters:

g2d - graphics context

popup - popup component

popupSize - popup size

paintBorder

protected void paintBorder(java.awt.Graphics2D g2d,
                           E popup,
                           java.awt.Dimension popupSize)

Paints popup border.

Parameters:

g2d - graphics context

popup - popup component

popupSize - popup size

getBackgroundColor

protected java.awt.Color getBackgroundColor(E popup)

Returns popup background color.

Parameters:

popup - popup component

Returns:

popup background color

getComponentBackground

protected java.awt.Color getComponentBackground(E popup)

Returns popup background color. This call moved into a separate method so you can override it to provide different background color.

Parameters:

popup - popup component

Returns:

popup background color

getShadeBounds

protected java.awt.Rectangle getShadeBounds(java.awt.Dimension popupSize)

Returns popup shade bounds.

Parameters:

popupSize - popup size

Returns:

popup shade bounds

getBorderShape

protected java.awt.Shape getBorderShape(E popup,
                                        java.awt.Dimension popupSize,
                                        boolean fill)

Returns popup border shape.

Parameters:

popup - popup component

popupSize - popup size

fill - whether it is a fill shape or not

Returns:

popup border shape

getCachedShapeSettings

protected java.lang.Object[] getCachedShapeSettings(E popup,
                                                    java.awt.Dimension popupSize)

Returns an array of shape settings cached along with the shape.

Parameters:

popup - popup component

popupSize - popup size

Returns:

an array of shape settings cached along with the shape

createSimpleShape

protected java.awt.geom.GeneralPath createSimpleShape(E popup,
                                                      java.awt.Dimension popupSize,
                                                      boolean fill)

Creates and returns simple popup shape.

Parameters:

popup - popup component

popupSize - popup size

fill - whether it is a fill shape or not

Returns:

simple popup shape

createDropdownShape

protected java.awt.geom.GeneralPath createDropdownShape(E popup,
                                                        java.awt.Dimension popupSize,
                                                        boolean fill)

Creates and returns dropdown style shape.

Parameters:

popup - popup component

popupSize - popup size

fill - whether it is a fill shape or not

Returns:

dropdown style shape

getDropdownCornerShape

protected java.awt.Shape getDropdownCornerShape(E popupMenu,
                                                java.awt.Dimension menuSize,
                                                boolean fill)

Returns dropdown style corner shape. It is used to paint corner fill when menu item at the same as corner side of popup menu is selected.

Parameters:

popupMenu - popup menu

menuSize - menu size

fill - whether it is a fill shape or not

Returns:

dropdown style corner shape

createDropdownCornerShape

protected java.awt.geom.GeneralPath createDropdownCornerShape(E popupMenu,
                                                              java.awt.Dimension menuSize,
                                                              boolean fill)

Creates and returns dropdown style corner shape. It is used to paint corner fill when menu item at the same as corner side of popup menu is selected.

Parameters:

popupMenu - popup menu

menuSize - menu size

fill - whether it is a fill shape or not

Returns:

dropdown style corner shape

getSideWidth

protected int getSideWidth()

Returns popup side space width. This is the space taken by popup shade and corner.

Returns:

popup side space width