org.knime.core.node.workflow

Class AnnotationData

java.lang.Object

org.knime.core.node.workflow.AnnotationData

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

NodeAnnotationData

public class AnnotationData
extends Object
implements Cloneable

Author:

Bernd Wiswedel, KNIME.com, Zurich, Switzerland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationData.StyleRange Formatting rule on the text; similar to SWT style range.
static class	AnnotationData.TextAlignment Text alignment in annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION_20151012 Released with 3.0 - uses (almost) same fonts on all systems.
static int	VERSION_20151123 Released with 3.1: store default font size in annotation.
static int	VERSION_OLD Old type annotation - font is system font (inconsistent layout).

Constructor Summary

Constructors

Constructor and Description
AnnotationData()

Method Summary

Modifier and Type	Method and Description
AnnotationData	clone()
void	copyFrom(AnnotationData otherData, boolean includeBounds) Copy content, styles, position from the argument.
boolean	equals(Object obj)
AnnotationData.TextAlignment	getAlignment()
int	getBgColor()
int	getBorderColor()
int	getBorderSize()
int	getDefaultFontSize() Return the default font size for this annotation, or -1 if size from pref page should be used.
int	getHeight()
AnnotationData.StyleRange[]	getStyleRanges()
String	getText()
int	getVersion() Save-Version of this annotation.
int	getWidth()
int	getX()
int	getY()
int	hashCode()
void	load(NodeSettingsRO config, FileWorkflowPersistor.LoadVersion loadVersion) loads new values.
void	save(NodeSettingsWO config) Save all data.
void	setAlignment(AnnotationData.TextAlignment alignment)
void	setBgColor(int bgColor)
void	setBorderColor(int color)
void	setBorderSize(int size)
void	setDefaultFontSize(int size) Set the default font size for this annotation.
void	setDimension(int x, int y, int width, int height) Set dimensionality.
void	setHeight(int height)
void	setStyleRanges(AnnotationData.StyleRange[] styleRanges)
void	setText(String text)
void	setWidth(int width)
void	setX(int x)
void	setY(int y)
void	shiftPosition(int xOff, int yOff) Shift annotation after copy&paste.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VERSION_OLD

public static final int VERSION_OLD

Old type annotation - font is system font (inconsistent layout).

Since:

3.0

See Also:

Constant Field Values

VERSION_20151012

public static final int VERSION_20151012

Released with 3.0 - uses (almost) same fonts on all systems.

Since:

3.0

See Also:

Constant Field Values

VERSION_20151123

public static final int VERSION_20151123

Released with 3.1: store default font size in annotation.

Since:

3.1

See Also:

Constant Field Values

Constructor Detail

AnnotationData

public AnnotationData()

Method Detail

getText

public final String getText()

Returns:

the text

setText

public final void setText(String text)

Parameters:

text - the text to set

getStyleRanges

public final AnnotationData.StyleRange[] getStyleRanges()

Returns:

the styleRanges

setStyleRanges

public final void setStyleRanges(AnnotationData.StyleRange[] styleRanges)

Parameters:

styleRanges - the styleRanges to set

getBgColor

public final int getBgColor()

Returns:

the bgColor

setBgColor

public final void setBgColor(int bgColor)

Parameters:

bgColor - the bgColor to set

getX

public final int getX()

Returns:

the x

setX

public final void setX(int x)

Parameters:

x - the x to set

getY

public final int getY()

Returns:

the y

setY

public final void setY(int y)

Parameters:

y - the y to set

getWidth

public final int getWidth()

Returns:

the width

setWidth

public final void setWidth(int width)

Parameters:

width - the width to set

getHeight

public final int getHeight()

Returns:

the height

setHeight

public final void setHeight(int height)

Parameters:

height - the height to set

setAlignment

public final void setAlignment(AnnotationData.TextAlignment alignment)

Parameters:

alignment - the alignment to set

getAlignment

public final AnnotationData.TextAlignment getAlignment()

Returns:

the alignment

getBorderSize

public final int getBorderSize()

Returns:

the border width. 0 or neg. for no border.

Since:

3.0

setBorderSize

public final void setBorderSize(int size)

Parameters:

size - border size in pixel, 0 or neg. for no border.

Since:

3.0

getBorderColor

public final int getBorderColor()

Returns:

the color of the border. See also getBorderSize().

Since:

3.0

setBorderColor

public final void setBorderColor(int color)

Parameters:

color - the new border color to set.

Since:

3.0

shiftPosition

public final void shiftPosition(int xOff,
                                int yOff)

Shift annotation after copy&paste.

Parameters:

xOff - x offset

yOff - y offset

getVersion

public final int getVersion()

Save-Version of this annotation. "Old" annotations used the system default font, newer ones will use hardcoded font families.

Returns:

the version, usually one of AnnotationData#VERSION_XYZ.

Since:

3.0

setDimension

public final void setDimension(int x,
                               int y,
                               int width,
                               int height)

Set dimensionality.

Parameters:

x - x-coordinate

y - y-coordinate

width - width of component

height - height of component

setDefaultFontSize

public final void setDefaultFontSize(int size)

Set the default font size for this annotation.

Parameters:

size - new default size

Since:

3.1

getDefaultFontSize

public final int getDefaultFontSize()

Return the default font size for this annotation, or -1 if size from pref page should be used. (For old versions only.)

Returns:

the default font size for this annotation, or -1 if size from pref page should be used

Since:

3.1

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copyFrom

public void copyFrom(AnnotationData otherData,
                     boolean includeBounds)

Copy content, styles, position from the argument.

Parameters:

otherData - To copy from.

includeBounds - Whether to also update x, y, width, height. If false, it will only a copy the text with its styles

clone

public AnnotationData clone()

Overrides:

clone in class Object

save

public void save(NodeSettingsWO config)

Save all data.

Parameters:

config - To save to.

load

public void load(NodeSettingsRO config,
                 FileWorkflowPersistor.LoadVersion loadVersion)
          throws InvalidSettingsException

loads new values.

Parameters:

config - To load from

loadVersion - Version to load

Throws:

InvalidSettingsException - If fails