AbstractDecorationPainter

java.lang.Object
- com.alee.painter.AbstractPainter<E,U>
- - com.alee.painter.decoration.AbstractDecorationPainter<E,U,D>

Type Parameters:

E - component type

U - component UI type

D - decoration type

All Implemented Interfaces:

PainterShapeProvider<E>, Painter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

Direct Known Subclasses:

AbstractButtonPainter, AbstractContainerPainter, AbstractLabelPainter, AbstractSectionDecorationPainter, AbstractTextEditorPainter, ComboBoxPainter, DateFieldPainter, ListPainter, MenuBarPainter, ProgressBarPainter, SpinnerPainter, ToolTipPainter, TreePainter
```
public abstract class AbstractDecorationPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI,D extends IDecoration<E,D>>
extends AbstractPainter<E,U>
implements PainterShapeProvider<E>
```
Abstract decoration painter that can be used by any custom and specific painter.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.Container`	`ancestor`
`static java.lang.String`	`DECORATION_STATES_PROPERTY` Decoratable states property.
`protected java.util.Map<java.lang.String,D>`	`decorationCache`
`protected java.util.List<D>`	`decorations` Decoration states.
`protected boolean`	`focused`
`protected FocusTracker`	`focusStateTracker` Listeners.
`protected java.awt.event.HierarchyListener`	`hierarchyTracker`
`protected boolean`	`hover`
`protected AbstractHoverBehavior<E>`	`hoverStateTracker`
`protected java.awt.event.ContainerListener`	`neighboursTracker`
`protected java.util.List<java.lang.String>`	`states` Runtime variables.

Fields inherited from class com.alee.painter.AbstractPainter
component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors
Constructor and Description

AbstractDecorationPainter()

Constructors
Constructor and Description
`AbstractDecorationPainter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.awt.Rectangle`	`adjustBounds(java.awt.Rectangle bounds)` Returns adjusted painting bounds.
`protected java.util.List<SectionPainter<E,U>>`	`asList(SectionPainter<E,U>... sections)` Returns section painters list in a most optimal way.
`protected java.util.List<java.lang.String>`	`collectDecorationStates()` Returns properly sorted current component decoration states.
`java.awt.Insets`	`getBorders()` Returns borders required for visual data provided by this painter.
`protected D`	`getDecoration()` Returns decoration matching current states.
`protected java.util.List<D>`	`getDecorations(java.util.List<java.lang.String> forStates)` Returns decorations for the specified states.
`protected java.awt.Dimension`	`getDecorationSize()` Returns preferred decoration size.
`protected java.util.List<java.lang.String>`	`getDecorationStates()` Returns current component decoration states.
`java.awt.Dimension`	`getPreferredSize()` Returns preferred size required for proper painting of visual data provided by this painter.
`protected java.util.List<SectionPainter<E,U>>`	`getSectionPainters()` Returns section painters used within this painter.
`void`	`install(E c, U ui)` Called when painter is installed onto some component.
`protected void`	`installFocusListener()` Installs listener that will perform decoration updates on focus state change.
`protected void`	`installHierarchyListener()` Installs listener that will perform border updates on component hierarchy changes.
`protected void`	`installHoverListener()` Installs listener that will perform decoration updates on hover state change.
`boolean`	`isDecorated()` Returns whether or not decoration is available.
`protected boolean`	`isDecorationPaintAllowed(D decoration)` Returns whether or not painting specified decoration is allowed.
`protected boolean`	`isEnabled()` Returns whether or not component is in enabled state.
`protected boolean`	`isFocused()` Returns whether or not component has focus.
`protected boolean`	`isHover()` Returns whether or not component is in hover state.
`java.lang.Boolean`	`isOpaque()` Returns whether visual data provided by this painter is opaque or not.
`protected java.lang.Boolean`	`isOpaqueDecorated()` Returns opacity state for decorated component.
`protected java.lang.Boolean`	`isOpaqueUndecorated()` Returns opacity state for undecorated component.
`protected boolean`	`isPlainBackgroundPaintAllowed(E c)` Returns whether or not painting plain component background is allowed.
`void`	`paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui)` Paints visual data using component graphics context.
`protected void`	`paintContent(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui)` Paints content decorated by this painter.
`protected void`	`propertyChange(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)` Performs various updates on property changes.
`java.awt.Shape`	`provideShape(E component, java.awt.Rectangle bounds)` Returns painted component shape.
`void`	`uninstall(E c, U ui)` Called when painter is installed into some component.
`protected void`	`uninstallFocusListener()` Uninstalls listener that performs decoration updates on focus state change.
`protected void`	`uninstallHierarchyListener()` Uninstalls listener that performs border updates on component hierarchy changes.
`protected void`	`uninstallHoverListener()` Uninstalls listener that performs decoration updates on hover state change.
`protected void`	`updateDecorationState()` Performs current decoration state update.
`protected boolean`	`usesState(java.util.List<D> decorations, java.lang.String state)` Returns whether specified decorations are associated with specified state.
`protected boolean`	`usesState(java.lang.String state)` Returns whether component has decoration associated with specified state.

Methods inherited from class com.alee.painter.AbstractPainter
addPainterListener, b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DECORATION_STATES_PROPERTY
```
public static final java.lang.String DECORATION_STATES_PROPERTY
```
    Decoratable states property.
    
    See Also:
    
    Constant Field Values
  - decorations
```
protected java.util.List<D extends IDecoration<E,D>> decorations
```
    Decoration states.
  - focusStateTracker
```
protected transient FocusTracker focusStateTracker
```
    Listeners.
  - hoverStateTracker
```
protected transient AbstractHoverBehavior<E extends javax.swing.JComponent> hoverStateTracker
```
  - hierarchyTracker
```
protected transient java.awt.event.HierarchyListener hierarchyTracker
```
  - neighboursTracker
```
protected transient java.awt.event.ContainerListener neighboursTracker
```
  - states
```
protected transient java.util.List<java.lang.String> states
```
    Runtime variables.
  - decorationCache
```
protected transient java.util.Map<java.lang.String,D extends IDecoration<E,D>> decorationCache
```
  - focused
```
protected transient boolean focused
```
  - hover
```
protected transient boolean hover
```
  - ancestor
```
protected transient java.awt.Container ancestor
```
- Constructor Detail
  - AbstractDecorationPainter
```
public AbstractDecorationPainter()
```
- Method Detail
  - install
```
public void install(E c,
                    U ui)
