org.pentaho.di.core
Class NotePadMeta

java.lang.Object
  org.pentaho.di.core.NotePadMeta

All Implemented Interfaces:

Cloneable, GUIPositionInterface, GUISizeInterface, XMLInterface

public class NotePadMeta
extends Object
implements Cloneable, XMLInterface, GUIPositionInterface, GUISizeInterface

Describes a note displayed on a Transformation, Job, Schema, or Report.

Since:

28-11-2003

Author:

Matt

Field Summary

static int	COLOR_RGB_BLACK_BLUE
static int	COLOR_RGB_BLACK_GREEN
static int	COLOR_RGB_BLACK_RED
static int	COLOR_RGB_DEFAULT_BG_BLUE
static int	COLOR_RGB_DEFAULT_BG_GREEN
static int	COLOR_RGB_DEFAULT_BG_RED
static int	COLOR_RGB_DEFAULT_BORDER_BLUE
static int	COLOR_RGB_DEFAULT_BORDER_GREEN
static int	COLOR_RGB_DEFAULT_BORDER_RED
int	height
int	width
static String	XML_TAG

Constructor Summary

NotePadMeta()

NotePadMeta(Node notepadnode)

NotePadMeta(String n, int xl, int yl, int w, int h)

NotePadMeta(String n, int xl, int yl, int w, int h, String fontname, int fontsize, boolean fontbold, boolean fontitalic, int fontColorRed, int fontColorGreen, int fontColorBlue, int backGrounColorRed, int backGrounColorGreen, int backGrounColorBlue, int borderColorRed, int borderColorGreen, int borderColorBlue, boolean drawshadow)

Method Summary

Object	clone()
void	flipSelected() Change a selected state to not-selected and vice-versa.
int	getBackGroundColorBlue()
int	getBackGroundColorGreen()
int	getBackGroundColorRed()
int	getBorderColorBlue()
int	getBorderColorGreen()
int	getBorderColorRed()
int	getFontColorBlue()
int	getFontColorGreen()
int	getFontColorRed()
String	getFontName()
int	getFontSize()
int	getHeight()
Point	getLocation()
String	getNote()
ObjectId	getObjectId()
int	getWidth()
String	getXML() Describes the Object implementing this interface as XML
boolean	hasChanged()
boolean	isDrawShadow() Change a drawshadow state
boolean	isFontBold()
boolean	isFontItalic()
boolean	isSelected()
void	setBackGroundColorBlue(int blue)
void	setBackGroundColorGreen(int green)
void	setBackGroundColorRed(int red)
void	setBorderColorBlue(int blue)
void	setBorderColorGreen(int green)
void	setBorderColorRed(int red)
void	setChanged()
void	setChanged(boolean ch)
void	setDrawShadow(boolean drawshadow)
void	setFontBold(boolean fontbold)
void	setFontColorBlue(int blue)
void	setFontColorGreen(int green)
void	setFontColorRed(int red)
void	setFontItalic(boolean fontitalic)
void	setFontName(String fontname)
void	setFontSize(int fontsize)
void	setHeight(int height)
void	setLocation(int x, int y)
void	setLocation(Point p)
void	setNote(String note)
void	setObjectId(ObjectId id)
void	setSelected(boolean selected)
void	setWidth(int width)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

XML_TAG

public static final String XML_TAG

See Also:

Constant Field Values

COLOR_RGB_BLACK_RED

public static final int COLOR_RGB_BLACK_RED

See Also:

Constant Field Values

COLOR_RGB_BLACK_GREEN

public static final int COLOR_RGB_BLACK_GREEN

See Also:

Constant Field Values

COLOR_RGB_BLACK_BLUE

public static final int COLOR_RGB_BLACK_BLUE

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BG_RED

public static final int COLOR_RGB_DEFAULT_BG_RED

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BG_GREEN

public static final int COLOR_RGB_DEFAULT_BG_GREEN

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BG_BLUE

public static final int COLOR_RGB_DEFAULT_BG_BLUE

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BORDER_RED

public static final int COLOR_RGB_DEFAULT_BORDER_RED

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BORDER_GREEN

public static final int COLOR_RGB_DEFAULT_BORDER_GREEN

See Also:

Constant Field Values

COLOR_RGB_DEFAULT_BORDER_BLUE

public static final int COLOR_RGB_DEFAULT_BORDER_BLUE

See Also:

Constant Field Values

width

public int width

height

public int height

Constructor Detail

NotePadMeta

public NotePadMeta()

NotePadMeta

public NotePadMeta(String n,
                   int xl,
                   int yl,
                   int w,
                   int h)

NotePadMeta

