Widget Iframe
From eyeOS Wiki
Contents |
Introduction
Iframe defines a space in which a URL can be displayed.
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.
- width: sets the width of the widget, in pixels. Default is 200 pixels.
- height: sets the height of the widget, in pixels. Default is 200 pixels.
Specific Keys
- url: specifies the url the Iframe will show.
- scroll: controls the presence of scrollbars inside the Iframe. Possible values are the same as used with frame and iframe tags in HMTL:
- yes: adds scrollbars always, even if they are not needed.
- no: never adds scrollbars, even if the content size is too big for the Iframe size.
- auto (or no scroll key use): draws scrollbars only if needed.
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.
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.
setHeight($height)
- Description: changes the height of the widget.
- Arguments:
- height: natural number specifying the new height.
setUrl($url)
- Description: changes the URL of the Iframe and updates its content to reflect the change.
- Arguments:
- url: new URL to set.
setWidth($width)
- Description: changes the width of the widget.
- Arguments:
- width: natural number specifying the new width.
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.
- Arguments:
- y: natural number specifying the new Y coordinate.
unhide()
- Description: makes the widget visible.
- Arguments: none.
Can be serialized
Yes, by default this widget is always serialized. You can avoid it to being serialized by passing number 1 as the argument of its show() method.
