org.fujion.spinjs

Class SpinJS

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.spinjs.SpinJS

All Implemented Interfaces:

IDisable, IElementIdentifier, IClientTransform

@Component(tag="spinjs",
           widgetModule="fujion-spinjs",
           widgetClass="SpinJS",
           parentTag="*",
           description="Spin-js component.")
public class SpinJS
extends BaseUIComponent

Fujion wrapper for jquery.sparkline component.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
SpinJS()

Method Summary

Modifier and Type	Method and Description
Double	getCorners() Returns the corner roundness.
String	getFadeColor() Returns the color(s) for the fade effect.
String	getLeft() Returns the left position relative to parent.
String	getLineColor() Returns the line color(s).
Integer	getLineLength() Returns the length of each line.
Integer	getLines() Returns the number of lines to draw.
Integer	getLineWidth() Returns the line width.
Double	getOpacity() Returns the opacity of the lines.
Integer	getRadius() Returns the radius of the inner circle.
Integer	getRotate() Returns the rotation offset.
Double	getScale() Returns the overall size of the spinner.
String	getShadow() Returns the box-shadow for the lines.
Integer	getSpeed() Returns the rounds per second.
String	getTop() Returns the top position relative to parent.
Integer	getTrail() Returns the after-glow percentage.
Boolean	isClockwise() Returns true if the spinner rotation is clockwise.
boolean	isRunning() Returns true if the animation is running.
void	setClockwise(Boolean clockwise) Set to true for clockwise rotation.
void	setCorners(Double corners) Sets the corner roundness.
void	setFadeColor(String fadeColor) Sets the color(s) for the fade effect.
void	setLeft(String left) Sets the left position relative to parent.
void	setLineColor(String color) Sets the line color(s).
void	setLineLength(Integer length) Sets the length of each line.
void	setLines(Integer lines) Sets the number of lines to draw.
void	setLineWidth(Integer width) Sets the line width.
void	setOpacity(Double opacity) Sets the opacity of the lines.
void	setRadius(Integer radius) Sets the radius of the inner circle.
void	setRotate(Integer rotate) Sets the rotation offset.
void	setScale(Double scale) Sets the overall size of the spinner.
void	setShadow(String shadow) Sets the box-shadow for the lines.
void	setSpeed(Integer speed) Sets the rounds per second.
void	setTop(String top) Sets the top position relative to parent.
void	setTrail(Integer trail) Sets the after-glow percentage.
void	start() Starts the animation.
void	start(boolean start) Starts or stops the animation.
void	stop() Stops the animation.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, onDestroyTracked, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _getChildren, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, addSnippet, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAllNamed, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasChildren, hasEventListener, hasEventListener, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, isRendered, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, swapTrackedComponents, sync, toString, trackComponent, trimify, untrackComponent, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Constructor Detail

SpinJS

public SpinJS()

Method Detail

isRunning

public boolean isRunning()

Returns true if the animation is running.

Returns:

True if the animation is running.

start

@Component.PropertySetter(value="start",
                          defer=true,
                          defaultValue="false",
                          description="Starts or stops the animation.")
public void start(boolean start)

Starts or stops the animation.

Parameters:

start - If true, start the animation; if false, stop.

start

public void start()

Starts the animation.

stop

public void stop()

Stops the animation.

getLines

@Component.PropertyGetter(value="lines",
                          description="The number of lines to draw.")
public Integer getLines()

Returns the number of lines to draw.

Default: 12

Returns:

The number of lines to draw.

setLines

@Component.PropertySetter(value="lines",
                          defaultValue="12",
                          description="The number of lines to draw.")
public void setLines(Integer lines)

Sets the number of lines to draw.

Default: 12

Parameters:

lines - The number of lines to draw.

getLineLength

@Component.PropertyGetter(value="linelength",
                          description="The length of each line.")
public Integer getLineLength()

Returns the length of each line.

Default: 7

Returns:

The length of each line.

setLineLength

@Component.PropertySetter(value="linelength",
                          defaultValue="7",
                          description="The length of each line.")
public void setLineLength(Integer length)

Sets the length of each line.

Default: 7

Parameters:

length - The length of each line.

getLineWidth

@Component.PropertyGetter(value="linewidth",
                          description="The width of each line.")
public Integer getLineWidth()

Returns the line width.

Default: 5

Returns:

The line width (thickness).

setLineWidth

@Component.PropertySetter(value="linewidth",
                          defaultValue="5",
                          description="The width of each line.")
public void setLineWidth(Integer width)

Sets the line width.

Default: 5

Parameters:

width - The line width (thickness).

getRadius

@Component.PropertyGetter(value="radius",
                          description="The radius of the inner circle.")
public Integer getRadius()

Returns the radius of the inner circle.

Default: 10

Returns:

The radius of the inner circle.

setRadius

@Component.PropertySetter(value="radius",
                          defaultValue="10",
                          description="The radius of the inner circle.")
public void setRadius(Integer radius)

Sets the radius of the inner circle.

Default: 10

Parameters:

radius - The radius of the inner circle.

getScale

@Component.PropertyGetter(value="scale",
                          description="The overall size of the spinner.")
public Double getScale()

Returns the overall size of the spinner.

Default: 1

Returns:

The overall size of the spinner.

setScale

@Component.PropertySetter(value="scale",
                          defaultValue="1",
                          description="The overall size of the spinner.")
public void setScale(Double scale)

Sets the overall size of the spinner.

Default: 1

Parameters:

scale - The overall size of the spinner.

getCorners

@Component.PropertyGetter(value="corners",
                          description="The corner roundness.")
