com.alee.laf.menu

Class WebPopupMenuUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.PopupMenuUI

javax.swing.plaf.basic.BasicPopupMenuUI

com.alee.laf.menu.WebPopupMenuUI

All Implemented Interfaces:

MarginSupport, PaddingSupport, ShapeProvider, Styleable, javax.swing.SwingConstants

public class WebPopupMenuUI
extends javax.swing.plaf.basic.BasicPopupMenuUI
implements Styleable, ShapeProvider, MarginSupport, PaddingSupport, javax.swing.SwingConstants

Custom UI for JPopupMenu component.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Insets	margin
protected java.awt.Insets	padding
protected IPopupMenuPainter	painter Component painter.
protected PopupMenuWay	popupMenuWay Runtime variables.

Fields inherited from class javax.swing.plaf.basic.BasicPopupMenuUI

popupMenu

Fields inherited from interface com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

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

Method Summary

Modifier and Type	Method and Description
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent c) Returns an instance of the WebPopupMenuUI for the specified component.
java.awt.Insets	getMargin() Returns current margin.
java.awt.Insets	getPadding() Returns current padding.
Painter	getPainter() Returns popup menu painter.
javax.swing.Popup	getPopup(javax.swing.JPopupMenu popup, int x, int y) Returns the Popup that will be responsible for displaying the JPopupMenu.
PopupMenuWay	getPopupMenuWay() Returns currently set preferred popup menu display way.
java.awt.Dimension	getPreferredSize(javax.swing.JComponent c)
StyleId	getStyleId() Returns component style ID.
void	installUI(javax.swing.JComponent c) Installs UI in the specified component.
void	paint(java.awt.Graphics g, javax.swing.JComponent c)
java.awt.Shape	provideShape() Returns component shape.
void	setMargin(java.awt.Insets margin) Sets new margin.
void	setPadding(java.awt.Insets padding) Sets new padding.
void	setPainter(Painter painter) Sets popup menu painter.
void	setPopupMenuWay(PopupMenuWay way) Assists popup menu to allow it choose the best position relative to invoker.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	uninstallUI(javax.swing.JComponent c) Uninstalls UI from the specified component.

Methods inherited from class javax.swing.plaf.basic.BasicPopupMenuUI

installDefaults, installKeyboardActions, installListeners, isPopupTrigger, uninstallDefaults, uninstallKeyboardActions, uninstallListeners

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, update

Methods inherited from class java.lang.Object

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

Field Detail

painter

@DefaultPainter(value=PopupMenuPainter.class)
protected IPopupMenuPainter painter

Component painter.

popupMenuWay

protected PopupMenuWay popupMenuWay

Runtime variables.

margin

protected java.awt.Insets margin

padding

protected java.awt.Insets padding

Constructor Detail

WebPopupMenuUI

public WebPopupMenuUI()

Method Detail

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)

Returns an instance of the WebPopupMenuUI for the specified component. This tricky method is used by UIManager to create component UIs when needed.

Parameters:

c - component that will use UI instance

Returns:

instance of the WebPopupMenuUI

installUI

public void installUI(javax.swing.JComponent c)

Installs UI in the specified component.

Overrides:

installUI in class javax.swing.plaf.basic.BasicPopupMenuUI

Parameters:

c - component for this UI

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Uninstalls UI from the specified component.

Overrides:

uninstallUI in class javax.swing.plaf.basic.BasicPopupMenuUI

Parameters:

c - component with this UI

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getMargin

public java.awt.Insets getMargin()

Description copied from interface: MarginSupport

Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.

Specified by:

getMargin in interface MarginSupport

Returns:

current margin

setMargin

public void setMargin(java.awt.Insets margin)

Description copied from interface: MarginSupport

Sets new margin. null can be provided to set an empty [0,0,0,0] margin.

Specified by:

setMargin in interface MarginSupport

Parameters:

margin - new margin

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

Sets new padding. null can be provided to set an empty [0,0,0,0] padding.

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

setPopupMenuWay

public void setPopupMenuWay(PopupMenuWay way)

Assists popup menu to allow it choose the best position relative to invoker. Its value nullified right after first usage to avoid popup menu display issues in future.

Parameters:

way - approximate popup menu display way

getPopupMenuWay

public PopupMenuWay getPopupMenuWay()

Returns currently set preferred popup menu display way. It might be null in case menu was just shown and this value wasn't updated afterwards.

Returns:

currently set preferred popup menu display way

getPainter

public Painter getPainter()

Returns popup menu painter.

Returns:

popup menu painter

setPainter

public void setPainter(Painter painter)

Sets popup menu painter. Pass null to remove popup menu painter.

Parameters:

painter - new popup menu painter

getPopup

public javax.swing.Popup getPopup(javax.swing.JPopupMenu popup,
                                  int x,
                                  int y)

Returns the Popup that will be responsible for displaying the JPopupMenu. Also does necessary modifications to popup coordinates in case they are actually required.

Overrides:

getPopup in class javax.swing.plaf.PopupMenuUI

Parameters:

popup - JPopupMenu requesting Popup

x - screen x location Popup is to be shown at

y - screen y location Popup is to be shown at

Returns:

Popup that will show the JPopupMenu

paint

public void paint(java.awt.Graphics g,
                  javax.swing.JComponent c)

Overrides:

paint in class javax.swing.plaf.ComponentUI

getPreferredSize

public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)

Overrides:

getPreferredSize in class javax.swing.plaf.ComponentUI