desmoj.extensions.visualization2d.engine.model

Class BackgroundElement

java.lang.Object

desmoj.extensions.visualization2d.engine.model.BackgroundElement

All Implemented Interfaces:

Basic, ClassBasic

public class BackgroundElement
extends java.lang.Object
implements Basic

The class describe background elements to give a structure of animation. A background element is a rectangle which includes optional text. The text position in the rectangle and text size and style are determined in the constructor of this class. With a createGrafic Method a BackgroundElementGrafic class is created. There are mainly 2 types: One with dynamic size has fixed corner points of its rectangle. By zooming its showed size is changed. And one with static size. This has a fixed middle point and fixed showed size. By zooming its showed size is not changed. When text is null, a rectangle without text is build. When background is null, the background of this element is transparent. When name is set, the element has a border with its name. With level is determined which element is located in front of an other. Elements with a low level are painted in front of elements with a high level. All Background elements are located in a background layer. See also in BackgroundElementGrafic.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TEXT_POSITION_BottomLeft
static int	TEXT_POSITION_BottomMiddle
static int	TEXT_POSITION_BottomRight
static int	TEXT_POSITION_Middle
static int	TEXT_POSITION_MiddleLeft
static int	TEXT_POSITION_MiddleRight
static int	TEXT_POSITION_TopLeft
static int	TEXT_POSITION_TopMiddle
static int	TEXT_POSITION_TopRight
static int	TEXT_Size_Big
static int	TEXT_Size_Normal
static int	TEXT_Size_Small
static int	TEXT_Style_Bold
static int	TEXT_Style_Italic
static int	TEXT_Style_Plain

Constructor Summary

Constructors

Constructor and Description
BackgroundElement(Model model, java.lang.String id, java.lang.String text, int textSize, int textStyle, double level, java.lang.String imageId) Background element to paint a string
BackgroundElement(Model model, java.lang.String id, java.lang.String text, int textPosition, int textSize, int textStyle, double level, java.lang.String imageId) Background element with all features

Method Summary

Modifier and Type	Method and Description
Grafic	createGrafic(java.lang.String viewId, java.awt.Point middle, java.awt.Color fg, java.awt.Color bg) create grafic of background element with fixed middle point The size is the size, that the text need to display
Grafic	createGrafic(java.lang.String viewId, java.awt.Point middle, java.awt.Color fg, java.awt.Color bg, java.awt.Dimension size) create grafic of background element with fixed middle point and fixed size
Grafic	createGrafic(java.lang.String viewId, java.awt.Point topLeft, java.awt.Point bottomRight, java.awt.Color fg, java.awt.Color bg) create grafic of background element with fixed corners
Grafic	getGrafic() get ProcessGrafic, created before
java.lang.String	getId() get id of background element
java.lang.String	getImageId() Get ImageId, may be null This id is a key in this.getModel().getImage(id)
double	getLevel() Get level of background element.
Model	getModel()
java.lang.String	getName() get name of background element
java.lang.String	getText() Get text of background element.
int	getTextPosition() Get text position of background element.
int	getTextSize() Get text size of background element.
int	getTextStyle() Get text style of background element.
void	setData(java.lang.String text, int textPosition, int textSize, int textStyle, java.awt.Color foreground, java.awt.Color background, java.lang.String imageId) Updates and repaints text properties
void	setName(java.lang.String name) set name of background element

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_POSITION_TopLeft

public static final int TEXT_POSITION_TopLeft

See Also:

Constant Field Values

TEXT_POSITION_TopMiddle

public static final int TEXT_POSITION_TopMiddle

See Also:

Constant Field Values

TEXT_POSITION_TopRight

public static final int TEXT_POSITION_TopRight

See Also:

Constant Field Values

TEXT_POSITION_MiddleLeft

public static final int TEXT_POSITION_MiddleLeft

See Also:

Constant Field Values

TEXT_POSITION_Middle

public static final int TEXT_POSITION_Middle

See Also:

Constant Field Values

TEXT_POSITION_MiddleRight

public static final int TEXT_POSITION_MiddleRight

See Also:

Constant Field Values

TEXT_POSITION_BottomLeft

public static final int TEXT_POSITION_BottomLeft

See Also:

Constant Field Values

TEXT_POSITION_BottomMiddle

public static final int TEXT_POSITION_BottomMiddle

See Also:

Constant Field Values

TEXT_POSITION_BottomRight

public static final int TEXT_POSITION_BottomRight

