Класс JLayer<V extends Component>

JLayer является универсальным декоратором для компонентов Swing, который позволяет реализовать различные расширенные эффекты отрисовки, а также получать уведомления обо всех AWTEvent событиях, сгенерированных внутри его границ.

JLayer делегирует обработку отрисовки и событий ввода объекту LayerUI, который выполняет фактическое декорирование.

Реализованная в LayerUI пользовательская отрисовка и уведомления о событиях работают как для самого JLayer, так и для всех его подкомпонентов. Такое сочетание позволяет обогатить существующие компоненты, добавив новые расширенные функции, такие как временная блокировка иерархии, всплывающие подсказки для составных компонентов, улучшенное прокручивание мышью и т. д.

JLayer является хорошим решением, если вам нужно только выполнить пользовательскую отрисовку поверх составного компонента или перехватить события ввода от его подкомпонентов.

import javax.swing.*;
 import javax.swing.plaf.LayerUI;
 import java.awt.*;

 public class JLayerSample {

     private static JLayer<JComponent> createLayer() {
         // This custom layerUI will fill the layer with translucent green
         // and print out all mouseMotion events generated within its borders
         LayerUI<JComponent> layerUI = new LayerUI<JComponent>() {

             public void paint(Graphics g, JComponent c) {
                 // paint the layer as is
                 super.paint(g, c);
                 // fill it with the translucent green
                 g.setColor(new Color(0, 128, 0, 128));
                 g.fillRect(0, 0, c.getWidth(), c.getHeight());
             }

             public void installUI(JComponent c) {
                 super.installUI(c);
                 // enable mouse motion events for the layer's subcomponents
                 ((JLayer) c).setLayerEventMask(AWTEvent.MOUSE_MOTION_EVENT_MASK);
             }

             public void uninstallUI(JComponent c) {
                 super.uninstallUI(c);
                 // reset the layer event mask
                 ((JLayer) c).setLayerEventMask(0);
             }

             // overridden method which catches MouseMotion events
             public void eventDispatched(AWTEvent e, JLayer<? extends JComponent> l) {
                 System.out.println("AWTEvent detected: " + e);
             }
         };
         // create a component to be decorated with the layer
         JPanel panel = new JPanel();
         panel.add(new JButton("JButton"));

         // create the layer for the panel using our custom layerUI
         return new JLayer<JComponent>(panel, layerUI);
     }

     private static void createAndShowGUI() {
         final JFrame frame = new JFrame();
         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

         // work with the layer as with any other Swing component
         frame.add(createLayer());

         frame.setSize(200, 200);
         frame.setLocationRelativeTo(null);
         frame.setVisible(true);
     }

     public static void main(String[] args) throws Exception {
         SwingUtilities.invokeAndWait(new Runnable() {
             public void run() {
                 createAndShowGUI();
             }
         });
     }
 }

• Container.add(java.awt.Component)
• Container.add(String, java.awt.Component)
• Container.add(java.awt.Component, int)
• Container.add(java.awt.Component, Object)
• Container.add(java.awt.Component, Object, int)

Конструкторы

JLayer

public JLayer()

Создаёт новый объект JLayer с компонентом представления null и значениями по умолчанию LayerUI.

См. также:

setView(V), setUI(javax.swing.plaf.LayerUI<? super V>)

JLayer

public JLayer(V view)

Создаёт новый объект JLayer с значениями по умолчанию LayerUI.

Параметры:

view - компонент, который будет украшен этим объектом JLayer

См. также:

setUI(javax.swing.plaf.LayerUI<? super V>)

JLayer

public JLayer(V view,
              LayerUI<V> ui)

Создаёт новый объект JLayer со значением компонента представления и LayerUI объекта.

Параметры:

view - компонент, который будет украшен

ui - делегат LayerUI, который будет использоваться этим объектом JLayer

Методы

getView

public V getView()

Возвращает компонент представления объекта JLayer или null.
Это свойство привязано.

Возвращает:

компонент представления объекта JLayer или null, если таковой отсутствует

См. также:

setView(Component)

setView

public void setView(V view)

Устанавливает компонент представления объекта JLayer, который может быть null.
Это свойство привязано.

Параметры:

view - компонент представления для этого объекта JLayer

См. также:

getView()

setUI

public void setUI(LayerUI<? super V> ui)

