BlockingLayerUI (JAXX :: Runtime 2.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jaxx.runtime.swing
Class BlockingLayerUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      org.jdesktop.jxlayer.plaf.LayerUI<V>
          org.jdesktop.jxlayer.plaf.AbstractLayerUI<JComponent>
              jaxx.runtime.swing.BlockingLayerUI

All Implemented Interfaces:: Serializable

public class BlockingLayerUI
extends org.jdesktop.jxlayer.plaf.AbstractLayerUI<JComponent>
extends org.jdesktop.jxlayer.plaf.AbstractLayerUI<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, JXLayer)

Since:: 1.2
Author:: tchemit
See Also:: Serialized Form

Field Summary
`static String`	`ACCEPT_ICON_PROPERTY`
`protected Action`	`acceptAction` Action to be treated when click on icon
`protected List<String>`	`acceptedComponentNames` Extra components names 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
`BlockingLayerUI()`

Method Summary
`protected void`	`acceptEvent(MouseEvent e, org.jdesktop.jxlayer.JXLayer<? extends JComponent> l)`
`BlockingLayerUI`	`clone()`
`protected BufferedImage`	`getAcceptIcon()`
`BufferedImage`	`getBlockIcon()`
`protected BufferedImage`	`getCurrentIcon()`
`boolean`	`isCanClick()`
`protected void`	`paintLayer(Graphics2D g2, org.jdesktop.jxlayer.JXLayer<? extends JComponent> l)`
`protected BufferedImage`	`prepareIcon(ImageIcon image)`
`protected void`	`processKeyEvent(KeyEvent e, org.jdesktop.jxlayer.JXLayer<? extends JComponent> l)`
`protected void`	`processMouseEvent(MouseEvent e, org.jdesktop.jxlayer.JXLayer<? extends JComponent> l)`
`protected void`	`processMouseMotionEvent(MouseEvent e, org.jdesktop.jxlayer.JXLayer<? extends JComponent> l)`
`void`	`setAcceptAction(Action acceptAction)`
`void`	`setAcceptedComponentNames(String... acceptedComponentNames)`
`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 isDirty)`
`void`	`setUseIcon(boolean useIcon)`
`protected void`	`updateCanClickState(org.jdesktop.jxlayer.JXLayer<? extends JComponent> l, MouseEvent e)`

Methods inherited from class org.jdesktop.jxlayer.plaf.AbstractLayerUI
`configureGraphics, eventDispatched, getClip, getComposite, getLayerEventMask, getRenderingHints, getTransform, handlePropertyChangeEvent, installUI, isDirty, paint, processFocusEvent, processMouseWheelEvent, uninstallUI`

Methods inherited from class org.jdesktop.jxlayer.plaf.LayerUI
`addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getPreferredScrollableViewportSize, getPropertyChangeListeners, getPropertyChangeListeners, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, removePropertyChangeListener, removePropertyChangeListener, updateUI`

Methods inherited from class javax.swing.plaf.ComponentUI
`contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, 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 List<String> acceptedComponentNames

Extra components names to accept even in block mode

Constructor Detail