Index...
Centrallix Documentation
|
widget/html
html :: A miniature HTML browser control, capable of viewing and navigating simple web documents.
Metadata:
| type: | widget/html |
| visual: | yes |
| container: | no |
| form element: | no |
Overview:
The HTML area widget provides a way to insert a plain HTML document into a Centrallix generated page, either in-flow (static) or in its own separate layer that can be reloaded at will (dynamic). The HTML document can either be given in a property of the widget or can be referenced so that the HTML is read from an external document.
The HTML area widget also can act as a mini-browser -- clicking on hyper-text links in the visible document will by default cause the link to be followed, and the new document to be displayed in the HTML area (if the HTML area is dynamic).
Dynamic HTML areas do double-buffering and allow for transitions (fades) of various types.
Usage:
The HTML area widget can be placed within any other widget that has a visible container (such as panes, pages, tab pages, etc.).
Properties:
| Property | Type | Description |
|---|
| content |
string |
Static contents for the HTML area. Usually used in lieu of "source" (see below). |
| epilogue |
string |
HTML source to be inserted at the end of the HTML document. |
| height |
integer |
height, in pixels, of the HTML area as a whole. |
| mode |
string |
Either "static" or "dynamic", and determines whether the HTML area is in-flow ("static") can be positioned and reloaded at-will. |
| prologue |
string |
HTML source to be inserted at the beginning of the HTML document. |
| source |
string |
The objectsystem path or URL containing the document to be loaded into the HTML as local server. |
| width |
integer |
width, in pixels, of the HTML area as a whole. |
| x |
integer |
dynamic HTML areas, the x coordinate on the container of its upper left corner. |
| y |
integer |
dynamic HTML areas, the y coordinate on the container of its upper left corner. |
Actions:
| Action | Description |
|---|
| LoadPage |
loadpage action takes two parameters. "Source" contains the URL for the new page to be loaded into the HTML area.The optional parameter "Transition" indicates the type of fade to be used between one page and the next.Currently supported values are "pixelate", "rlwipe", and "lrwipe". |
Sample Code:
$Version=2$
HTMLArea "widget/html"
{
mode = "dynamic";
x = 2; y = 2;
width = 478; height = 396;
source = "http://localhost:800/index.html";
}
Comments...
(none yet)
Add a Comment...
|