```
    Description copied from interface: Painter
    
    Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.
    
    Specified by:
    
    install in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Overrides:
    
    install in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Parameters:
    
    c - component this painter is being installed onto
    
    ui - component UI
  - uninstall
```
public void uninstall(E c,
                      U ui)
```
    Description copied from interface: Painter
    
    Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.
    
    Specified by:
    
    uninstall in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Overrides:
    
    uninstall in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Parameters:
    
    c - component this painter is being uninstalled from
    
    ui - component UI
  - propertyChange
```
protected void propertyChange(java.lang.String property,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)
```
    Description copied from class: AbstractPainter
    
    Performs various updates on property changes.
    
    Overrides:
    
    propertyChange in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Parameters:
    
    property - modified property
    
    oldValue - old property value
    
    newValue - new property value
  - installFocusListener
```
protected void installFocusListener()
```
    Installs listener that will perform decoration updates on focus state change.
  - uninstallFocusListener
```
protected void uninstallFocusListener()
```
    Uninstalls listener that performs decoration updates on focus state change.
  - isFocused
```
protected boolean isFocused()
```
    Returns whether or not component has focus.
    
    Returns:
    
    true if component has focus, false otherwise
  - installHoverListener
```
protected void installHoverListener()
```
    Installs listener that will perform decoration updates on hover state change.
  - uninstallHoverListener
```
protected void uninstallHoverListener()
```
    Uninstalls listener that performs decoration updates on hover state change.
  - installHierarchyListener
```
protected void installHierarchyListener()
```
    Installs listener that will perform border updates on component hierarchy changes. This is required to properly update decoration borders in case it was moved from or into container with grouping layout. It also tracks neighbour components addition and removal to update this component border accordingly.
  - uninstallHierarchyListener
```
protected void uninstallHierarchyListener()
```
    Uninstalls listener that performs border updates on component hierarchy changes.
  - isHover
```
protected boolean isHover()
```
    Returns whether or not component is in hover state.
    
    Returns:
    
    true if component is in hover state, false otherwise
  - getSectionPainters
```
protected java.util.List<SectionPainter<E,U>> getSectionPainters()
```
    Returns section painters used within this painter. Might also return null in case no section painters are used within this one. This method is used for various internal update mechanisms involving section painters.
    
    Returns:
    
    section painters used within this painter
  - asList
```
protected final java.util.List<SectionPainter<E,U>> asList(SectionPainter<E,U>... sections)
```
    Returns section painters list in a most optimal way. Utility method for usage inside of classed extending this one.
    
    Parameters:
    
    sections - section painters, some or all of them can be null
    
    Returns:
    
    section painters list in a most optimal way
  - isEnabled
```
protected boolean isEnabled()
```
    Returns whether or not component is in enabled state.
    
    Returns:
    
    true if component is in enabled state, false otherwise
  - collectDecorationStates
```
protected final java.util.List<java.lang.String> collectDecorationStates()
```
    Returns properly sorted current component decoration states.
    
    Returns:
    
    properly sorted current component decoration states
  - getDecorationStates
```
protected java.util.List<java.lang.String> getDecorationStates()
```
    Returns current component decoration states.
    
    Returns:
    
    current component decoration states
  - usesState
```
protected boolean usesState(java.lang.String state)
```
    Returns whether component has decoration associated with specified state.
    
    Parameters:
    
    state - decoration state
    
    Returns:
    
    true if component has decoration associated with specified state, false otherwise
  - usesState
```
protected final boolean usesState(java.util.List<D> decorations,
                                  java.lang.String state)
