org.nuiton.jaxx.swing.extra.layer

Class BlockingLayerUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.LayerUI<JComponent>

org.nuiton.jaxx.swing.extra.layer.BlockingLayerUI

All Implemented Interfaces:

Serializable

public class BlockingLayerUI
extends LayerUI<JComponent>

A JXLayer ui implementation that permits to block a component but still allow an action when clicking on the right-top icon painted on the layer.

You can change the blocking and accepting icon.

To hook an click on the layer's icon, you can :

• pass an Action via method setAcceptAction(Action)
• override the method acceptEvent(MouseEvent, JLayer)

Since:

1.2

Author:

Tony Chemit - chemit@codelutin.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_ICON_PROPERTY
protected Action	acceptAction Action to be treated when click on icon
protected Set<String>	acceptedComponentNames Extra components names to accept even in block mode
protected Set<Class<?>>	acceptedComponentTypes Extra components types to accept even in block mode
protected BufferedImage	acceptIcon Icon when you can click
protected boolean	block Internal state when should block event and paint layer
static String	BLOCK_ICON_PROPERTY
static String	BLOCK_PROPERTY
protected BufferedImage	blockIcon Icon when you can not click
protected Color	blockingColor Optinal color to put fill background when blocking
static String	CAN_CLICK_PROPERTY
protected boolean	canClick Internal state to known when we can accept click
protected boolean	useIcon A flag to enable or disable the use of the icon.

Constructor Summary

Constructors

Constructor and Description
BlockingLayerUI()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	acceptEvent(MouseEvent e, JLayer<? extends JComponent> l)
protected boolean	acceptEventOrConsumeIt(InputEvent e)
void	applyPropertyChange(PropertyChangeEvent evt, JLayer<? extends JComponent> l)
BlockingLayerUI	clone()
protected BufferedImage	getAcceptIcon()
BufferedImage	getBlockIcon()
protected BufferedImage	getCurrentIcon()
void	installUI(JComponent c)
boolean	isCanClick()
void	paint(Graphics g, JComponent c)
protected BufferedImage	prepareIcon(ImageIcon image)
protected void	processKeyEvent(KeyEvent e, JLayer<? extends JComponent> l)
protected void	processMouseEvent(MouseEvent e, JLayer<? extends JComponent> l)
protected void	processMouseMotionEvent(MouseEvent e, JLayer<? extends JComponent> l)
protected void	processMouseWheelEvent(MouseWheelEvent e, JLayer<? extends JComponent> l)
void	setAcceptAction(Action acceptAction)
void	setAcceptedComponentNames(String... acceptedComponentNames)
void	setAcceptedComponentTypes(Class<?>... acceptedComponentTypes)
void	setAcceptIcon(ImageIcon acceptIcon)
void	setBlock(boolean block)
void	setBlockIcon(BufferedImage blockIcon)
void	setBlockIcon(ImageIcon blockIcon)
void	setBlockingColor(Color blockingColor)
void	setCanClick(boolean canClick)
void	setDirty(boolean dirty)
void	setUseIcon(boolean useIcon)
void	uninstallUI(JComponent c)
protected void	updateCanClickState(JLayer<? extends JComponent> l, MouseEvent e)

Methods inherited from class javax.swing.plaf.LayerUI

addPropertyChangeListener, addPropertyChangeListener, doLayout, eventDispatched, firePropertyChange, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, paintImmediately, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, removePropertyChangeListener, removePropertyChangeListener, updateUI

Methods inherited from class javax.swing.plaf.ComponentUI

contains, createUI, getAccessibleChild, getAccessibleChildrenCount, update

Methods inherited from class java.lang.Object

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

Field Detail

CAN_CLICK_PROPERTY

public static final String CAN_CLICK_PROPERTY

See Also:

Constant Field Values

ACCEPT_ICON_PROPERTY

public static final String ACCEPT_ICON_PROPERTY

See Also:

Constant Field Values

BLOCK_ICON_PROPERTY

