com.alee.laf.progressbar

Class ProgressBarPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

java.lang.Object

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

com.alee.painter.decoration.AbstractDecorationPainter<C,U,D>

com.alee.laf.progressbar.ProgressBarPainter<C,U,D>

Type Parameters:

C - component type

U - component UI type

D - decoration type

All Implemented Interfaces:

IProgressBarPainter<C,U>, PainterShapeProvider<C>, IDecorationPainter<C,U,D>, Painter<C,U>, SpecificPainter<C,U>, EventListener, ChangeListener

public class ProgressBarPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>
extends AbstractDecorationPainter<C,U,D>
implements IProgressBarPainter<C,U>, ChangeListener

Basic painter for JProgressBar component. It is used as WProgressBarUI default painter.

Author:

Alexandr Zernov, Mikle Garin

Field Summary

Fields

Modifier and Type	Field and Description
protected Dimension	minimumContentSize Style settings.
protected IProgressPainter	progressPainter Progress line painter.
protected IProgressTextPainter	progressTextPainter Progress text painter.
protected int	value Cached last progress bar value.

Fields inherited from class com.alee.painter.decoration.AbstractDecorationPainter

ancestor, containerListener, current, DECORATION_BORDER_PROPERTY, DECORATION_STATES_PROPERTY, decorationCache, decorations, focused, focusStateTracker, hierarchyTracker, hover, hoverStateTracker, inFocusedParent, inFocusedParentAncestorListener, inFocusedParentTracker, inHoveredParent, inHoveredParentAncestorListener, inHoveredParentTracker, neighboursTracker, stateDecorationCache, states

Fields inherited from class com.alee.painter.AbstractPainter

component, installed, ltr, propertyChangeListener, sectionPainters, ui

Constructor Summary

Constructors

Constructor and Description
ProgressBarPainter()

Method Summary

Modifier and Type	Method and Description
List<String>	getDecorationStates() Returns current component decoration states.
protected Dimension	getMinimumContentSize() Returns minimum content area size.
Dimension	getPreferredSize() Returns preferred size required for proper painting of the view provided by this painter.
protected List<SectionPainter<C,U>>	getSectionPainters() Returns SectionPainters used by this painter or null if none are used.
protected void	installProgressBarValueListeners() Installs custom JProgressBar value listeners which will perform decoration state updates when needed.
protected void	installPropertiesAndListeners() Installs properties and listeners used by this Painter implementation.
protected boolean	isHorizontal() Returns whether or not progress bar is horizontal.
protected void	paintContent(Graphics2D g2d, C c, U ui, Rectangle bounds) Paints additional custom content provided by this painter.
protected void	paintProgress(Graphics2D g2d, Rectangle bounds) Paints progress line.
protected void	paintText(Graphics2D g2d, Rectangle bounds) Paints progress bar text.
protected void	propertyChanged(String property, Object oldValue, Object newValue) Informs about AbstractPainter.component property change.
void	stateChanged(ChangeEvent e)
protected void	uninstallProgressBarValueListeners() Uninstalls custom JProgressBar value listeners.
protected void	uninstallPropertiesAndListeners() Uninstalls properties and listeners used by this Painter implementation.

Methods inherited from class com.alee.painter.decoration.AbstractDecorationPainter

afterInstall, afterUninstall, beforeUninstall, childrenChanged, collectDecorationStates, contains, deactivateLastDecoration, focusChanged, getBaseline, getBaselineResizeBehavior, getBorder, getDecoration, getDecorations, getDecorationsKey, hierarchyChanged, hoverChanged, installBorderListeners, installChildrenListeners, installFocusListeners, installHoverListeners, installInFocusedParentListeners, installInHoveredParentListeners, isDecorationAvailable, isEnabled, isFocused, isHover, isInFocusedParent, isInHoveredParent, isOpaque, isOpaqueDecorated, isOpaqueUndecorated, isPlainBackgroundRequired, orientationChange, paint, provideShape, uninstallBorderListeners, uninstallChildrenListeners, uninstallFocusListeners, uninstallHoverListeners, uninstallInFocusedParentListeners, uninstallInHoveredParentListeners, updateDecorationState, updateFocusListeners, updateHoverListeners, updateInFocusedParent, updateInHoveredParent, usesContainerView, usesFocusedView, usesHierarchyBasedView, usesHoverView, usesInFocusedParentView, usesInHoveredParentView, usesState, usesState

Methods inherited from class com.alee.painter.AbstractPainter

asList, beforeInstall, borderChange, getCompleteBorder, getInstalledSectionPainters, install, installPropertyChangeListener, installSectionPainter, installSectionPainters, isInstalled, isSectionPainter, isSettingsUpdateAllowed, paintSection, repaint, repaint, repaint, revalidate, saveOrientation, uninstall, uninstallPropertyChangeListener, uninstallSectionPainter, uninstallSectionPainters, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.alee.painter.Painter

