com.anylogic.engine.presentation

Class ShapeCheckBox

java.lang.Object

com.anylogic.engine.presentation.Shape

com.anylogic.engine.presentation.ShapeControl

com.anylogic.engine.presentation.ShapeInputControl

com.anylogic.engine.presentation.ShapeCheckBox

All Implemented Interfaces:

com.anylogic.engine.internal.Child, Locatable2D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, java.io.Serializable, java.lang.Cloneable

public class ShapeCheckBox
extends ShapeInputControl

Checkbox control. Embeds JCheckBox.

Author:

AnyLogic North America, LLC https://anylogic.com

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.anylogic.engine.presentation.ShapeControl

ShapeControl.ValueType

Field Summary

Fields

Modifier and Type	Field and Description
boolean	value The current state of the check box (true means selected) that can be accessed in the overridden action() method. Use isSelected() to obtain the current check box state from other places

Fields inherited from class com.anylogic.engine.presentation.ShapeControl

TYPE_DOUBLE, TYPE_INT, TYPE_STRING

Fields inherited from class com.anylogic.engine.presentation.Shape

UNKNOWN_NAME

Constructor Summary

Constructors

Constructor and Description
ShapeCheckBox(Presentable p, boolean ispublic, double x, double y, double width, double height, java.awt.Color textColor, boolean enabled, java.awt.Font font, java.lang.String text) Creates a persistent checkbox control.
ShapeCheckBox(Presentable p, boolean ispublic, double x, double y, double width, double height, java.awt.Color backgroundColor, java.awt.Color textColor, boolean enabled, java.awt.Font font, java.lang.String text) Deprecated. may be removed in future releases
ShapeCheckBox(Presentable p, boolean ispublic, double x, double y, double width, double height, java.awt.Color backgroundColor, java.awt.Color textColor, java.awt.Font font, java.lang.String text) Deprecated. may be removed in future releases

Method Summary

Modifier and Type	Method and Description
void	executeUserAction(java.lang.String value) This method is internal and shouldn't be called by user. it may be removed/renamed in future.
java.lang.String	getText() Returns the checkbox label text.
boolean	isSelected() Returns the selected state of the checkbox.
void	setSelected(boolean yes) Sets the selected state of a persistent checkbox Doesn't execute user action code
void	setSelected(boolean yes, boolean callAction) Sets the selected state of a persistent checkbox Executes user action code (if any exists) if callAction parameter is true
void	setText(java.lang.Object text) Sets the checkbox label text

Methods inherited from class com.anylogic.engine.presentation.ShapeInputControl

postSVGShapeSpecificAttributes

Methods inherited from class com.anylogic.engine.presentation.ShapeControl

action, clone, contains, executeAction, getHeight, getPresentable, getWidth, isEnabled, randomPointInside, restoreOwner, setEnabled, setHeight, setValueToDefault, setWidth

Methods inherited from class com.anylogic.engine.presentation.Shape

canHandleClick, findSVGElement, getDrawMode, getGroup, getLevel, getName, getRotation, getScaleX, getScaleY, getSVGId, getX, getY, isJava2DSwingPresentation, isPublic_xjal, isSVGPresentation, isVisible, onAggregatorVisibilityChanged, onClick, randomPointInside, removeSVGFromOwner, removeSVGImage, resetSVGState, setLevel, setPos, setPos, setPublic_xjal, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY, updateDynamicProperties, updateDynamicPropertiesStructural, updateSVGProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.markup.AggregatableAnimationElement

initializeInternal, postInitialize

Field Detail

value

@AnyLogicInternalAPI
public boolean value

The current state of the check box (true means selected) that can be accessed in the overridden action() method.
Use isSelected() to obtain the current check box state from other places

Constructor Detail

ShapeCheckBox

@Deprecated
public ShapeCheckBox(Presentable p,
                                 boolean ispublic,
                                 double x,
                                 double y,
                                 double width,
                                 double height,
                                 java.awt.Color backgroundColor,
                                 java.awt.Color textColor,
                                 java.awt.Font font,
                                 java.lang.String text)

Deprecated. may be removed in future releases

ShapeCheckBox

@Deprecated
public ShapeCheckBox(Presentable p,
                                 boolean ispublic,
                                 double x,
                                 double y,
                                 double width,
                                 double height,
                                 java.awt.Color backgroundColor,
                                 java.awt.Color textColor,
                                 boolean enabled,
                                 java.awt.Font font,
                                 java.lang.String text)

Deprecated. may be removed in future releases

ShapeCheckBox

public ShapeCheckBox(Presentable p,
                     boolean ispublic,
                     double x,
                     double y,
                     double width,
                     double height,
                     java.awt.Color textColor,
                     boolean enabled,
                     java.awt.Font font,
                     java.lang.String text)

Creates a persistent checkbox control. You should override the action() method.

Parameters:

p - the presentable object owning this control

ispublic - if true, the control is visible on container's presentation

x - the x coordinate

y - the y coordinate

width - the width

height - the height

textColor - the text color

enabled - the initial enabled state

font - the text font

text - the text label of the control

Method Detail

setSelected

public void setSelected(boolean yes)

Sets the selected state of a persistent checkbox
Doesn't execute user action code

Parameters:

yes - if true - selected, otherwise - not

setSelected

public void setSelected(boolean yes,
                        boolean callAction)

Sets the selected state of a persistent checkbox
Executes user action code (if any exists) if callAction parameter is true

Parameters:

yes - if true - selected, otherwise - not

callAction - if true user action code (if any exists) will be executed

isSelected

public boolean isSelected()

Returns the selected state of the checkbox.

Returns:

true if selected, false if not

setText

public void setText(java.lang.Object text)

Sets the checkbox label text

Parameters:

text - the new checkbox text

getText

public java.lang.String getText()

Returns the checkbox label text.

Returns:

the checkbox label text

executeUserAction

@AnyLogicInternalAPI
public void executeUserAction(java.lang.String value)

Description copied from interface: SVGElement

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

Specified by:

executeUserAction in interface SVGElement

Overrides:

executeUserAction in class Shape