V
- one of the super types of JLayer
's view componentSerializable
public class LayerUI<V extends Component> extends ComponentUI implements Serializable
JLayer
's UI delegates. paint(java.awt.Graphics, javax.swing.JComponent)
method performs the painting of the JLayer
and eventDispatched(AWTEvent, JLayer)
method is notified about any AWTEvent
s which have been generated by a JLayer
or any of its subcomponents.
The LayerUI
differs from the UI delegates of the other components, because it is LookAndFeel independent and is not updated by default when the system LookAndFeel is changed.
The subclasses of LayerUI
can either be stateless and shareable by multiple JLayer
s or not shareable.
Constructor | Description |
---|---|
LayerUI() |
Constructs a LayerUI . |
Modifier and Type | Method | Description |
---|---|---|
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list. |
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list for a specific property. |
void |
applyPropertyChange |
Notifies the LayerUI when any of its property are changed and enables updating every JLayer this LayerUI instance is set to. |
void |
doLayout |
Causes the passed instance of JLayer to lay out its components. |
void |
eventDispatched |
Processes AWTEvent s for JLayer and all its descendants to this LayerUI instance. |
protected void |
firePropertyChange |
Support for reporting bound property changes for Object properties. |
int |
getBaseline |
If the JLayer 's view component is not null , this calls the view's getBaseline() method. |
Component.BaselineResizeBehavior |
getBaselineResizeBehavior |
If the JLayer 's view component is not null , this returns the result of the view's getBaselineResizeBehavior() method. |
Dimension |
getMaximumSize |
If the JLayer 's view component is not null , this returns the result of the view's getMaximumSize() method. |
Dimension |
getMinimumSize |
If the JLayer 's view component is not null , this returns the result of the view's getMinimalSize() method. |
Dimension |
getPreferredSize |
If the JLayer 's view component is not null , this returns the result of the view's getPreferredSize() method. |
PropertyChangeListener[] |
getPropertyChangeListeners() |
Returns an array of all the property change listeners registered on this component. |
PropertyChangeListener[] |
getPropertyChangeListeners |
Returns an array of all the listeners which have been associated with the named property. |
boolean |
imageUpdate |
Delegates its functionality to the default implementation of the JLayer.imageUpdate method which is inherited from JLayer 's base classes. |
void |
installUI |
Configures the JLayer this LayerUI is set to. |
void |
paint |
Paints the specified component. |
void |
paintImmediately |
Paints the specified region in the JLayer this LayerUI is set to, immediately. |
protected void |
processComponentEvent |
Processes component events occurring on the JLayer or any of its subcomponents. |
protected void |
processFocusEvent |
Processes focus events occurring on the JLayer or any of its subcomponents. |
protected void |
processHierarchyBoundsEvent |
Processes hierarchy bounds event occurring on the JLayer or any of its subcomponents. |
protected void |
processHierarchyEvent |
Processes hierarchy event occurring on the JLayer or any of its subcomponents. |
protected void |
processInputMethodEvent |
Processes input event occurring on the JLayer or any of its subcomponents. |
protected void |
processKeyEvent |
Processes key events occurring on the JLayer or any of its subcomponents. |
protected void |
processMouseEvent |
Processes mouse events occurring on the JLayer or any of its subcomponents. |
protected void |
processMouseMotionEvent |
Processes mouse motion event occurring on the JLayer or any of its subcomponents. |
protected void |
processMouseWheelEvent |
Processes mouse wheel event occurring on the JLayer or any of its subcomponents. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list for a specific property. |
void |
uninstallUI |
Reverses the configuration which was previously set in the installUI(JComponent) method. |
void |
updateUI |
contains, createUI, getAccessibleChild, getAccessibleChildrenCount, update
public LayerUI()
LayerUI
.public void paint(Graphics g, JComponent c)
Graphics
object to render the content of the component. The default implementation paints the passed component as is.
paint
in class ComponentUI
g
- the Graphics
context in which to paintc
- the component being paintedpublic void eventDispatched(AWTEvent e, JLayer<? extends V> l)
AWTEvent
s for JLayer
and all its descendants to this LayerUI
instance. To enable the AWTEvent
s of a particular type, you call JLayer.setLayerEventMask(long)
in installUI(javax.swing.JComponent)
and set the layer event mask to 0
in uninstallUI(javax.swing.JComponent)
after that. By default this method calls the appropriate process<event
type>Event
method for the given class of event.
Note: Events are processed only for displayable JLayer
s.
e
- the event to be dispatchedl
- the layer this LayerUI is set toprotected void processComponentEvent(ComponentEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless component events are enabled for the JLayer
objects, this LayerUI
is set to. Component events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.COMPONENT_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the ComponentEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processFocusEvent(FocusEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless focus events are enabled for the JLayer
objects, this LayerUI
is set to. Focus events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.FOCUS_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the FocusEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processKeyEvent(KeyEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless key events are enabled for the JLayer
objects, this LayerUI
is set to. Key events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.KEY_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the KeyEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processMouseEvent(MouseEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless mouse events are enabled for the JLayer
objects, this LayerUI
is set to. Mouse events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.MOUSE_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the MouseEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processMouseMotionEvent(MouseEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless mouse motion events are enabled for the JLayer
objects, this LayerUI
is set to. Mouse motion events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.MOUSE_MOTION_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the MouseEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processMouseWheelEvent(MouseWheelEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless mouse wheel events are enabled for the JLayer
objects, this LayerUI
is set to. Mouse wheel events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.MOUSE_WHEEL_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the MouseEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processInputMethodEvent(InputMethodEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless input events are enabled for the JLayer
objects, this LayerUI
is set to. Input events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.INPUT_METHOD_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the InputMethodEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processHierarchyEvent(HierarchyEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless hierarchy events are enabled for the JLayer
objects, this LayerUI
is set to. Hierarchy events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.HIERARCHY_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the HierarchyEvent
to be processedl
- the layer this LayerUI
instance is set toprotected void processHierarchyBoundsEvent(HierarchyEvent e, JLayer<? extends V> l)
JLayer
or any of its subcomponents. This method is not called unless hierarchy bounds events are enabled for the JLayer
objects, this LayerUI
is set to. Hierarchy bounds events are enabled in the overridden installUI(javax.swing.JComponent)
method and should be disabled in the uninstallUI(javax.swing.JComponent)
method after that.
public void installUI(JComponent c) { super.installUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK); } public void uninstallUI(JComponent c) { super.uninstallUI(c); JLayer l = (JLayer) c; l.setLayerEventMask(0); }
e
- the HierarchyEvent
to be processedl
- the layer this LayerUI
instance is set topublic void updateUI(JLayer<? extends V> l)
l
- the JLayer
which UI is updatedpublic void installUI(JComponent c)
JLayer
this LayerUI
is set to. The default implementation registers the passed JLayer
component as a PropertyChangeListener
for the property changes of this LayerUI
.installUI
in class ComponentUI
c
- the JLayer
component where this UI delegate is being installedpublic void uninstallUI(JComponent c)
installUI(JComponent)
method. The default implementation unregisters the passed JLayer
component as a PropertyChangeListener
for the property changes of this LayerUI
.uninstallUI
in class ComponentUI
c
- the component from which this UI delegate is being removed.public void addPropertyChangeListener(PropertyChangeListener listener)
If listener
is null
, no exception is thrown and no action is performed.
listener
- the property change listener to be addedpublic void removePropertyChangeListener(PropertyChangeListener listener)
If listener
is null
, no exception is thrown and no action is performed.
listener
- the PropertyChangeListener to be removedpublic PropertyChangeListener[] getPropertyChangeListeners()
PropertyChangeListener
s or an empty array if no property change listeners are currently registeredpublic void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
If propertyName
or listener
is null
, no exception is thrown and no action is taken.
propertyName
- one of the property names listed abovelistener
- the property change listener to be addedpublic void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
PropertyChangeListener
from the listener list for a specific property. This method should be used to remove PropertyChangeListener
s that were registered for a specific bound property. If propertyName
or listener
is null
, no exception is thrown and no action is taken.
propertyName
- a valid property namelistener
- the PropertyChangeListener to be removedpublic PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
propertyName
- The name of the property being listened toPropertyChangeListener
s associated with the named property; if no such listeners have been added or if propertyName
is null
, an empty array is returnedprotected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
propertyName
- the property whose value has changedoldValue
- the property's previous valuenewValue
- the property's new valuepublic void applyPropertyChange(PropertyChangeEvent evt, JLayer<? extends V> l)
LayerUI
when any of its property are changed and enables updating every JLayer
this LayerUI
instance is set to.evt
- the PropertyChangeEvent generated by this LayerUI
l
- the JLayer
this LayerUI is set topublic int getBaseline(JComponent c, int width, int height)
JLayer
's view component is not null
, this calls the view's getBaseline()
method. Otherwise, the default implementation is called.getBaseline
in class ComponentUI
c
- JLayer
to return baseline resize behavior forwidth
- the width to get the baseline forheight
- the height to get the baseline forpublic Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
JLayer
's view component is not null
, this returns the result of the view's getBaselineResizeBehavior()
method. Otherwise, the default implementation is called.getBaselineResizeBehavior
in class ComponentUI
c
- JLayer
to return baseline resize behavior forpublic void doLayout(JLayer<? extends V> l)
JLayer
to lay out its components.l
- the JLayer
component where this UI delegate is being installedpublic Dimension getPreferredSize(JComponent c)
JLayer
's view component is not null
, this returns the result of the view's getPreferredSize()
method. Otherwise, the default implementation is used.getPreferredSize
in class ComponentUI
c
- JLayer
to return preferred size forJLayer
public Dimension getMinimumSize(JComponent c)
JLayer
's view component is not null
, this returns the result of the view's getMinimalSize()
method. Otherwise, the default implementation is used.getMinimumSize
in class ComponentUI
c
- JLayer
to return preferred size forJLayer
public Dimension getMaximumSize(JComponent c)
JLayer
's view component is not null
, this returns the result of the view's getMaximumSize()
method. Otherwise, the default implementation is used.getMaximumSize
in class ComponentUI
c
- JLayer
to return preferred size forJLayer
public void paintImmediately(int x, int y, int width, int height, JLayer<? extends V> l)
JLayer
this LayerUI
is set to, immediately. This method is to be overridden when the dirty region needs to be changed. The default implementation delegates its functionality to JComponent.paintImmediately(int, int, int, int)
.
x
- the x value of the region to be paintedy
- the y value of the region to be paintedwidth
- the width of the region to be paintedheight
- the height of the region to be paintedl
- a JLayer
componentpublic boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h, JLayer<? extends V> l)
JLayer.imageUpdate
method which is inherited from JLayer
's base classes. This method is to be overridden instead of JLayer.imageUpdate
.
Note: This method is usually called not on the Event Dispatching Thread.
img
- the image being observedinfoflags
- see imageUpdate for informationx
- the x coordinatey
- the y coordinatew
- the widthh
- the heightl
- a JLayer
component
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/plaf/LayerUI.html