Package org.pushingpixels.substance.api.painter.preview

Class DefaultPreviewPainter

java.lang.Object

org.pushingpixels.substance.api.painter.preview.PreviewPainter

org.pushingpixels.substance.api.painter.preview.DefaultPreviewPainter

public class DefaultPreviewPainter
extends PreviewPainter

Default implementation of the component preview painter. The component preview is a scaled-down (as necessary) thumbnail of the relevant component.

Constructor Summary

Constructors

Constructor	Description
DefaultPreviewPainter()

Method Summary

Modifier and Type	Method	Description
java.awt.Dimension	getPreviewWindowDimension(java.awt.Container parent, java.awt.Component component, int componentIndex)	Returns the dimension for the component preview window.
boolean	hasPreview(java.awt.Container parent, java.awt.Component component, int componentIndex)	Checks whether the specified component is previewable.
boolean	hasPreviewWindow(java.awt.Container parent, java.awt.Component component, int componentIndex)	Checks whether the specified component has a preview window.
void	previewComponent(java.awt.Container parent, java.awt.Component component, int componentIndex, java.awt.Graphics g, int x, int y, int w, int h)	Draws a component preview on the specified graphics.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.pushingpixels.substance.api.painter.preview.PreviewPainter

getPreviewWindowExtraDelay, getUpdateCycle, toUpdatePeriodically

Constructor Detail

DefaultPreviewPainter

public DefaultPreviewPainter()

Method Detail

hasPreview

public boolean hasPreview(java.awt.Container parent,
                          java.awt.Component component,
                          int componentIndex)

Description copied from class: PreviewPainter

Checks whether the specified component is previewable.

Overrides:

hasPreview in class PreviewPainter

Parameters:

parent - Component parent. May be null.

component - Component. May be null.

componentIndex - Component index in its parent. May be negative.

Returns:

true if the specified component is previewable, false otherwise.

previewComponent

public void previewComponent(java.awt.Container parent,
                             java.awt.Component component,
                             int componentIndex,
                             java.awt.Graphics g,
                             int x,
                             int y,
                             int w,
                             int h)

Description copied from class: PreviewPainter

Draws a component preview on the specified graphics.

Overrides:

previewComponent in class PreviewPainter

Parameters:

parent - Component parent. May be null.

component - Component. May be null.

componentIndex - Component index in its parent. May be negative.

g - Graphics context.

x - X coordinate of the preview area.

y - Y coordinate of the preview area.

w - Width of the preview area.

h - Height of the preview area.

hasPreviewWindow

public boolean hasPreviewWindow(java.awt.Container parent,
                                java.awt.Component component,
                                int componentIndex)

Description copied from class: PreviewPainter

Checks whether the specified component has a preview window.

Overrides:

hasPreviewWindow in class PreviewPainter

Parameters:

parent - Component parent. May be null.

component - Component. May be null.

componentIndex - Component index in its parent. May be negative.

Returns:

true if the specified component has a preview window, false otherwise.

getPreviewWindowDimension

public java.awt.Dimension getPreviewWindowDimension(java.awt.Container parent,
                                                    java.awt.Component component,
                                                    int componentIndex)

Description copied from class: PreviewPainter

Returns the dimension for the component preview window.

Overrides:

getPreviewWindowDimension in class PreviewPainter

Parameters:

parent - Component parent. May be null.

component - Component. May be null.

componentIndex - Component index in its parent. May be negative.

Returns:

Dimension of the component preview window.