org.vishia.gral.base

Class GralCanvasStorage.Figure

java.lang.Object

org.vishia.gral.base.GralCanvasStorage.Figure

All Implemented Interfaces:

java.lang.Iterable<GralCanvasStorage.FigureData>

Enclosing class:

GralCanvasStorage

public static class GralCanvasStorage.Figure
extends java.lang.Object
implements java.lang.Iterable<GralCanvasStorage.FigureData>

Data class to store some representation data of a figure. It is seen as 'draw order' for the repaint or redraw request. It has either only one or a list of GralCanvasStorage.FigureData, a GralPos as position, a common GralColor and a possible background storage.
If a background storage exists, the figure can be dynamically used. The same figure can be redrawn on a given new position. The background before drawing is stored. Before redraw on a new position the background is restored. Hence the figure is removed from the screen. Then it can be drawn newly on a new position.
For moving care should be taken for overlapping. On overlapped moving figures of course the background can contain a dynamic figure which is drawn before. Then this content is visible too. It means on redraw of both the restore process should be done in the reverse order as drawn. This is organized by the environment class with GralCanvasStorage#dynamicOrder. the

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GralCanvasStorage.Figure.Access To access protected members from the package of the implementing layer, use this as base class.

Field Summary

Fields

Modifier and Type	Field and Description
protected GralRectangle	backPositions It this rectangle is given (not a null reference), then this figure is dynamically and a back image is stored in the implementing level.
protected boolean	bChanged True if the figure is changed, for dynamic show.
protected boolean	bNewPos True on a new position or default, then calculate points newly.
boolean	bPointsAreGralPosUnits
boolean	bShow false then don't show the figure (for the next redraw on dynamic) This flag can be changed immediately from outside.
GralCanvasStorage.FigureData	data Either the figure consists of only one element, then #listData is null.
(package private) GralCanvasStorage.FigureDataSet	dataSet
protected boolean	dynamic If set to true, this figure is dynamically.
(package private) boolean	hasNextOk
(package private) java.util.Iterator<GralCanvasStorage.FigureData>	iter
java.lang.String	name
GralRectangle	pixelPos
GralPos	pos
java.lang.Object	storageBackground Used from implementing graphics on #dynamic to store the background for restore.
protected int	variant

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Figure(java.lang.String name, GralPos pos, boolean isDynamic)
protected	Figure(java.lang.String name, GralPos pos, GralCanvasStorage.FigureData data, boolean isDynamic)
protected	Figure(java.lang.String name, GralPos pos, GralCanvasStorage.FigureDataSet data, boolean isDynamic)

Method Summary

Modifier and Type	Method and Description
GralCanvasStorage.FigureDataSet	data() Access to the DataSet to add more for a dedicated figure.
int	getVariant()
java.util.Iterator<GralCanvasStorage.FigureData>	iterator()
GralCanvasStorage.Figure	set() Set any what, recommended with concatenation.
void	setNewPosition(float line, float lineEndOrSize, float column, float columnEndOrSize)
void	setNewPosition(java.lang.String posString)
GralCanvasStorage.Figure	setVariant(int variant)
GralCanvasStorage.Figure	show(boolean show) Set whether the figure should be dynamically shown or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

name

public final java.lang.String name

pos

public final GralPos pos

bPointsAreGralPosUnits

public boolean bPointsAreGralPosUnits

dynamic

protected final boolean dynamic

If set to true, this figure is dynamically. It is drawn by the dynamic refresh.

bChanged

protected boolean bChanged

True if the figure is changed, for dynamic show.

bShow

public boolean bShow

false then don't show the figure (for the next redraw on dynamic) This flag can be changed immediately from outside.

bNewPos

protected boolean bNewPos

True on a new position or default, then calculate points newly.

backPositions

protected GralRectangle backPositions

It this rectangle is given (not a null reference), then this figure is dynamically and a back image is stored in the implementing level.

variant

protected int variant

storageBackground

public java.lang.Object storageBackground

Used from implementing graphics on #dynamic to store the background for restore.

pixelPos

public GralRectangle pixelPos

hasNextOk

boolean hasNextOk

data

public final GralCanvasStorage.FigureData data

Either the figure consists of only one element, then #listData is null.

dataSet

GralCanvasStorage.FigureDataSet dataSet

iter

java.util.Iterator<GralCanvasStorage.FigureData> iter

Constructor Detail

Figure

protected Figure(java.lang.String name,
                 GralPos pos,
                 GralCanvasStorage.FigureData data,
                 boolean isDynamic)

Figure

protected Figure(java.lang.String name,
                 GralPos pos,
                 GralCanvasStorage.FigureDataSet data,
                 boolean isDynamic)

Figure

protected Figure(java.lang.String name,
                 GralPos pos,
                 boolean isDynamic)

Method Detail

data

public GralCanvasStorage.FigureDataSet data()

Access to the DataSet to add more for a dedicated figure. This is a variant for a specific data set for this figure instance.

The figure should be initialized without data or data set using #GralCanvasStorage(String, GralPos, boolean). Then it contains an empty data set.
If the figure was initialized with a given GralCanvasStorage.FigureDataSet this is the returned one. It means operations are done in the referenced data set which may be shared also with other figures.
If the figure was initialized with only one data, an assertion error occurs and this operation returns null if assertions are not enabled.

The other variant is: First create a FigureDataSet, after them create a figure via } or via GralCanvasStorage#addFigure(GralPos, GralColor, boolean).

Returns:

the given or a new dataSet.

setNewPosition

public void setNewPosition(float line,
                           float lineEndOrSize,
                           float column,
                           float columnEndOrSize)

setNewPosition

public void setNewPosition(java.lang.String posString)
                    throws java.text.ParseException

Throws:

java.text.ParseException

setVariant

public GralCanvasStorage.Figure setVariant(int variant)

set

public GralCanvasStorage.Figure set()

Set any what, recommended with concatenation. It sets the bChanged flag.

Returns:

this for concatenation.

show

public GralCanvasStorage.Figure show(boolean show)

Set whether the figure should be dynamically shown or not. If it is invoked, also set() is executed. It sets the #bShow with given argument and the bChanged flag.

Parameters:

show - false then the next GralWidget.redrawOnlyDynamics(int, int) refreshes the background with the stored content and hides the figure. true then refreshes the background and shows the figure.

Returns:

this for concatenation.

getVariant

public int getVariant()

iterator

public java.util.Iterator<GralCanvasStorage.FigureData> iterator()

Specified by:

iterator in interface java.lang.Iterable<GralCanvasStorage.FigureData>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object