public Double getCorners()

Returns the corner roundness.

Constraints: ≥0 and ≤1

Default: 1

Returns:

The corner roundness.

setCorners

@Component.PropertySetter(value="corners",
                          defaultValue="1",
                          description="The corner roundness.")
public void setCorners(Double corners)

Sets the corner roundness.

Constraints: ≥0 and ≤1

Default: 1

Parameters:

corners - The corner roundness.

getLineColor

@Component.PropertyGetter(value="linecolor",
                          description="The line color(s).  Separate multiple colors with commas.")
public String getLineColor()

Returns the line color(s). Multiple colors are separated by commas.

Default: "#000"

Returns:

The line color(s).

setLineColor

@Component.PropertySetter(value="linecolor",
                          defaultValue="#000",
                          description="The line color(s).  Separate multiple colors with commas.")
public void setLineColor(String color)

Sets the line color(s). Separate multiple colors with commas.

Default: "#000"

Parameters:

color - The line color(s).

getFadeColor

@Component.PropertyGetter(value="fadecolor",
                          description="The color(s) for the fade effect.  Separate multiple colors with commas.")
public String getFadeColor()

Returns the color(s) for the fade effect. Multiple colors are separated by commas.

Default: "transparent"

Returns:

The color(s) for the fade effect.

setFadeColor

@Component.PropertySetter(value="fadecolor",
                          defaultValue="transparent",
                          description="The color(s) for the fade effect.  Separate multiple colors with commas.")
public void setFadeColor(String fadeColor)

Sets the color(s) for the fade effect. Separate multiple colors with commas.

Default: "transparent"

Parameters:

fadeColor - The color(s) for the fade effect.

getOpacity

@Component.PropertyGetter(value="opacity",
                          description="The opacity of the lines.")
public Double getOpacity()

Returns the opacity of the lines.

Constraints: ≥0 and ≤1

Default: 0.25

Returns:

The opacity of the lines.

setOpacity

@Component.PropertySetter(value="opacity",
                          defaultValue="0.25",
                          description="The opacity of the lines.")
public void setOpacity(Double opacity)

Sets the opacity of the lines.

Constraints: ≥0 and ≤1

Default: 0.25

Parameters:

opacity - The opacity of the lines.

getRotate

@Component.PropertyGetter(value="rotate",
                          description="The rotation offset.")
public Integer getRotate()

Returns the rotation offset.

Default: 0

Returns:

The rotation offset.

setRotate

@Component.PropertySetter(value="rotate",
                          defaultValue="0",
                          description="The rotation offset.")
public void setRotate(Integer rotate)

Sets the rotation offset.

Default: 0

Parameters:

rotate - The rotation offset.

isClockwise

@Component.PropertyGetter(value="clockwise",
                          description="If true, the rotation is clockwise.")
public Boolean isClockwise()

Returns true if the spinner rotation is clockwise.

Default: true

Returns:

True if the spinner rotation is clockwise.

setClockwise

@Component.PropertySetter(value="clockwise",
                          defaultValue="true",
                          description="If true, the rotation is clockwise.")
public void setClockwise(Boolean clockwise)

Set to true for clockwise rotation.

Default: true

Parameters:

clockwise - True for clockwise rotation.

getSpeed

@Component.PropertyGetter(value="speed",
                          description="Rounds per second.")
public Integer getSpeed()

Returns the rounds per second.

Default: 1

Returns:

Rounds per second.

setSpeed

@Component.PropertySetter(value="speed",
                          defaultValue="1",
                          description="Rounds per second.")
public void setSpeed(Integer speed)

Sets the rounds per second.

Default: 1

Parameters:

speed - Rounds per second.

getTrail

@Component.PropertyGetter(value="trail",
                          description="The after-glow percentage.")
public Integer getTrail()

Returns the after-glow percentage.

Constraints: ≥0 and ≤100

Default: 100

Returns:

The after-glow percentage.

setTrail

@Component.PropertySetter(value="trail",
                          defaultValue="100",
                          description="The after-glow percentage.")
public void setTrail(Integer trail)

Sets the after-glow percentage.

Constraints: ≥0 and ≤100

Default: 100

Parameters:

trail - The after-glow percentage.

getTop

@Component.PropertyGetter(value="top",
                          description="The top position relative to parent.")
public String getTop()

Returns the top position relative to parent.

Default: "50%"

Returns:

Top position relative to parent.

setTop

@Component.PropertySetter(value="top",
                          defaultValue="50%",
                          description="The top position relative to parent.")
public void setTop(String top)

Sets the top position relative to parent.

Default: "50%"

Parameters:

top - Top position relative to parent.

getLeft

@Component.PropertyGetter(value="left",
                          description="The left position relative to parent.")
public String getLeft()

Returns the left position relative to parent.

Default: "50%"

Returns:

Left position relative to parent.

setLeft

@Component.PropertySetter(value="left",
                          defaultValue="50%",
                          description="The left position relative to parent.")
public void setLeft(String left)

Sets the left position relative to parent.

Default: "50%"

Parameters:

left - Left position relative to parent.

getShadow

@Component.PropertyGetter(value="shadow",
                          description="The box-shadow for the lines.")
public String getShadow()

Returns the box-shadow for the lines.

Default: "none"

Returns:

Box-shadow for the lines.

setShadow

@Component.PropertySetter(value="shadow",
                          defaultValue="none",
                          description="The box-shadow for the lines.")
public void setShadow(String shadow)

Sets the box-shadow for the lines.

Default: "none"

Parameters:

shadow - Box-shadow for the lines.