Widget Label

From eyeOS Wiki

Contents 1 Note 2 Introduction 3 Widget Use 3.1 Available Generic Keys 3.2 Specific Keys 3.3 Methods 3.4 Can be serialized

Note

If you have any line break or newline characters in your label text, it will not be displayed.

Introduction

Label is a text-containing widget. It allows you to display text, with the possibility to place it anywhere, center it, or add a signal to send to an app when clicked. It can also be used to send signals to the system when clicking on it.

Widget Use

Available Generic Keys

• horiz: specifies whether its horizontal coordinate must be taken from the left (0) or the right (1) border of its container element. Default is 0 (left).

• vert: specifies whether its vertical coordinate must be taken from the top (0) or from the bottom (1) border of its container element. Default is 0 (top).

• x: specifies the horizontal displacement inside its "father" element, in pixels. Default is 10 pixels.

• y: specifies the vertical displacement inside its "father" element, in pixels. Default is 10 pixels.

• cent: specifies how the widget should be centered. Possible values are:
  • 0: no centering. This is the default value.
  • 1: center both horizontal and vertically.
  • 2: center horizontally.
  • 3: center vertically.
  • 4: place the widget at the horizontal and vertical center of its container element.
  • 5: place the widget at the horizontal center of its container element.
  • 6: place the widget at the vertical center of its container element.

Please note the difference between options 1-3 and options 4-6. Options 1-3 calculate the size of the widget to ensure that the center of the widget is placed at the central point of its container, while options 4-6 set the central point coordinates as the widget's position.

• visible: toggles the widget visibility. Possible values are 0 (hidden) or 1 (visible). Default value is 1.

• signal: specifies which signal must be sent to the app when clicking the widget.

• disablemsg: enables or disables the widget's signal. A value of 0 enables the signal, while the default value of 1 disables it.

Specific Keys

• text: the text content that the Label will display.

Methods

 addEvent($eventName,$eventFunc,$args = )

• Description: makes the widget execute code every time certain event is triggered.

• Arguments:
  • eventName: the name of the JS event. Example: onchange.
  • eventFunc: the JS code to be executed.
  • args: if any, the args passed to the system.

 addFriend($friend)

• Description: defines a friend of the widget.

• Arguments:
  • friend: the widget to be added as a friend.

 hide()

• Description: makes the widget invisible.

• Arguments: none.

 remove()

• Description: removes this widget, along with its child widgets.

• Arguments: none.

 setCss($params)

• Description: sets CSS atributes to a widget.

• Arguments:
  • params: specifies, in the form of an associative array, the CSS attributes to be applied. Remember that both the key and value of each element must be valid CSS properties and values respectively.

 setText($newValue)

• Description: changes the text shown in the Label and updates the Label (if visible) to reflect the changes.

• Arguments:
  • newValue: new text content in the Label.

 setValue($newValue)

• Description: sets the text content of the Label.

• Arguments:
  • newValue: new text content in the Label.

 setX($x)

• Description: changes the horizontal position of the widget.

• Arguments:
  • x: natural number specifying the new X coordinate.

 setY($y)

• Description: changes the vertical position of the widget.

Can be serialized

Yes, passing a 0 as the argument of its show() method. If no argument is passed to show(), by default this widget won't be serialized.