contains, getBaseline, getBaselineResizeBehavior, install, isInstalled, isOpaque, paint, uninstall

Field Detail

minimumContentSize

protected Dimension minimumContentSize

Style settings. todo Replace with general getMinimumSize method in painters

progressPainter

@DefaultPainter(value=ProgressPainter.class)
protected IProgressPainter progressPainter

Progress line painter.

progressTextPainter

@DefaultPainter(value=ProgressTextPainter.class)
protected IProgressTextPainter progressTextPainter

Progress text painter.

value

protected transient int value

Cached last progress bar value.

Constructor Detail

ProgressBarPainter

public ProgressBarPainter()

Method Detail

getSectionPainters

@Nullable
protected List<SectionPainter<C,U>> getSectionPainters()

Description copied from class: AbstractPainter

Returns SectionPainters used by this painter or null if none are used. Do not return any null SectionPainters here, it will cause an exception. You can use AbstractPainter.asList(SectionPainter[]) method to conveniently form a list filtering out nulls.

Overrides:

getSectionPainters in class AbstractPainter<C extends JProgressBar,U extends WProgressBarUI>

Returns:

SectionPainters used by this painter or null if none are used

installPropertiesAndListeners

protected void installPropertiesAndListeners()

Description copied from class: AbstractPainter

Installs properties and listeners used by this Painter implementation. Override this method instead of AbstractPainter.install(JComponent, ComponentUI) to install additional properties and listeners.

Overrides:

installPropertiesAndListeners in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

uninstallPropertiesAndListeners

protected void uninstallPropertiesAndListeners()

Description copied from class: AbstractPainter

Uninstalls properties and listeners used by this Painter implementation. Override this method instead of AbstractPainter.uninstall(JComponent, ComponentUI) to uninstall additional properties and listeners.

Overrides:

uninstallPropertiesAndListeners in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

propertyChanged

protected void propertyChanged(@NotNull
                               String property,
                               @Nullable
                               Object oldValue,
                               @Nullable
                               Object newValue)

Description copied from class: AbstractPainter

Informs about AbstractPainter.component property change.

Overrides:

propertyChanged in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

Parameters:

property - modified property

oldValue - old property value

newValue - new property value

installProgressBarValueListeners

protected void installProgressBarValueListeners()

Installs custom JProgressBar value listeners which will perform decoration state updates when needed.

uninstallProgressBarValueListeners

protected void uninstallProgressBarValueListeners()

Uninstalls custom JProgressBar value listeners.

stateChanged

public void stateChanged(@NotNull
                         ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

getDecorationStates

@NotNull
public List<String> getDecorationStates()

Description copied from interface: IDecorationPainter

Returns current component decoration states. This method shouldn't cache states internally to avoid update issues. That is why it is important to avoid any heavy operations within this method.

Specified by:

getDecorationStates in interface IDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

Overrides:

getDecorationStates in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

Returns:

current component decoration states

paintContent

protected void paintContent(@NotNull
                            Graphics2D g2d,
                            @NotNull
                            C c,
                            @NotNull
                            U ui,
                            @NotNull
                            Rectangle bounds)

Description copied from class: AbstractDecorationPainter

Paints additional custom content provided by this painter. todo This might eventually be removed if all contents will be painted within IContent implementations

Overrides:

paintContent in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

Parameters:

g2d - graphics context

c - painted component

ui - painted component UI

bounds - painting bounds

paintProgress

protected void paintProgress(@NotNull
                             Graphics2D g2d,
                             @NotNull
                             Rectangle bounds)

Paints progress line.

Parameters:

g2d - graphics context

bounds - painting bounds

paintText

protected void paintText(@NotNull
                         Graphics2D g2d,
                         @NotNull
                         Rectangle bounds)

Paints progress bar text.

Parameters:

g2d - graphics context

bounds - painting bounds

getMinimumContentSize

@NotNull
protected Dimension getMinimumContentSize()

Returns minimum content area size.

Returns:

minimum content area size

isHorizontal

protected boolean isHorizontal()

Returns whether or not progress bar is horizontal.

Returns:

true if progress bar is horizontal, false otherwise

getPreferredSize

@NotNull
public Dimension getPreferredSize()

Description copied from interface: Painter

Returns preferred size required for proper painting of the view provided by this painter. This should not take into account any sizes not related to the painter itself.

Specified by:

getPreferredSize in interface Painter<C extends JProgressBar,U extends WProgressBarUI>

Overrides:

getPreferredSize in class AbstractDecorationPainter<C extends JProgressBar,U extends WProgressBarUI,D extends IDecoration<C,D>>

Returns:

preferred size required for proper painting of the view provided by this painter