org.joshvm.ui.widget

Class Canvas

java.lang.Object

org.joshvm.ui.UIObject

org.joshvm.ui.AbstractUIObject

org.joshvm.ui.Widget

org.joshvm.ui.widget.Canvas

public class Canvas
extends Widget

Canvas can be used to draw Lines, Rectangles, Texts, Images, etc.

Note: Set draw properties before drawing.

Field Summary

Fields inherited from class org.joshvm.ui.AbstractUIObject

SCROLL_DIR_ALL, SCROLL_DIR_BOTTOM, SCROLL_DIR_HORIZONTAL, SCROLL_DIR_LEFT, SCROLL_DIR_NONE, SCROLL_DIR_RIGHT, SCROLL_DIR_TOP, SCROLL_DIR_VERTICAL, SCROLLBAR_MODE_ACTIVE, SCROLLBAR_MODE_AUTO, SCROLLBAR_MODE_OFF, SCROLLBAR_MODE_ON, STATE_CHECKED, STATE_DEFAULT, STATE_DISABLED, STATE_SCROLLED

Fields inherited from class org.joshvm.ui.UIObject

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_TOP, objImpl, SIDE_BOTTOM, SIDE_FULL, SIDE_LEFT, SIDE_RIGHT, SIDE_TOP, SIZE_CONTENT, TEXT_DECOR_NONE, TEXT_DECOR_STRIKETHROUGH, TEXT_DECOR_UNDERLINE

Constructor Summary

Constructors

Constructor and Description
Canvas(int width, int height) Constructs a canvas with the given size

Method Summary

Methods

Modifier and Type	Method and Description
void	drawArc(int x, int y, int radius, int startAngle, int endAngle) Draws an arc on the canvas
void	drawImage(byte[] data, int offset, int length, int x, int y) Draws an image on the canvas
void	drawImage(String source, int x, int y) Draws an image on the canvas
void	drawLine(int x, int y, int x2, int y2) Draws a simple line which from (x,y) to (x2, y2) on the canvas
void	drawLine(PointGroup group) Draws a line on the canvas.
void	drawPolygon(PointGroup group) Draws a polygon on the canvas
void	drawRect(int x, int y, int w, int h) Draws a rectangle on the canvas
void	drawText(String text, int x, int y) Draws a text on the canvas
void	drawText(String text, int x, int y, int maxWidth) Draws a text on the canvas
void	fill(Color color) Fills the canvas with color
Image	getImage() Creates an image from the canvas.
void	resetPropertyValuesOfDraw() Resets all draw properties to default value
void	setBackgroundColorOfDraw(Color color) Sets draw property background color of the canvas
void	setImageAngleOfDraw(int angle) Sets draw property image angle of the canvas
void	setImagePivotOfDraw(int pivotX, int pivotY) Sets draw property image pivot of the canvas
void	setImageRecolorOfDraw(Color color) Sets draw property image recolor of the canvas
void	setImageZoomOfDraw(double factor) Sets draw property image zoom of the canvas
void	setLineColorOfDraw(Color color) Sets draw property line color of the canvas
void	setLineDashGapOfDraw(int gap) Sets draw property line dash gap of the canvas
void	setLineDashWidthOfDraw(int width) Sets draw property line dash width of the canvas
void	setLineWidthOfDraw(int width) Sets draw property line width of the canvas
void	setPixel(int x, int y, Color color) Sets the color of a pixel on the canvas
void	setPixel(Point point, Color color) Sets the color of a pixel on the canvas
void	setRectRadiusOfDraw(int radius) Sets draw property rect radius of the canvas
void	setShadowColorOfDraw(Color color) Sets draw property shadow color of the canvas
void	setShadowOffsetXOfDraw(int offsetX) Sets draw property shadow offsetX of the canvas
void	setShadowOffsetYOfDraw(int offsetY) Sets draw property shadow offsetY of the canvas
void	setShawdowWidthOfDraw(int width) Sets draw property shadow width of the canvas
void	setTextColorOfDraw(Color color) Sets draw property text color of the canvas
void	setTextDecorOfDraw(int decor) Sets draw property text decor of the canvas
void	setTextFontOfDraw(Font font) Sets draw property text font of the canvas
void	setTextLetterSpaceOfDraw(int space) Sets draw property text letter space of the canvas
void	setTextLineSpaceOfDraw(int space) Sets draw property text line space of the canvas

