com.alee.painter.common

Class NinePatchStatePainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.painter.common.NinePatchStatePainter<E,U>

Type Parameters:

E - component type

All Implemented Interfaces:

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

public class NinePatchStatePainter<E extends javax.swing.JComponent,U extends javax.swing.plaf.ComponentUI>
extends AbstractPainter<E,U>

This painter class allows you to specify multiply 9-patch images for different component states. By default there is support for some standard Swing component states like buttons.

See Also:

NinePatchState, NinePatchIcon, NinePatchIconPainter, AbstractPainter, Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,NinePatchIcon>	stateIcons Map containing separate 9-patch icons for different component states.

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
NinePatchStatePainter() Constructs new 9-patch state painter with empty states.
NinePatchStatePainter(java.util.Map<java.lang.String,NinePatchIcon> stateIcons) Constructs new 9-patch state painter with specified state icons.

Method Summary

Modifier and Type	Method and Description
void	addStateIcon(java.lang.String state, NinePatchIcon ninePatchIcon) Adds painter state.
java.awt.Insets	getBorders() Returns borders required for visual data provided by this painter.
protected NinePatchIcon	getButtonBackground(javax.swing.AbstractButton button) Returns current state icon for the specified button.
protected NinePatchIcon	getComponentBackground(E component) Returns current state icon for the specified component.
NinePatchIcon	getExactStateIcon(java.lang.String state) Returns exact state icon or null if it is not specified.
java.awt.Dimension	getPreferredSize() Returns preferred size required for proper painting of visual data provided by this painter.
NinePatchIcon	getStateIcon(java.lang.String state) Returns state icon or possible replacement for it.
java.util.Map<java.lang.String,NinePatchIcon>	getStateIcons() Returns states map.
protected NinePatchIcon	getToolBarBackground(javax.swing.JToolBar toolbar) Returns current state icon for the specified toolbar.
boolean	hasStateIcons() Returns whether at least one state icon is available or not.
protected boolean	isFocused(E component) Returns whether component is in focused state or not.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints visual data using component graphics context.
void	removeStateIcon(java.lang.String state) Removes painter state.
void	setStateIcons(java.util.Map<java.lang.String,NinePatchIcon> stateIcons) Sets states map.

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getCompleteBorder, i, i, i, install, installPropertyChangeListener, isOpaque, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, propertyChange, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstall, 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

stateIcons

protected java.util.Map<java.lang.String,NinePatchIcon> stateIcons

Map containing separate 9-patch icons for different component states.

Constructor Detail

NinePatchStatePainter

public NinePatchStatePainter()

Constructs new 9-patch state painter with empty states.

NinePatchStatePainter

public NinePatchStatePainter(java.util.Map<java.lang.String,NinePatchIcon> stateIcons)

Constructs new 9-patch state painter with specified state icons.

Parameters:

stateIcons - state icons map

Method Detail

getStateIcons

public java.util.Map<java.lang.String,NinePatchIcon> getStateIcons()

Returns states map.

Returns:

states map

setStateIcons

public void setStateIcons(java.util.Map<java.lang.String,NinePatchIcon> stateIcons)

Sets states map.

Parameters:

stateIcons - states map

addStateIcon

public void addStateIcon(java.lang.String state,
                         NinePatchIcon ninePatchIcon)

Adds painter state.

Parameters:

state - state to add

ninePatchIcon - 9-patch icon

removeStateIcon

public void removeStateIcon(java.lang.String state)

Removes painter state.

Parameters:

state - state to remove

hasStateIcons

public boolean hasStateIcons()

Returns whether at least one state icon is available or not.

Returns:

true if at least one state icon is available, false otherwise

isFocused

protected boolean isFocused(E component)

Returns whether component is in focused state or not.

Parameters:

component - component to process

Returns:

true if component is in focused state, false otherwise

getComponentBackground

protected NinePatchIcon getComponentBackground(E component)

Returns current state icon for the specified component.

Parameters:

component - component to process

Returns:

current state icon

getButtonBackground

protected NinePatchIcon getButtonBackground(javax.swing.AbstractButton button)

Returns current state icon for the specified button.

Parameters:

button - button to process

Returns:

current state icon

getToolBarBackground

protected NinePatchIcon getToolBarBackground(javax.swing.JToolBar toolbar)

Returns current state icon for the specified toolbar.

Parameters:

toolbar - toolbar to process

Returns:

current state icon

getExactStateIcon

public NinePatchIcon getExactStateIcon(java.lang.String state)

Returns exact state icon or null if it is not specified.

Parameters:

state - component state

Returns:

exact state icon or null if it is not specified

getStateIcon

public NinePatchIcon getStateIcon(java.lang.String state)

Returns state icon or possible replacement for it.

Parameters:

state - component state

Returns:

state icon or possible replacement for it

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

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.

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

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