org.hkijena.jipipe.api.data.thumbnails

Class JIPipeIconLabelThumbnailData

java.lang.Object

org.hkijena.jipipe.api.data.utils.JIPipeSerializedJsonObjectData

org.hkijena.jipipe.api.data.thumbnails.JIPipeIconLabelThumbnailData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, JIPipeThumbnailData

public class JIPipeIconLabelThumbnailData
extends JIPipeSerializedJsonObjectData
implements JIPipeThumbnailData

Constructor Summary

Constructors

Constructor and Description
JIPipeIconLabelThumbnailData(JIPipeIconLabelThumbnailData other)
JIPipeIconLabelThumbnailData(String text, String icon)

Method Summary

Modifier and Type	Method and Description
void	display(String displayName, JIPipeDesktopWorkbench desktopWorkbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
int	getHeight() The height if hasSize() is true Otherwise, will return 0
String	getIcon()
String	getText()
int	getWidth() The width if hasSize() is true Otherwise, will return 0
boolean	hasSize() Returns true if the thumbnail data has a specific size
static JIPipeIconLabelThumbnailData	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)
Component	renderToComponent(int width, int height) Creates a Swing component that represents the thumbnail
void	setIcon(String icon)
void	setText(String text)

Methods inherited from class org.hkijena.jipipe.api.data.utils.JIPipeSerializedJsonObjectData

exportData, importData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.data.thumbnails.JIPipeThumbnailData

createThumbnail

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

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

Constructor Detail

JIPipeIconLabelThumbnailData

public JIPipeIconLabelThumbnailData(String text,
                                    String icon)

JIPipeIconLabelThumbnailData

public JIPipeIconLabelThumbnailData(JIPipeIconLabelThumbnailData other)

Method Detail

importData

public static JIPipeIconLabelThumbnailData importData(JIPipeReadDataStorage storage,
                                                      JIPipeProgressInfo progressInfo)

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Overrides:

duplicate in class JIPipeSerializedJsonObjectData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

display

public void display(String displayName,
                    JIPipeDesktopWorkbench desktopWorkbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Specified by:

display in interface JIPipeData

Parameters:

displayName - a name that can be used

desktopWorkbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

getText

public String getText()

setText

public void setText(String text)

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

renderToComponent

public Component renderToComponent(int width,
                                   int height)

Description copied from interface: JIPipeThumbnailData

Creates a Swing component that represents the thumbnail

Specified by:

renderToComponent in interface JIPipeThumbnailData

Parameters:

width - the requested width of the swing component

height - the requested height of the swing component

Returns:

the component

hasSize

public boolean hasSize()

Description copied from interface: JIPipeThumbnailData

Returns true if the thumbnail data has a specific size

Specified by:

hasSize in interface JIPipeThumbnailData

Returns:

if the thumbnail data has a specific size

getWidth

public int getWidth()

Description copied from interface: JIPipeThumbnailData

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

Specified by:

getWidth in interface JIPipeThumbnailData

Returns:

the width or 0

getHeight

public int getHeight()

Description copied from interface: JIPipeThumbnailData

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

Specified by:

getHeight in interface JIPipeThumbnailData

Returns:

the height or 0