org.hkijena.jipipe.api.data.thumbnails

Interface JIPipeThumbnailData

All Superinterfaces:

AutoCloseable, Closeable, JIPipeData

All Known Implementing Classes:

JIPipeEmptyThumbnailData, JIPipeGridThumbnailData, JIPipeIconLabelThumbnailData, JIPipeImageThumbnailData, JIPipeTextThumbnailData

public interface JIPipeThumbnailData
extends JIPipeData

Method Summary

Modifier and Type	Method and Description
default JIPipeThumbnailData	createThumbnail(int width, int height, JIPipeProgressInfo progressInfo) This function generates a thumbnail for this data Can return null
int	getHeight() The height if hasSize() is true Otherwise, will return 0
int	getWidth() The width if hasSize() is true Otherwise, will return 0
boolean	hasSize() Returns true if the thumbnail data has a specific size
Component	renderToComponent(int width, int height) Creates a Swing component that represents the thumbnail

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeData

close, duplicate, exportData, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, preview, toDetailedString

Method Detail

renderToComponent

Component renderToComponent(int width,
                            int height)

Creates a Swing component that represents the thumbnail

Parameters:

width - the requested width of the swing component

height - the requested height of the swing component

Returns:

the component

hasSize

boolean hasSize()

Returns true if the thumbnail data has a specific size

Returns:

if the thumbnail data has a specific size

getWidth

int getWidth()

The width if hasSize() is true Otherwise, will return 0

Returns:

the width or 0

getHeight

int getHeight()

The height if hasSize() is true Otherwise, will return 0

Returns:

the height or 0

createThumbnail

default JIPipeThumbnailData createThumbnail(int width,
                                            int height,
                                            JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

This function generates a thumbnail for this data Can return null

Specified by:

createThumbnail in interface JIPipeData

Parameters:

width - the width

height - the height

progressInfo - the progress info

Returns:

the thumbnail or null