public NotePadMeta(String n,
                   int xl,
                   int yl,
                   int w,
                   int h,
                   String fontname,
                   int fontsize,
                   boolean fontbold,
                   boolean fontitalic,
                   int fontColorRed,
                   int fontColorGreen,
                   int fontColorBlue,
                   int backGrounColorRed,
                   int backGrounColorGreen,
                   int backGrounColorBlue,
                   int borderColorRed,
                   int borderColorGreen,
                   int borderColorBlue,
                   boolean drawshadow)

NotePadMeta

public NotePadMeta(Node notepadnode)
            throws KettleXMLException

Throws:

KettleXMLException

Method Detail

getObjectId

public ObjectId getObjectId()

setObjectId

public void setObjectId(ObjectId id)

setLocation

public void setLocation(int x,
                        int y)

Specified by:

setLocation in interface GUIPositionInterface

setLocation

public void setLocation(Point p)

Specified by:

setLocation in interface GUIPositionInterface

getLocation

public Point getLocation()

Specified by:

getLocation in interface GUIPositionInterface

getNote

public String getNote()

Returns:

Returns the note.

setNote

public void setNote(String note)

Parameters:

note - The note to set.

setBorderColorRed

public void setBorderColorRed(int red)

Parameters:

green - the border red color.

setBorderColorGreen

public void setBorderColorGreen(int green)

Parameters:

green - the border color green.

setBorderColorBlue

public void setBorderColorBlue(int blue)

Parameters:

green - the border blue color.

setBackGroundColorRed

public void setBackGroundColorRed(int red)

setBackGroundColorGreen

public void setBackGroundColorGreen(int green)

setBackGroundColorBlue

public void setBackGroundColorBlue(int blue)

setFontColorRed

public void setFontColorRed(int red)

Parameters:

Returns - the font color red.

setFontColorGreen

public void setFontColorGreen(int green)

Parameters:

Returns - the font color green.

setFontColorBlue

public void setFontColorBlue(int blue)

Parameters:

Returns - the font color blue.

isSelected

public boolean isSelected()

Specified by:

isSelected in interface GUIPositionInterface

Returns:

Returns the selected.

setSelected

public void setSelected(boolean selected)

Specified by:

setSelected in interface GUIPositionInterface

Parameters:

selected - The selected to set.

flipSelected

public void flipSelected()

Change a selected state to not-selected and vice-versa.

setDrawShadow

public void setDrawShadow(boolean drawshadow)

Parameters:

drawshadow - The drawshadow to set.

isDrawShadow

public boolean isDrawShadow()

Change a drawshadow state

clone

public Object clone()

Overrides:

clone in class Object

setChanged

public void setChanged()

setChanged

public void setChanged(boolean ch)

hasChanged

public boolean hasChanged()

toString

public String toString()

Overrides:

toString in class Object

getXML

public String getXML()

Description copied from interface: XMLInterface

Describes the Object implementing this interface as XML

Specified by:

getXML in interface XMLInterface

Returns:

the XML string for this object

getHeight

public int getHeight()

Specified by:

getHeight in interface GUISizeInterface

Returns:

the height

setHeight

public void setHeight(int height)

Specified by:

setHeight in interface GUISizeInterface

Parameters:

height - the height to set

getWidth

public int getWidth()

Specified by:

getWidth in interface GUISizeInterface

Returns:

the width

setWidth

public void setWidth(int width)

Specified by:

setWidth in interface GUISizeInterface

Parameters:

width - the width to set

getFontName

public String getFontName()

Returns:

Returns the font name.

setFontName

public void setFontName(String fontname)

Parameters:

note - The font name.

getFontSize

public int getFontSize()

Returns:

Returns the font size.

setFontBold

public void setFontBold(boolean fontbold)

Parameters:

note - The font bold.

isFontBold

public boolean isFontBold()

Returns:

Returns the font bold.

setFontItalic

public void setFontItalic(boolean fontitalic)

Parameters:

note - The font italic.

isFontItalic

public boolean isFontItalic()

Returns:

Returns the font italic.

getBorderColorRed

public int getBorderColorRed()

Returns:

Returns the backGround color red.

getBorderColorGreen

public int getBorderColorGreen()

Returns:

Returns the backGround color green.

getBorderColorBlue

public int getBorderColorBlue()

Returns:

Returns the backGround color blue.

getBackGroundColorRed

public int getBackGroundColorRed()

Returns:

Returns the backGround color red.

getBackGroundColorGreen

public int getBackGroundColorGreen()

Returns:

Returns the backGround color green.

getBackGroundColorBlue

public int getBackGroundColorBlue()

Returns:

Returns the backGround color blue.

getFontColorRed

public int getFontColorRed()

Returns:

Returns the font color red.

getFontColorGreen

public int getFontColorGreen()

Returns:

Returns the font color green.

getFontColorBlue

public int getFontColorBlue()

Returns:

Returns the font color blue.

setFontSize

public void setFontSize(int fontsize)

Parameters:

note - The font name.