Methods inherited from class org.joshvm.ui.Widget

getContainer

Methods inherited from class org.joshvm.ui.AbstractUIObject

getObjectOfState, getScrollbar, getScrollbarMode, getScrollbarOfState, getScrollBottom, getScrollDirection, getScrollLeft, getScrollRight, getScrollTop, getScrollX, getScrollY, isChecked, isClickable, isDisabled, isFloating, isHidden, isIgnoreLayout, isScrollable, isScrolled, resetAllListeners, scrollToView, scrollToView, scrollToX, scrollToX, scrollToY, scrollToY, setCancelListener, setChecked, setClickable, setClickedListener, setDisabled, setFloating, setHidden, setIgnoreLayout, setReadyListener, setScrollable, setScrollbarMode, setScrollDirection, setScrollListener, setValueChangedListener

Methods inherited from class org.joshvm.ui.UIObject

enableClipCorner, forceNewTrack, getBackgroundColor, getBorderColor, getBorderWidth, getColumnPadding, getCoordinates, getFlexGrow, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getName, getPadding, getParent, getPropertyBooleanValue, getPropertyIntValue, getRadius, getRowPadding, getShadowColor, getShadowOffsetX, getShadowOffsetY, getShadowWidth, getTextColor, getTextLetterSpace, getTextLineSpace, getTranslateX, getTranslateY, getUserData, getWidth, getX, getY, isClipCornerEnabled, setAlign, setBackgroundColor, setBorderColor, setBorderWidth, setColumnPadding, setFlexGrow, setHeight, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setName, setPadding, setPadding, setParent, setPos, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setRadius, setRecolor, setRowPadding, setShadowColor, setShadowOffsetX, setShadowOffsetY, setShadowWidth, setSize, setTextAlign, setTextColor, setTextDecor, setTextFont, setTextLetterSpace, setTextLineSpace, setTranslateX, setTranslateY, setUserData, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

Canvas

public Canvas(int width,
      int height)

Constructs a canvas with the given size

Parameters:

width - width of the canvas

height - height of the canvas

Method Detail

fill

public void fill(Color color)

Fills the canvas with color

Parameters:

color - the background color

setPixel

public void setPixel(Point point,
            Color color)

Sets the color of a pixel on the canvas

Parameters:

point - the point to set

color - color of the pixel

setPixel

public void setPixel(int x,
            int y,
            Color color)

Sets the color of a pixel on the canvas

Parameters:

x - x coordinate of the point to set

y - x coordinate of the point to set

color - color of the pixel

drawLine

public void drawLine(int x,
            int y,
            int x2,
            int y2)

Draws a simple line which from (x,y) to (x2, y2) on the canvas

Parameters:

x - x coordinate of start point

y - y coordinate of start point

x2 - x coordinate of end point

y2 - y coordinate of end point

drawLine

public void drawLine(PointGroup group)

Draws a line on the canvas.

The line contain straight lines between a set of points which stored in PointGroup object.

Parameters:

group - a set of points

drawPolygon

public void drawPolygon(PointGroup group)

Draws a polygon on the canvas

Parameters:

group - a set of points of the polygon

drawRect

public void drawRect(int x,
            int y,
            int w,
            int h)

Draws a rectangle on the canvas

Parameters:

x - left coordinate of the rectangle

y - top coordinate of the rectangle

w - width of the rectangle

h - height of the rectangle

drawArc

public void drawArc(int x,
           int y,
           int radius,
           int startAngle,
           int endAngle)

Draws an arc on the canvas

Parameters:

x - origo x of the arc

y - origo y of the arc

radius - radius of the arc

startAngle - start angle in degrees

endAngle - end angle in degrees

drawText

public void drawText(String text,
            int x,
            int y)

Draws a text on the canvas

Parameters:

text - text to display

x - left coordinate of the text

y - top coordinate of the text

drawText

public void drawText(String text,
            int x,
            int y,
            int maxWidth)

Draws a text on the canvas

Parameters:

text - text to display

x - left coordinate of the text

