Package com.storedobject.chart

Class Shape

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Shape

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPosition, VisibleProperty

Direct Known Subclasses:

BezierCurve, CirclePart, Image, Line, Polyline, Rectangle, ShapeGroup, Text

public abstract class Shape
extends AbstractPart
implements Component, HasPosition, VisibleProperty

Shape class that can be added to SOChart. Positioning of the Shape on the screen is relative to its parent. The parent could be an instance of the SOChart if this was added to that instance directly, or it could be a ShapeGroup class if this was added to a ShapeGroup instance. Positioning can be done by setting appropriate values on the Position instance of this shape or by setting shape-specific parameters like center coordinate for the CirclePart shape. When both are specified, values set on the Position will be used.

Note: Unless otherwise specified, all measurements used in this class are in pixels. Sub-pixels are supported.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Shape.Point	Representation of a (x, y) point used in shapes.
static class	Shape.Style	Class to specify the style of a Shape instance.

Constructor Summary

Constructors

Constructor	Description
Shape()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected static void	encode(StringBuilder sb, String name, Object value)	Helper method: Encode a (name, value) pair.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
protected static void	encodePoint(StringBuilder sb, Shape.Point point)	Helper method: Encode a Shape.Point.
protected static void	encodePoint(StringBuilder sb, String nameX, String nameY, Shape.Point point)	Helper method: Encode a Shape.Point.
protected void	encodeShape(StringBuilder sb)	Encode shape details.
final Position	getPosition(boolean create)	Get the position.
final Shape.Style	getStyle(boolean create)	Get the style.
protected abstract String	getType()	Get the type of this shape.
final boolean	isDraggable()	Whether this shape is draggable or not.
boolean	isVisible()	Checks if this property is currently visible.
void	setDraggable(boolean draggable)	Mark this shape as draggable.
void	setPosition(Position position)	Set position.
void	setPosition(Shape.Point positionXY)	Set the X and Y positions of this shape in the coordinate system.
void	setPosition(Number positionX, Number positionY)	Set the X and Y positions of this shape in the coordinate system.
void	setStyle(Shape.Style style)	Set style.
void	setVisible(boolean visible)	Sets the visibility of this property.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.Component

addParts

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

Shape

public Shape()

Constructor.

Method Details

getType

protected abstract String getType()

Get the type of this shape.

Returns:

Type of the shape.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

encode

protected static void encode(StringBuilder sb,
 String name,
 Object value)

Helper method: Encode a (name, value) pair.

Parameters:

sb - Encoded JSON string to be appended to this.

name - Name to be encoded.

value - Value to be encoded.

encodePoint

protected static void encodePoint(StringBuilder sb,
 String nameX,
 String nameY,
 Shape.Point point)

Helper method: Encode a Shape.Point.

Parameters:

sb - Encoded JSON string to be appended to this.

nameX - Name to be encoded for X value.

nameY - Name to be encoded for Y value.

point - Point to be encoded.

encodePoint

protected static void encodePoint(StringBuilder sb,
 Shape.Point point)

Helper method: Encode a Shape.Point. Names of the X value and Y value will be "x" and "y" respectively.

Parameters:

sb - Encoded JSON string to be appended to this.

point - Point to be encoded.

encodeShape

protected void encodeShape(StringBuilder sb)

Encode shape details.

Parameters:

sb - Encoded JSON string to be appended to this.

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Throws:

ChartException - Raises exception if the component or part is not valid.

setVisible

public void setVisible(boolean visible)

Description copied from interface: VisibleProperty

Sets the visibility of this property.

Specified by:

setVisible in interface VisibleProperty

Parameters:

visible - A boolean indicating whether this property should be visible (true) or hidden (false).

isVisible

public boolean isVisible()

Description copied from interface: VisibleProperty

Checks if this property is currently visible.

Specified by:

isVisible in interface VisibleProperty

Returns:

true if the property is visible, false otherwise.

isDraggable

public final boolean isDraggable()

Whether this shape is draggable or not.

Returns:

True/false.

setDraggable

public void setDraggable(boolean draggable)

Mark this shape as draggable.

Parameters:

draggable - True/false.

getPosition

public final Position getPosition(boolean create)

Get the position.

Specified by:

getPosition in interface HasPosition

Parameters:

create - Whether to create it or not.

Returns:

Position.

setPosition

public void setPosition(Position position)

Set position.

Specified by:

setPosition in interface HasPosition

Parameters:

position - Position to set.

setPosition

public void setPosition(Shape.Point positionXY)

Set the X and Y positions of this shape in the coordinate system.

Note: If X and Y positions are set this way, other position details set through getPosition(boolean) and/or setPosition(Position) are ignored.

Parameters:

positionXY - XY position in pixels.

setPosition

public void setPosition(Number positionX,
 Number positionY)

Set the X and Y positions of this shape in the coordinate system.

Note: If X and Y positions are set this way, other position details set through getPosition(boolean) and/or setPosition(Position) are ignored.

Parameters:

positionX - X position in pixels.

positionY - Y position in pixels.

getStyle

public final Shape.Style getStyle(boolean create)

Get the style.

Parameters:

create - Whether to create it now or not.

Returns:

Style.

setStyle

public void setStyle(Shape.Style style)

Set style.

Parameters:

style - Style.