desmoj.extensions.visualization2d.animation

Class BackgroundElementAnimation

java.lang.Object

desmoj.extensions.visualization2d.animation.BackgroundElementAnimation

public class BackgroundElementAnimation
extends java.lang.Object

Background elements are rectangles. There are two types: - One has fixed corner points and - the other has a fixed middle point. The size is set also or comes from the text element. It is possible to show a text in the rectangle. There is a automatic word wrapping. For an explicit newline use a
tag. The text- position, size and style can be set explicitly. The colors of text and background can be set also. When background is null, the background is transparent. It is also possible to show an image on background. This image must loaded before in ModelAnimation. The level value determine the order of painting. Elements with low level value are painted in front of elements with high level.

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.

Constructor Summary

Constructors

Constructor and Description
BackgroundElementAnimation(ModelAnimation owner, java.lang.String baseId, java.lang.String name, java.lang.String text, int textPosition, int textSize, int textStyle, double level, Position middle, Form form, java.awt.Color fg, java.awt.Color bg, boolean showInAnimation) BackgroundElement with fixed middle point
BackgroundElementAnimation(ModelAnimation owner, java.lang.String baseId, java.lang.String name, java.lang.String text, int textPosition, int textSize, int textStyle, Position topLeft, Position bottomRight, double level, java.awt.Color fg, java.awt.Color bg, boolean showInAnimation) Build background element with fixed corners

Method Summary

Modifier and Type	Method and Description
void	setBackground(java.awt.Color bg) Changes Background Color of Background Element
void	setImageId(java.lang.String imageId) Changes/set imageId of background element.
void	setText(java.lang.String text) Changes Text of Background Element
void	setTextColor(java.awt.Color fg) Changes Color of Text in Background Element
void	setTextPosition(int pos) Changes Position of Text in Background Element
void	setTextSize(int size) Changes Size of Text in Background Element
void	setTextStyle(int style) Changes Style of Text in Background Element

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundElementAnimation

public BackgroundElementAnimation(ModelAnimation owner,
                                  java.lang.String baseId,
                                  java.lang.String name,
                                  java.lang.String text,
                                  int textPosition,
                                  int textSize,
                                  int textStyle,
                                  Position topLeft,
                                  Position bottomRight,
                                  double level,
                                  java.awt.Color fg,
                                  java.awt.Color bg,
                                  boolean showInAnimation)

Build background element with fixed corners

Parameters:

owner - Simulation model

baseId - A internal Name. The framework generate with this name an id

name - Can be null, when not null a border with the name is shown.

text - The text element, that is shown in background element, with automatic word wrapping. Use
for a new line.

textPosition - For values look at BackgroundElement.TEXT_POSITION_...

textSize - For values look at BackgroundElement.TEXT_SIZE_...

textStyle - For values look at BackgroundElement.TEXT_STYLE_...

topLeft - Coordinate of topLeft corner point

bottomRight - Coordinate of bottomRight corner point

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

fg - Text color

bg - Background color, when null then transparent

showInAnimation -

BackgroundElementAnimation

public BackgroundElementAnimation(ModelAnimation owner,
                                  java.lang.String baseId,
                                  java.lang.String name,
                                  java.lang.String text,
                                  int textPosition,
                                  int textSize,
                                  int textStyle,
                                  double level,
                                  Position middle,
                                  Form form,
                                  java.awt.Color fg,
                                  java.awt.Color bg,
                                  boolean showInAnimation)

BackgroundElement with fixed middle point

Parameters:

owner - Simulation model

baseId - A internal Name. The framework generate with this name an id

name - Can be null, when not null a border with the name is shown.

text - The text element, that is shown in background element, with automatic word wrapping. Use
for a new line.

textPosition - For values look at BackgroundElement.TEXT_POSITION_...

textSize - For values look at BackgroundElement.TEXT_SIZE_...

textStyle - For values look at BackgroundElement.TEXT_STYLE_...

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

middle - Middle point of background element

form - Form of background element, when null minimal size of text is used.

fg - Text color

bg - Background color, when null then transparent

showInAnimation -

Method Detail

setText

public void setText(java.lang.String text)

Changes Text of Background Element

Parameters:

text - The text element, that is shown in background element, with automatic word wrapping. Use
for a new line.

setTextPosition

public void setTextPosition(int pos)

Changes Position of Text in Background Element

Parameters:

pos - For values look at BackgroundElement.TEXT_POSITION_...

setTextSize

public void setTextSize(int size)

Changes Size of Text in Background Element

Parameters:

size - For values look at BackgroundElement.TEXT_SIZE_...

setTextStyle

public void setTextStyle(int style)

Changes Style of Text in Background Element

Parameters:

style - For values look at BackgroundElement.TEXT_STYLE_...

setTextColor

public void setTextColor(java.awt.Color fg)

Changes Color of Text in Background Element

Parameters:

fg - Text color

setBackground

public void setBackground(java.awt.Color bg)

Changes Background Color of Background Element

Parameters:

bg - Background color, when null then transparent

setImageId

public void setImageId(java.lang.String imageId)

Changes/set imageId of background element. The imageId must defined before in ModelAnimation.addIcon(..)

Parameters:

imageId -