Устанавливает LayerUI, который будет выполнять отрисовку и получать события ввода для этого объекта JLayer.

Параметры:

ui - LayerUI для этого объекта JLayer

getUI

public LayerUI<? super V> getUI()

Возвращает LayerUI для этого объекта JLayer.

Возвращает:

LayerUI для этого объекта JLayer

getGlassPane

public JPanel getGlassPane()

Возвращает компонент glassPane объекта JLayer или null.
Это свойство привязано.

Возвращает:

компонент glassPane объекта JLayer или null, если таковой отсутствует

См. также:

setGlassPane(JPanel)

setGlassPane

public void setGlassPane(JPanel glassPane)

Устанавливает компонент glassPane объекта JLayer, который может быть null.
Это свойство привязано.

Параметры:

glassPane - компонент glassPane этого объекта JLayer

См. также:

getGlassPane()

createGlassPane

public JPanel createGlassPane()

Вызывается методами-конструкторами для создания компонента glassPane по умолчанию. По умолчанию этот метод создаёт новый JPanel с видимость установленной в true и непрозрачностью в false.

Возвращает:

компонент glassPane по умолчанию

setLayout

public void setLayout(LayoutManager mgr)

Переопределяет:

setLayout в классе Container

Параметры:

mgr - указанный менеджер компоновки

Исключения:

IllegalArgumentException - этот метод не поддерживается

См. также:

Container.doLayout(), Container.getLayout(), Container.invalidate()

setBorder

public void setBorder(Border border)

Переопределяет:

setBorder в классе JComponent

Параметры:

border - устанавливаемая Border

Исключения:

IllegalArgumentException - этот метод не поддерживается

См. также:

Border, CompoundBorder

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

Этот метод не поддерживается объектом JLayer и всегда выбросит UnsupportedOperationException

Переопределяет:

addImpl в классе Container

Параметры:

comp - добавляемый компонент

constraints - объект, задающий ограничения компоновки для этого компонента

index - позиция в списке контейнера, в которую нужно вставить компонент, где -1 означает добавление в конец

Исключения:

UnsupportedOperationException - этот метод не поддерживается

См. также:

setView(Component), setGlassPane(JPanel)

remove

public void remove(Component comp)

Переопределяет:

remove в классе Container

Параметры:

comp - удаляемый компонент

См. также:

Container.add(java.awt.Component), Container.invalidate(), Container.validate(), Container.remove(int)

removeAll

public void removeAll()

Переопределяет:

removeAll в классе Container

См. также:

Container.add(java.awt.Component), Container.remove(int), Container.invalidate()

isPaintingOrigin

protected boolean isPaintingOrigin()

Всегда возвращает true для того, чтобы отрисовка происходила из JLayer, или одного из его предков.

Переопределяет:

isPaintingOrigin в классе JComponent

Возвращает:

true

См. также:

JComponent.isPaintingOrigin()

paintImmediately

public void paintImmediately(int x,
                             int y,
                             int w,
                             int h)

Делегирует свою функциональность методу LayerUI.paintImmediately(int, int, int, int, JLayer), если LayerUI установлено.

Переопределяет:

paintImmediately в классе JComponent

Параметры:

x - значение x области, подлежащей отрисовке

y - значение y области, подлежащей отрисовке

w - ширина области, подлежащей отрисовке

h - высота области, подлежащей отрисовке

См. также:

JComponent.repaint(long, int, int, int, int), JComponent.isPaintingOrigin()

paint

public void paint(Graphics g)

Делегирует всю отрисовку объекту LayerUI.

Переопределяет:

paint в классе JComponent

Параметры:

g - объект Graphics для отрисовки

См. также:

JComponent.paintComponent(java.awt.Graphics), JComponent.paintBorder(java.awt.Graphics), JComponent.paintChildren(java.awt.Graphics), JComponent.getComponentGraphics(java.awt.Graphics), JComponent.repaint(long, int, int, int, int)

paintComponent

protected void paintComponent(Graphics g)

Этот метод пуст, так как вся отрисовка выполняется методами paint(Graphics) и ComponentUI.update(Graphics, JComponent).

Переопределяет:

paintComponent в классе JComponent

Параметры:

g - объект Graphics для защиты

См. также:

JComponent.paint(java.awt.Graphics), ComponentUI

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Метод JLayer переопределяет стандартную реализацию этого метода (в JComponent) для возвращения значения false. Это гарантирует, что механизм отрисовки вызовет реализацию метода JLayer вместо непосредственного обращения к дочерним элементам JLayer.

Overrides:

isOptimizedDrawingEnabled в классе JComponent

Возвращает:

false

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Этот метод вызывается при изменении связанного свойства.

Specified by:

propertyChange в интерфейсе PropertyChangeListener

Параметры:

evt - Объект PropertyChangeEvent, описывающий источник события и изменённое свойство.

setLayerEventMask

public void setLayerEventMask(long layerEventMask)

public void installUI(JComponent c) {
       super.installUI(c);
       JLayer l = (JLayer) c;
       // this LayerUI will receive only key and focus events
       l.setLayerEventMask(AWTEvent.KEY_EVENT_MASK | AWTEvent.FOCUS_EVENT_MASK);
    }

    public void uninstallUI(JComponent c) {
       super.uninstallUI(c);
       JLayer l = (JLayer) c;
       // JLayer must be returned to its initial state
       l.setLayerEventMask(0);
    }

Параметры:

layerEventMask - Побитовая маска типов событий для получения

См. также:

getLayerEventMask(), LayerUI.eventDispatched(AWTEvent, JLayer), Component.isDisplayable()

getLayerEventMask

public long getLayerEventMask()

Возвращает:

побитовую маску типов событий для получения этим JLayer

updateUI

public void updateUI()

Делегирует свою функциональность методу LayerUI.updateUI(JLayer), если LayerUI установлено.

Overrides:

updateUI в классе JComponent

См. также:

JComponent.setUI(javax.swing.plaf.ComponentUI), UIManager.getLookAndFeel(), UIManager.getUI(javax.swing.JComponent)

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize в интерфейсе Scrollable

Возвращает:

предпочтительный размер области просмотра для компонента представления

См. также:

Scrollable

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Specified by:

getScrollableBlockIncrement в интерфейсе Scrollable

Параметры:

visibleRect - Область просмотра, видимая в пределах области просмотра

orientation - SwingConstants.VERTICAL или SwingConstants.HORIZONTAL.

direction - Меньше нуля для прокрутки вверх/влево, больше нуля для вниз/вправо.

Возвращает:

шаг прокрутки блока в указанном направлении

См. также:

Scrollable

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight в интерфейсе Scrollable

Возвращает:

следует ли слою отслеживать высоту области просмотра

См. также:

Scrollable

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth в интерфейсе Scrollable

Возвращает:

следует ли слою отслеживать ширину области просмотра

См. также:

Scrollable

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Specified by:

getScrollableUnitIncrement в интерфейсе Scrollable

Параметры:

visibleRect - Видимая область просмотра

orientation - SwingConstants.VERTICAL или SwingConstants.HORIZONTAL.

direction - Меньше нуля для прокрутки вверх/влево, больше нуля для вниз/вправо.

Возвращает:

шаг прокрутки на единицу в заданном направлении. Это значение должно быть всегда положительным.

См. также:

Scrollable

addNotify

public void addNotify()

Уведомляет этот компонент о том, что у него теперь есть родительский компонент. При вызове этого метода устанавливается цепочка родительских компонентов с KeyboardAction обработчиками событий. Этот метод вызывается внутри среды выполнения и не должен вызываться программами напрямую.

Overrides:

addNotify в классе JComponent

См. также:

JComponent.registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

removeNotify

public void removeNotify()

Уведомляет этот компонент о том, что у него больше нет родительского компонента. При вызове этого метода любые KeyboardAction установленные в цепочке родительских компонентов удаляются. Этот метод вызывается внутри среды выполнения и не должен вызываться программами напрямую.

Overrides:

removeNotify в классе JComponent

См. также:

JComponent.registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

doLayout

public void doLayout()

Делегирует свою функциональность методу LayerUI.doLayout(JLayer), если LayerUI установлено.

Overrides:

doLayout в классе Container

См. также:

LayoutManager.layoutContainer(java.awt.Container), Container.setLayout(java.awt.LayoutManager), Container.validate()

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанный с этим JLayer.

Specified by:

getAccessibleContext в интерфейсе Accessible

Overrides:

getAccessibleContext в классе Component

Возвращает:

AccessibleContext, связанный с этим JLayer.