public static final String BLOCK_ICON_PROPERTY

See Also:

Constant Field Values

BLOCK_PROPERTY

public static final String BLOCK_PROPERTY

See Also:

Constant Field Values

acceptAction

protected Action acceptAction

Action to be treated when click on icon

blockIcon

protected BufferedImage blockIcon

Icon when you can not click

acceptIcon

protected BufferedImage acceptIcon

Icon when you can click

blockingColor

protected Color blockingColor

Optinal color to put fill background when blocking

canClick

protected boolean canClick

Internal state to known when we can accept click

useIcon

protected boolean useIcon

A flag to enable or disable the use of the icon.

If set to false, no icon will be displayed and no action will be possible.

By default, this is active.

block

protected boolean block

Internal state when should block event and paint layer

acceptedComponentNames

protected final Set<String> acceptedComponentNames

Extra components names to accept even in block mode

acceptedComponentTypes

protected final Set<Class<?>> acceptedComponentTypes

Extra components types to accept even in block mode

Constructor Detail

BlockingLayerUI

public BlockingLayerUI()

Method Detail

setAcceptedComponentNames

public void setAcceptedComponentNames(String... acceptedComponentNames)

setAcceptedComponentTypes

public void setAcceptedComponentTypes(Class<?>... acceptedComponentTypes)

setAcceptAction

public void setAcceptAction(Action acceptAction)

setAcceptIcon

public void setAcceptIcon(ImageIcon acceptIcon)

setBlockIcon

public void setBlockIcon(ImageIcon blockIcon)

setCanClick

public void setCanClick(boolean canClick)

setBlock

public void setBlock(boolean block)

setDirty

public void setDirty(boolean dirty)

applyPropertyChange

public void applyPropertyChange(PropertyChangeEvent evt,
                       JLayer<? extends JComponent> l)

Overrides:

applyPropertyChange in class LayerUI<JComponent>

setBlockIcon

public void setBlockIcon(BufferedImage blockIcon)

setBlockingColor

public void setBlockingColor(Color blockingColor)

getBlockIcon

public BufferedImage getBlockIcon()

getAcceptIcon

protected BufferedImage getAcceptIcon()

isCanClick

public boolean isCanClick()

setUseIcon

public void setUseIcon(boolean useIcon)

clone

public BlockingLayerUI clone()

Overrides:

clone in class Object

processKeyEvent

protected void processKeyEvent(KeyEvent e,
                   JLayer<? extends JComponent> l)

Overrides:

processKeyEvent in class LayerUI<JComponent>

processMouseMotionEvent

protected void processMouseMotionEvent(MouseEvent e,
                           JLayer<? extends JComponent> l)

Overrides:

processMouseMotionEvent in class LayerUI<JComponent>

processMouseEvent

protected void processMouseEvent(MouseEvent e,
                     JLayer<? extends JComponent> l)

Overrides:

processMouseEvent in class LayerUI<JComponent>

processMouseWheelEvent

protected void processMouseWheelEvent(MouseWheelEvent e,
                          JLayer<? extends JComponent> l)

Overrides:

processMouseWheelEvent in class LayerUI<JComponent>

acceptEventOrConsumeIt

protected boolean acceptEventOrConsumeIt(InputEvent e)

paint

public void paint(Graphics g,
         JComponent c)

Overrides:

paint in class LayerUI<JComponent>

installUI

public void installUI(JComponent c)

Overrides:

installUI in class LayerUI<JComponent>

uninstallUI

public void uninstallUI(JComponent c)

Overrides:

uninstallUI in class LayerUI<JComponent>

acceptEvent

protected void acceptEvent(MouseEvent e,
               JLayer<? extends JComponent> l)

getCurrentIcon

protected BufferedImage getCurrentIcon()

prepareIcon

protected BufferedImage prepareIcon(ImageIcon image)

updateCanClickState

protected void updateCanClickState(JLayer<? extends JComponent> l,
                       MouseEvent e)