```
    Returns whether specified decorations are associated with specified state.
    
    Parameters:
    
    decorations - decorations
    
    state - decoration state
    
    Returns:
    
    true if specified decorations are associated with specified state, false otherwise
  - getDecorations
```
protected java.util.List<D> getDecorations(java.util.List<java.lang.String> forStates)
```
    Returns decorations for the specified states.
    
    Parameters:
    
    forStates - decoration states to retrieve decoration for
    
    Returns:
    
    decorations for the specified states
  - getDecoration
```
protected D getDecoration()
```
    Returns decoration matching current states. Decorations returned here are cached copies of the data presented in skins. This was made to avoid corrupting inital data and to increase the decoration retrieval speed.
    
    Returns:
    
    decoration matching current states
  - updateDecorationState
```
protected void updateDecorationState()
```
    Performs current decoration state update.
  - isDecorated
```
public boolean isDecorated()
```
    Returns whether or not decoration is available.
    
    Returns:
    
    true if decoration is available, false otherwise
  - getBorders
```
public java.awt.Insets getBorders()
```
    Description copied from interface: Painter
    
    Returns borders required for visual data provided by this painter. These borders should not include possible component margin and padding, only borders provided by painter. These borders are added to component's margin and padding when the final component border is calculated. These borders should not take component orientation into account, painter will take care of it later.
    You may pass null in case additional borders aren't needed for this painter.
    
    Specified by:
    
    getBorders in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Overrides:
    
    getBorders in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Returns:
    
    borders required for visual data provided by this painter or null in case those aren't needed
  - provideShape
```
public java.awt.Shape provideShape(E component,
                                   java.awt.Rectangle bounds)
```
    Description copied from interface: PainterShapeProvider
    
    Returns painted component shape.
    
    Specified by:
    
    provideShape in interface PainterShapeProvider<E extends javax.swing.JComponent>
    
    Parameters:
    
    component - component to process
    
    bounds - bounds for painter visual data
    
    Returns:
    
    painted component shape
  - isOpaque
```
public java.lang.Boolean isOpaque()
```
    Description copied from interface: Painter
    
    Returns whether visual data provided by this painter is opaque or not. Returned value might affect component opacity depending on painter support inside that component UI. Simply return null if you don't want to change default component opacity.
    
    Specified by:
    
    isOpaque in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Overrides:
    
    isOpaque in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Returns:
    
    true if visual data provided by this painter is opaque, false otherwise
  - isOpaqueDecorated
```
protected java.lang.Boolean isOpaqueDecorated()
```
    Returns opacity state for decorated component. This is separated from base opacity state method to allow deep customization.
    
    Returns:
    
    opacity state for decorated component
  - isOpaqueUndecorated
```
protected java.lang.Boolean isOpaqueUndecorated()
```
    Returns opacity state for undecorated component. This is separated from base opacity state method to allow deep customization.
    
    Returns:
    
    opacity state for undecorated component
  - paint
```
public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E c,
                  U ui)
