static

The static class provides an interface to manage properties and actions common to all widgets, and is the parent class of all form widget UI classes

Hierarchy

The static class is available via the form class through the Static interface.

Example

This.form:=cs.form.new(This)
...
This.myWidget:=This.form.Static("form object")
...
This.myWidget.hide()

This class is, more generally, available from the cs class store, or cs.ui class store if you use the UI component.

Example

Form.myWidget:=cs.ui.static.new("form object")
Form.myWidget.hide()

---

ℹ️ Conventions

1. To simplify the distinction between form objects and object type, this documentation uses the term “widget” for all form objects, whether static (a line, a rectangle…) or not (a button, a subform…).
2. All functions that return This return the current widget object and can include one call after another.

---

cs.static.new()

cs.static.new ( name : Text) : cs.static
cs.static.new ( name : Text ; parent : Object) : cs.static
cs.static.new ( ) : cs.static

Parameter	Type		Description
name	Text	→	Widget name
parent	cs.form	→	form object containing the widget
result	cs.static	←	New cs.static

Description

cs.static.new() creates & returns a new instance of the class.

• The optional parent parameter is the cs.form object containing the widget. This parameter is automatically set if instantiation is performed via a form widget instantiation function of the cs.form class.
• If the name parameter is omitted, the constructor uses the result of OBJECT Get name (Object current )

⚠️ Omitting the widget name can only be used if the constructor is called from the object method.

Properties & Functions

General

Properties	Description	Type	Writable
.class	List of space-separated words used as class selectors	Text See Style sheets documentation	x
.initialPosition	The widget’s coordinates on instantiation	cs.coordinates	x
.name	The name of the widget	Text	x
.title	The title of the widget **	Text	✓
.type	The type of the widget Use the Form object Types constant theme	Integer	x

Functions	Action
.setTitle ( title : Text ) →This	To change the title of the widget (if the title is a resname, the localization is performed) **

** Can be applied to a static text and will be avalaible for the inherited classes (buttons, check boxes, radio buttons, …)

Coordinates & Sizing

Properties	Description	Type	Writable
.bottom	The bottom position of the widget	Integer	✓
.coordinates	The coordinates of the widget	cs.coordinates	✓
.height	The height of the widget	Integer	✓
.horizontallyMovable	Can the widget be moved horizontally	Boolean	✓
.horizontallyResizable	Can the widget be resized horizontally	Boolean	✓
.left	The left position of the widget	Integer	✓
.rect	The dimensions of the widget	cs.rect	✓
.resizingOptions	The current resizing options for the widget as an object {horizontal,vertical}	Object	x
.right	The right position of the widget	Integer	✓
.top	The top position of the widget	Integer	✓
.verticallyResizable	Can the widget be resized vertically	Boolean	✓
.verticallyMovable	Can the widget be moved vertically	Boolean	✓
.width	The width of the widget	Integer	✓
.windowCoordinates	The coordinates of the widget in the current window as an object {left,top,right,bottom}	Object	x

Functions	Action
.backupCoordinates () →This	Updates initialPosition with the widget’s current coordinates *
.bestSize (alignement {; minWidth {; maxWidth}}) →This .bestSize ({options:Object}) →This	Set the size of the widget to its best width according to its content (e.g. a localized string) *
.bestHeight ({width}) →This	Set the size of the widget to its best height according to its content (e.g. a localized string) *
.getCoordinates () →Object	Returns the widget’s updated coordinates *
.getBestWidth ({maxWidth}) → Integer	Returns the best width of the widget according to its content (e.g. a localized string) *
.getBestHeight ({maxWidth}) → Integer	Returns the best height of the widget according to its content (e.g. a localized string) *
.moveAndResizeHorizontally (offset; resize) →This	To move and resize the widget horizontally *
.moveAndResizeVertically (offset; resize) →This	To move and resize the widget vertically *
.moveDown (offset) →This	To move the widget down *
.moveHorizontally (offset) →This	To move the widget horizontally *
.moveLeft (offset) →This	To move the widget to the left *
.moveRight (offset) →This	To move the widget to the right *
.moveUp (offset) →This	To move the widget up *
.moveVertically (offset) →This	To move the widget vertically *
.resize (offset) →This	To resize the widget horizontally & vertically *
.resizeHorizontally (offset) →This	To resize the widget horizontally *
.resizeVertically (offset) →This	To resize the widget vertically *
.restorePosition ()	Sets the widget coordinates with the contents of initialPosition *
.setCoordinates (left; top {; right; bottom }) →This .setCoordinates (coordinates:Object) →This	To modifies the coordinates and, optionally, the size of the widget *
.setHeight (height) →This	To modify the widget height *
.setRect (width {; height }) →This	To modify the widget width & height *
.setWidth (width) →This	To modify the widget width *
.setResizingOptions (horizontal {; vertical }) →This	Modifies the resizing options for the widget
.updateCoordinates ({left; top; right; bottom }) →This	To force update of properties:   - coordinates   - rect   - windowCoordinates with the passed values or the current widget coordinates if omitted.

* Automatically update the coordinates, rect and windowCoordinates properties.

Entry