See Also:

Constant Field Values

TEXT_Style_Plain

public static final int TEXT_Style_Plain

See Also:

Constant Field Values

TEXT_Style_Bold

public static final int TEXT_Style_Bold

See Also:

Constant Field Values

TEXT_Style_Italic

public static final int TEXT_Style_Italic

See Also:

Constant Field Values

TEXT_Size_Normal

public static final int TEXT_Size_Normal

See Also:

Constant Field Values

TEXT_Size_Small

public static final int TEXT_Size_Small

See Also:

Constant Field Values

TEXT_Size_Big

public static final int TEXT_Size_Big

See Also:

Constant Field Values

Constructor Detail

BackgroundElement

public BackgroundElement(Model model,
                         java.lang.String id,
                         java.lang.String text,
                         int textSize,
                         int textStyle,
                         double level,
                         java.lang.String imageId)

Background element to paint a string

Parameters:

id - id of background element

text - text to show. When null, no text is shown.

textSize - for values look at TEXT_SIZE_...

textStyle - for values look at TEXT_STYLE_...

level - elements with low level are painted in front of elements with high level

imageId - image for background, maybe null

BackgroundElement

public BackgroundElement(Model model,
                         java.lang.String id,
                         java.lang.String text,
                         int textPosition,
                         int textSize,
                         int textStyle,
                         double level,
                         java.lang.String imageId)

Background element with all features

Parameters:

model - used animation.model.Model

id - id of background element

text - text to show. When null, no text is shown.

textPosition - for values look at TEXT_POSITION_...

textSize - for values look at TEXT_SIZE_...

textStyle - for values look at TEXT_STYLE_...

level - elements with low level are painted in front of elements with high level

imageId - image for background, maybe null

Method Detail

getModel

public Model getModel()

Specified by:

getModel in interface Basic

getId

public java.lang.String getId()

get id of background element

Specified by:

getId in interface ClassBasic

setName

public void setName(java.lang.String name)

set name of background element

Parameters:

name -

getName

public java.lang.String getName()

get name of background element

Specified by:

getName in interface Basic

getLevel

public double getLevel()

Get level of background element. Elements with low level are painted in front of elements with high level

Returns:

getText

public java.lang.String getText()

Get text of background element.

Returns:

getImageId

public java.lang.String getImageId()

Get ImageId, may be null This id is a key in this.getModel().getImage(id)

Returns:

getTextPosition

public int getTextPosition()

Get text position of background element. for values look at TEXT_POSITION_...

Returns:

getTextSize

public int getTextSize()

Get text size of background element. for values look at TEXT_SIZE_...

Returns:

getTextStyle

public int getTextStyle()

Get text style of background element. for values look at TEXT_STYLE_...

Returns:

setData

public void setData(java.lang.String text,
                    int textPosition,
                    int textSize,
                    int textStyle,
                    java.awt.Color foreground,
                    java.awt.Color background,
                    java.lang.String imageId)

Updates and repaints text properties

Parameters:

text -

textPosition -

textSize -

textStyle -

foreground -

background -

imageId -

createGrafic

public Grafic createGrafic(java.lang.String viewId,
                           java.awt.Point topLeft,
                           java.awt.Point bottomRight,
                           java.awt.Color fg,
                           java.awt.Color bg)

create grafic of background element with fixed corners

Parameters:

x0 - x coordinate of top left corner

y0 - y coordinate of top left corner

x1 - x coordinate of bottom right corner

y1 - y coordinate of bottom right corner

fg - text color

bg - background color. When null, the background is transparent

Returns:

createGrafic

public Grafic createGrafic(java.lang.String viewId,
                           java.awt.Point middle,
                           java.awt.Color fg,
                           java.awt.Color bg,
                           java.awt.Dimension size)

create grafic of background element with fixed middle point and fixed size

Parameters:

x - x coordinate of the middle point

y - y coordinate of the middle point

fg - text color

bg - background color. When null, the background is transparent

width - width of background element.

height - heigth of background element.

Returns:

createGrafic

public Grafic createGrafic(java.lang.String viewId,
                           java.awt.Point middle,
                           java.awt.Color fg,
                           java.awt.Color bg)

create grafic of background element with fixed middle point The size is the size, that the text need to display

Parameters:

viewId -

middle -

fg -

bg -

Returns:

getGrafic

public Grafic getGrafic()

get ProcessGrafic, created before

Specified by:

getGrafic in interface Basic