com.alee.laf.menu

Class PopupMenuPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class PopupMenuPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>
extends AbstractPopupPainter<E,U>
implements IPopupMenuPainter<E,U>

Base painter for JPopupMenu component. It is used as WebPopupMenuUI default styling.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dropdownStyleForMenuBar
protected boolean	fixLocation
protected int	menuSpacing Style settings.
protected PopupMenuType	popupMenuType Runtime variables.

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

Method Summary

Modifier and Type	Method and Description
void	configurePopup(E popupMenu, java.awt.Component invoker, int x, int y, javax.swing.Popup popup) Configures created popup to be displayed.
protected WebComboBoxUI	geComboBoxUI(E popupMenu) Returns combobox UI for the specified combobox popup menu.
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
int	getMenuSpacing() Returns spacing between popup menus.
protected void	installPopupSettings(java.awt.Window window, E popupMenu) Configures popup menu window opacity and shape.
boolean	isFixLocation() Returns whether should fix initial popup menu location or not.
protected void	orientationChange() Performs various updates on orientation change.
protected void	paintDropdownCornerFill(java.awt.Graphics2D g2d, E popupMenu, java.awt.Dimension menuSize) Paints dropdown-styled popup menu corner fill if menu item near it is selected.
protected void	paintTransparentPopup(java.awt.Graphics2D g2d, E popupMenu) Paints transparent popup version.
java.awt.Point	preparePopupMenu(E popupMenu, java.awt.Component invoker, int x, int y) Prepares popup menu to be displayed.
protected void	propertyChange(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue) Performs various updates on property changes.
void	setFixLocation(boolean fix) Sets whether should fix initial popup menu location or not.
void	setMenuSpacing(int spacing) Sets spacing between popup menus.
void	setPopupMenuType(PopupMenuType type) Sets popup menu type.
protected void	uninstallPopupSettings(java.awt.Window window, E popupMenu) Unconfigures popup menu window opacity and shape.

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

createDropdownCornerShape, createDropdownShape, createSimpleShape, getBackgroundColor, getBorderColor, getBorderShape, getCachedShapeSettings, getComponentBackground, getCornerAlignment, getCornerSide, getCornerWidth, getCurrentShadeOpacity, getDropdownCornerShape, getOpacity, getPopupStyle, getRelativeCorner, getRound, getShadeBounds, getShadeOpacity, getShadeWidth, getSideWidth, install, isOpaque, paint, paintBackground, paintBorder, paintShade, paintSimplePopup, 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, p, 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

Methods inherited from interface com.alee.painter.Painter

addPainterListener, getPreferredSize, install, isOpaque, paint, removePainterListener, uninstall

Field Detail

menuSpacing

protected int menuSpacing

Style settings.

fixLocation

protected boolean fixLocation

dropdownStyleForMenuBar

protected boolean dropdownStyleForMenuBar

popupMenuType

protected PopupMenuType popupMenuType

Runtime variables.

Constructor Detail

PopupMenuPainter

public PopupMenuPainter()

Method Detail

propertyChange

protected void propertyChange(java.lang.String property,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)

Description copied from class: AbstractPainter

Performs various updates on property changes.

Overrides:

propertyChange in class AbstractPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

Parameters:

property - modified property

oldValue - old property value

newValue - new property value

orientationChange

protected void orientationChange()

Description copied from class: AbstractPainter

Performs various updates on orientation change.

Overrides:

orientationChange in class AbstractPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

getMenuSpacing

public int getMenuSpacing()

Returns spacing between popup menus.

Returns:

spacing between popup menus

setMenuSpacing

public void setMenuSpacing(int spacing)

Sets spacing between popup menus.

Parameters:

spacing - spacing between popup menus

isFixLocation

public boolean isFixLocation()

Returns whether should fix initial popup menu location or not.

Returns:

true if should fix initial popup menu location, false otherwise

setFixLocation

public void setFixLocation(boolean fix)

Sets whether should fix initial popup menu location or not. If set to true popup menu will try to use best possible location to show up.

This is set to true by default to place menubar and menu popups correctly. You might want to set this to false for some specific popup menu, but not all of them at once.

Parameters:

fix - whether should fix initial popup menu location or not

setPopupMenuType

public void setPopupMenuType(PopupMenuType type)

Sets popup menu type. This value is updated right before popup menu window becomes visible. You can use it to draw different popup menu decoration for each popup menu type.

Parameters:

type - popup menu type

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.JPopupMenu,U extends WebPopupMenuUI>

Overrides:

getBorders in class AbstractPopupPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

Returns:

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

paintTransparentPopup

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

Description copied from class: AbstractPopupPainter

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

Overrides:

paintTransparentPopup in class AbstractPopupPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

Parameters:

g2d - graphics context

popupMenu - popup component

paintDropdownCornerFill

protected void paintDropdownCornerFill(java.awt.Graphics2D g2d,
                                       E popupMenu,
                                       java.awt.Dimension menuSize)

Paints dropdown-styled popup menu corner fill if menu item near it is selected.

Parameters:

g2d - graphics context

popupMenu - popup menu

menuSize - menu size

geComboBoxUI

protected WebComboBoxUI geComboBoxUI(E popupMenu)

Returns combobox UI for the specified combobox popup menu.

Parameters:

popupMenu - popup menu to retrieve combobox UI for

Returns:

combobox UI for the specified combobox popup menu

preparePopupMenu

public java.awt.Point preparePopupMenu(E popupMenu,
                                       java.awt.Component invoker,
                                       int x,
                                       int y)

Description copied from interface: IPopupMenuPainter

Prepares popup menu to be displayed. This method is called before the popup for menu is created. Returned coordinate will be used to display new popup for this menu.

Specified by:

preparePopupMenu in interface IPopupMenuPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

Parameters:

popupMenu - JPopupMenu to prepare for display

invoker - popup menu invoker

x - screen x location actual popup is to be shown at

y - screen y location actual popup is to be shown at

Returns:

modified popup display location

configurePopup

public void configurePopup(E popupMenu,
                           java.awt.Component invoker,
                           int x,
                           int y,
                           javax.swing.Popup popup)

Description copied from interface: IPopupMenuPainter

Configures created popup to be displayed. This method is called before the popup with menu is displayed.

Specified by:

configurePopup in interface IPopupMenuPainter<E extends javax.swing.JPopupMenu,U extends WebPopupMenuUI>

Parameters:

popupMenu - JPopupMenu to prepare for display

invoker - popup menu invoker

x - screen x location actual popup is to be shown at

y - screen y location actual popup is to be shown at

popup - popup to be configured

installPopupSettings

protected void installPopupSettings(java.awt.Window window,
                                    E popupMenu)

Configures popup menu window opacity and shape.

Parameters:

window - popup menu window

popupMenu - popup menu

uninstallPopupSettings

protected void uninstallPopupSettings(java.awt.Window window,
                                      E popupMenu)

Unconfigures popup menu window opacity and shape.

Parameters:

window - popup menu window

popupMenu - popup menu