Properties	Description	Type	Writable
.disabled	Is the widget disabled	Boolean	✓
.enabled	Is the widget enabled	Boolean	✓

Functions	Action
.disable () →This	To disable the widget
.enable ({state }) →This	To enable (no parameter) or disable (state = False) the widget

Display

Properties	Description	Type	Writable
.format	The display format of the widget	Text	✓
.hidden	Is the widget hidden	Boolean	✓
.visible	Is the widget visible	Boolean	✓

Functions	Action
.hide () →This	Hides the widget
.show ( {state }) →This	Makes the widget visible (no parameter) or invisible (state = False)
.setFormat (format ) →This	Sets the display format of the widget
.setPicture (proxy ) →This	Defines the image associated with: 3D button, picture button, picture popup menu, listbox header or static picture. Clears the associated image if proxy is empty

Colors

Properties	Description	Type	Writable
.altBackgroundColor	The alternating background color of the widget	Variant	✓
.backgroundColor	The backgound color of the widget	Variant	✓
.colors	The colors of the widget as object {foreground,background,altBackground}	Object	✓
.foregroundColor	The foreground color of the widget	Variant	✓

Functions	Action
.removeAltBackgroundColor ()	Removes widget alternating background color
.removeBackgroundColor ()	Removes widget background color
.restoreAltBackgroundColor ()	Restores the widget alternating background color set in structure
.restoreBackgroundColor ()	Restores the widget background color set in structure
.restoreForegroundColor ()	Restores the widget foreground color set in structure
.setColors (background {; altBackground }) →This	Sets the widget’s colors

Text

Properties	Description	Type	Writable
.font	The name of the character font used by the widget	Text	✓
.fontSize	The font size used by the widget	Integer	✓
.fontStyle	The font style used by the widget Use the predefined constants, placed in the “Font Styles” theme	Integer	✓
.horizontalAlignment	The type of horizontal alignment applied to the widget	Integer	✓
.verticalAlignment	The type of vertical alignment applied to the widget	Integer	✓

Functions	Action
.alignLeft () →This	Sets horizontal alignment of widget to left
.alignRight () →This	Sets horizontal alignment of widget to right
.alignTop () →This	Sets vertical alignment of widget to top
.alignBottom () →This	Sets vertical alignment of widget to bottom
.alignCenter (vertical ) →This	Sets the widget’s horizontal or vertical alignment (if vertical = True) to centered.
.setFont (fontName ) →This	Defines the fonts used by the widget to display text. If fontName is omitted, empty or equal to “default” or “system”, the default system font is used.
.setFontStyle (style ) →This	Defines the fonts style used by the widget to display text. Use the predefined constants, placed in the “Font Styles” theme.

Miscellaneous

Functions	Action
.addToGroup (group ) →This	Adds this widget to a group.
.duplicate (options) →Object .duplicate ({offsetV {; offsetH {; boundTo {; newName }}}}) →Object	Duplicates the widget and returns the new widget instance typed according to object type.
.hiddenFromView () →This	Sets the widget’s coordinates so that it is outside the viewing window.
.jsonFormDefinition () →Object	Returns the json widget definition as defined in the structure. ⚠️ Only available if the parent parameter has been passed to the constructor when using from a component.

.duplicate()

.duplicate ({ options : Object }) : Object
.duplicate ({ offsetV : Integer {; offsetH : Integer {; boundTo : Text {; newName : Text }}}}) : Object

Parameter	Type		Description
options	Object		Optional configuration object: {offsetV; offsetH; boundTo; newName; newVar}
offsetV	Integer		Vertical offset applied to the duplicate (default: widget height + 20)
offsetH	Integer		Horizontal offset applied to the duplicate (default: 0)
boundTo	Text		Object name used as insertion reference (default: current widget name)
newName	Text		Optional new object name
result	Object		The newly created widget instance (cs.static, cs.button, cs.input, etc.)

Description

duplicate() duplicates the current widget in the form and returns the new widget as the appropriate UI class instance based on the duplicated object type.

When no parameter is passed, the duplicate is positioned below the original widget with a default vertical offset equal to height + 20.

You can pass a single options object to configure all parameters:

var $copy : Object:=This.myWidget.duplicate({
	offsetV: 40;
	offsetH: 12;
	boundTo: "myWidget";
	newName: "myWidget_copy"
})

Or pass positional parameters:

var $copy : Object:=This.myWidget.duplicate(40; 12; "myWidget"; "myWidget_copy")

.setPicture()

.setPicture ({ proxy })

Parameter	Type		Description
proxy	Text	→	proxy picture
result	This	←	Current widget object

Description

This function is intended to set the image of the compatible 3D button, 3D checkbox, 3D radio button, picture button, picture popup menu, listbox header or static picture.

Possible values for the proxy parameter are:

• The string #{folder/}picturename or file:{folder/}picturename if the picture comes from a file stored in the Resources folder
• A variable name if the picture comes from a picture variable

If the proxy parameter is omitted, the picture is removed

Integration Notes

Recent integration adds dimension aliases and best-size paddings:

• .dimensions getter/setter mirrors .rect.
• .setDimensions(width; height) mirrors .setRect(width; height).
• .bestSize() now accepts optional horizontalPadding and verticalPadding in its object parameter.