org.jvnet.substance.title
Class BaseHeaderPainter

java.lang.Object
  extended by org.jvnet.substance.title.BaseHeaderPainter
All Implemented Interfaces:
SubstanceHeaderPainter, SubstanceTitlePainter, SubstanceTrait
Direct Known Subclasses:
ArcHeaderPainter, ImageWrapperHeaderPainter, MatteHeaderPainter

public abstract class BaseHeaderPainter
extends java.lang.Object
implements SubstanceHeaderPainter

Author:
Kirill Grouchnikov

Field Summary
protected  boolean isPaintingGeneralDecorationAreas
          Indicates whether this painter is used to paint the background of general decoration areas.
protected  boolean isPaintingToolbars
          Indicates whether this painter is used to paint the toolbar background.
 
Constructor Summary
BaseHeaderPainter()
          Creates a new header painter that is used to paint title panes, menubars and toolbars.
BaseHeaderPainter(boolean isPaintingToolbars, boolean isPaintingGeneralDecorationAreas)
          Creates a new header painter
 
Method Summary
 boolean isPaintingContainer(java.awt.Container cont)
          Returns indication whether this painter is used to paint the background of the specified container.
 boolean isPaintingToolbarDropShadows()
          Returns indication whether this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter (that is, this method is relevant only when #isPaintingContainer() returns false when called with JToolBar parameter).
 void setPaintingGeneralDecorationAreas(boolean isPaintingGeneralDecorationAreas)
          Sets indication whether this painter is used to paint the general decoration areas.
 void setPaintingToolbarDropShadows(boolean isPaintingToolbarDropShadows)
          Sets indication whether this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter.
 void setPaintingToolbars(boolean isPaintingToolbars)
          Sets indication whether this painter is used to paint the toolbar background.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jvnet.substance.title.SubstanceHeaderPainter
getSecondaryPainter, paintExtraBackground
 
Methods inherited from interface org.jvnet.substance.title.SubstanceTitlePainter
getDisplayName, paintTitleBackground
 

Field Detail

isPaintingToolbars

protected boolean isPaintingToolbars
Indicates whether this painter is used to paint the toolbar background.


isPaintingGeneralDecorationAreas

protected boolean isPaintingGeneralDecorationAreas
Indicates whether this painter is used to paint the background of general decoration areas.

Constructor Detail

BaseHeaderPainter

public BaseHeaderPainter()
Creates a new header painter that is used to paint title panes, menubars and toolbars.


BaseHeaderPainter

public BaseHeaderPainter(boolean isPaintingToolbars,
                         boolean isPaintingGeneralDecorationAreas)
Creates a new header painter

Parameters:
isPaintingToolbars - If true, this painter will be used to paint toolbars in addition to painting title panes and menubars.
isPaintingGeneralDecorationAreas - If true, this painter will be used to paint additional general decoration areas.
Method Detail

isPaintingContainer

public boolean isPaintingContainer(java.awt.Container cont)
Description copied from interface: SubstanceHeaderPainter
Returns indication whether this painter is used to paint the background of the specified container.

Specified by:
isPaintingContainer in interface SubstanceHeaderPainter
Parameters:
cont - Container.
Returns:
true if this painter is used to paint the background of the specified container, false otherwise.

isPaintingToolbarDropShadows

public boolean isPaintingToolbarDropShadows()
Description copied from interface: SubstanceHeaderPainter
Returns indication whether this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter (that is, this method is relevant only when #isPaintingContainer() returns false when called with JToolBar parameter).

Specified by:
isPaintingToolbarDropShadows in interface SubstanceHeaderPainter
Returns:
true if this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter, false otherwise.

setPaintingToolbarDropShadows

public void setPaintingToolbarDropShadows(boolean isPaintingToolbarDropShadows)
Sets indication whether this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter.

Parameters:
isPaintingToolbarDropShadows - Indication whether this painter will cause drop shadows to appear on the top portion of the toolbars that are not painted by this painter.

setPaintingToolbars

public void setPaintingToolbars(boolean isPaintingToolbars)
Sets indication whether this painter is used to paint the toolbar background.

Parameters:
isPaintingToolbars - Indication whether this painter is used to paint the toolbar background.

setPaintingGeneralDecorationAreas

public void setPaintingGeneralDecorationAreas(boolean isPaintingGeneralDecorationAreas)
Sets indication whether this painter is used to paint the general decoration areas.

Parameters:
isPaintingGeneralDecorationAreas - Indication whether this painter is used to paint the general decoration areas.