```
    Description copied from interface: Painter
    
    Paints visual data using component graphics context. Provided graphics context and component are taken directly from component UI paint method.
    It is highly recommended to honor provided painting bounds to avoid painting issues. These bounds might be representing full component size or contain just a small portion of the component.
    
    Specified by:
    
    paint in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Parameters:
    
    g2d - graphics context
    
    bounds - painting bounds
    
    c - painted component
    
    ui - painted component UI
  - adjustBounds
```
protected java.awt.Rectangle adjustBounds(java.awt.Rectangle bounds)
```
    Returns adjusted painting bounds.
    
    Parameters:
    
    bounds - painting bounds to adjust
    
    Returns:
    
    adjusted painting bounds
  - paintContent
```
protected void paintContent(java.awt.Graphics2D g2d,
                            java.awt.Rectangle bounds,
                            E c,
                            U ui)
```
    Paints content decorated by this painter. todo This method should eventually be removed since all content will be painted by IContent implementations
    
    Parameters:
    
    g2d - graphics context
    
    bounds - painting bounds
    
    c - painted component
    
    ui - painted component UI
  - isPlainBackgroundPaintAllowed
```
protected boolean isPlainBackgroundPaintAllowed(E c)
```
    Returns whether or not painting plain component background is allowed. Moved into separated method for convenient background painting blocking using additional conditions.
    By default this condition is limited to component being opaque. When component is opaque we must fill every single pixel in its bounds with something to avoid issues.
    
    Parameters:
    
    c - component to paint background for
    
    Returns:
    
    true if painting plain component background is allowed, false otherwise
  - isDecorationPaintAllowed
```
protected boolean isDecorationPaintAllowed(D decoration)
```
    Returns whether or not painting specified decoration is allowed. Moved into separated method for convenient decorationg painting blocking using additional conditions.
    By default this condition is limited to decoration existance and visibility.
    
    Parameters:
    
    decoration - decoration to be painted
    
    Returns:
    
    true if painting specified decoration is allowed, false otherwise
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Description copied from interface: Painter
    
    Returns preferred size required for proper painting of visual data provided by this painter. This should not take into account any sizes not related to the painter itself.
    
    Specified by:
    
    getPreferredSize in interface Painter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Overrides:
    
    getPreferredSize in class AbstractPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
    
    Returns:
    
    preferred size required for proper painting of visual data provided by this painter
  - getDecorationSize
```
protected java.awt.Dimension getDecorationSize()
```
    Returns preferred decoration size.
    
    Returns:
    
    preferred decoration size

Class AbstractDecorationPainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI,D extends IDecoration<E,D>>

Field Summary

Fields inherited from class com.alee.painter.AbstractPainter

Constructor Summary

Method Summary

Methods inherited from class com.alee.painter.AbstractPainter

Methods inherited from class java.lang.Object

Field Detail

DECORATION_STATES_PROPERTY

decorations

focusStateTracker

hoverStateTracker

hierarchyTracker

neighboursTracker

states

decorationCache

focused

hover

ancestor

Constructor Detail

AbstractDecorationPainter

Method Detail

install

uninstall

propertyChange

installFocusListener

uninstallFocusListener

isFocused

installHoverListener

uninstallHoverListener

installHierarchyListener

uninstallHierarchyListener

isHover

getSectionPainters

asList

isEnabled

collectDecorationStates

getDecorationStates

usesState

usesState

getDecorations

getDecoration

updateDecorationState

isDecorated

getBorders

provideShape

isOpaque

isOpaqueDecorated

isOpaqueUndecorated

paint

adjustBounds

paintContent

isPlainBackgroundPaintAllowed

isDecorationPaintAllowed

getPreferredSize

getDecorationSize