y - top coordinate of the text

maxWidth - max width of the text. The text will be wrapped to fit into this size

drawImage

public void drawImage(String source,
             int x,
             int y)
               throws IOException

Draws an image on the canvas

Parameters:

source - file path in jar of the image

x - left coordinate of the image

y - top coordinate of the image

Throws:

IOException

drawImage

public void drawImage(byte[] data,
             int offset,
             int length,
             int x,
             int y)

Draws an image on the canvas

Parameters:

data - byte array contains the data of the image

offset - the start offset in the data

length - the number of bytes of the image

x - left coordinate of the image

y - top coordinate of the image

getImage

public Image getImage()

Creates an image from the canvas. like a snapshot.

Returns:

an Image object

setBackgroundColorOfDraw

public void setBackgroundColorOfDraw(Color color)

Sets draw property background color of the canvas

Parameters:

color - background color

setLineColorOfDraw

public void setLineColorOfDraw(Color color)

Sets draw property line color of the canvas

Parameters:

color - line color

setLineWidthOfDraw

public void setLineWidthOfDraw(int width)

Sets draw property line width of the canvas

Parameters:

width - in pixels

setRectRadiusOfDraw

public void setRectRadiusOfDraw(int radius)

Sets draw property rect radius of the canvas

Parameters:

radius - in pixels

setShadowColorOfDraw

public void setShadowColorOfDraw(Color color)

Sets draw property shadow color of the canvas

Parameters:

color - shadow color

setShawdowWidthOfDraw

public void setShawdowWidthOfDraw(int width)

Sets draw property shadow width of the canvas

Parameters:

width - in pixels

setShadowOffsetXOfDraw

public void setShadowOffsetXOfDraw(int offsetX)

Sets draw property shadow offsetX of the canvas

Parameters:

offsetX - in pixels

setShadowOffsetYOfDraw

public void setShadowOffsetYOfDraw(int offsetY)

Sets draw property shadow offsetY of the canvas

Parameters:

offsetY - in pixels

setLineDashWidthOfDraw

public void setLineDashWidthOfDraw(int width)

Sets draw property line dash width of the canvas

Note that dash may works only on horizontal and vertical lines

Parameters:

width - in pixels

setLineDashGapOfDraw

public void setLineDashGapOfDraw(int gap)

Sets draw property line dash gap of the canvas

Note that dash may works only on horizontal and vertical lines

Parameters:

gap - gap between dashes in pixels

setTextColorOfDraw

public void setTextColorOfDraw(Color color)

Sets draw property text color of the canvas

Parameters:

color - text color

setTextFontOfDraw

public void setTextFontOfDraw(Font font)

Sets draw property text font of the canvas

Parameters:

font - text font

setTextDecorOfDraw

public void setTextDecorOfDraw(int decor)

Sets draw property text decor of the canvas

Parameters:

decor - a combination of UIObject.TEXT_DECOR_NONE, UIObject.TEXT_DECOR_UNDERLINE and UIObject.TEXT_DECOR_STRIKETHROUGH

setTextLetterSpaceOfDraw

public void setTextLetterSpaceOfDraw(int space)

Sets draw property text letter space of the canvas

Parameters:

space - in pixels

setTextLineSpaceOfDraw

public void setTextLineSpaceOfDraw(int space)

Sets draw property text line space of the canvas

Parameters:

space - in pixels

setImageZoomOfDraw

public void setImageZoomOfDraw(double factor)

Sets draw property image zoom of the canvas

Parameters:

factor - zoom factor

setImageAngleOfDraw

public void setImageAngleOfDraw(int angle)

Sets draw property image angle of the canvas

Parameters:

angle - the rotation angle of the image in degree with 0.1 degree resolution

setImagePivotOfDraw

public void setImagePivotOfDraw(int pivotX,
                       int pivotY)

Sets draw property image pivot of the canvas

Parameters:

pivotX - rotation center x of the image

pivotY - rotation center y of the image

setImageRecolorOfDraw

public void setImageRecolorOfDraw(Color color)

Sets draw property image recolor of the canvas

Parameters:

color - the color to mix to image

resetPropertyValuesOfDraw

public void resetPropertyValuesOfDraw()

Resets all draw properties to default value