ViewableWidget - AppDaddy-Software-Solutions-Inc/framework-markup-language GitHub Wiki

ViewableWidget : Widget

This is an inherited class and cannot be created directly in markup.

Attributes

Name Type Default Description Req
visible bool true Widget is visible or hidden
enabled bool true Widget is enabled or disabled by default
datasource string The id of the data source tied to this widget.
tooltip string A convenience method used to show simple text in a tooltip callout. For more complex layouts, use a <TOOLTIP/>

Color
color color The primary color of the widget. Can be specified as a comma separated list (color, color2, color3 and color4)
color2 color The 2nd color of the widget. Only used by specific widgets. See color above.
color3 color The 3rd color of the widget. Only used by specific widgets. See color above.
color4 color The 4th color of the widget. Only used by specific widgets. See color above.

Sizing
width int / % The width of the widget expressed in pixels or as a percentage of its parent.
height int / % The height of the widget expressed in pixels size or as a percentage of its parent.
maxwidth int / % Infinity The maximum width of the widget
maxheight int / % Infinity The maximum height of the widget
minwidth int / % 0 The minimum width of the widget
minheight int / % 0 The minimum height of the widget
flex double If specfied, this widget is laid out after all of its other fixed width or fixed height siblings are rendered and is allowed to fill a space proportional to the flex factor.

For example, a widget with flex=2 would be allocated twice the remaining space as a sibling with flex=1
flexfit string tight
  • loose : child can be at most as large as the available space, but is allowed to be smaller
  • tight: child is forced to fill the available space.

    Children with flex factors are laid out from first to last until all remaining space has been allocated
    		•

    Padding & Alignment
    center bool false Centers the children. When true, its the same as setting valign="center", halign="center"
    valign string The widgets children vertical alignment.
  • top
  • bottom
  • center
  • around : Place the free space evenly between the children as well as half of that space before and after the first and last child.
  • between : Place the free space evenly between the children.
  • evenly : Place the free space evenly between the children as well as before and after the first and last child
    		•
    halign string The widgets children horizontal alignment.
  • left
  • right
  • center
  • around : Place the free space evenly between the children as well as half of that space before and after the first and last child.
  • between : Place the free space evenly between the children.
  • evenly : Place the free space evenly between the children as well as before and after the first and last child
    		•
    margin, margins double 0 The reserved space (pixels) on the onside of the widget. Can be a single value or a comma seperated list up up to 4 values (Top, Right, Bottom, Left)
    pad, padding double 0 The reserved space (pixels) on the inside of the widget. Can be a single value or a comma sperated list up up to 4 values (Top, Right, Bottom, Left)

    Drag and Drop
    draggable bool false If the widget can be manually dragged using the mouse.
    droppable bool false Widget can be a drop target, allowing draggable widgets to be dropped onto this widget. Refer to the ondrop event below
    candrop string If specified, canDrop is a single or comma seperaated list of draggable widget ids that are permitted to be dropped onto this widget. If left empty, any draggable can be dropped onto this widget. If specified, only draggables with id's in the list are permitted

    Resize
    resizeable bool false Creates a widget with a resize handle, that when dragged, changes the widgets width and height.

    Can be specified as a comma separated list (width, height) for setting resizeablewidth and resizeableheight.
    resizeablewidth bool false If the widget can be manually resized horizontally
    resizeableheight bool false If the widget can be manually resized vertically

    Transforms
    opacity double 1 The opacity of the widget and its children from 0.0 (invisible) - 1.0 (normal)
    rotate double 0 The angle rotation of the widget as expressed as a value between 0-360 degrees.
    flip string Flips the widget across the specified axis.
  • vertical
  • horizontal
    		•

    Properties

    Name Values Description
    visiblearea double Percent (0-100) of widget that is visible on screen
    visibleheight double Percent (0-100) of the widget's height that is visible on screen
    visiblewidth double Percent (0-100) of the widget's width that is visible on screen
    viewwidth double The width in screen pixels of the rendered widget
    viewheight double The height in screen pixels of the rendered widget
    viewx double The horizontal pixel offset of the rendered widget relative to its parent
    viewy double The vertical pixel offset of the rendered widget relative to its parent

    Events

    Name Description
    onscreen Fires when the widget come on screen
    offscreen Fires when the widget goes off screen
    ondrag If draggable, fires when the widget starts its drag operation
    ondropped If draggable, fires when the dragged widget is dropped onto a droppable widget, the droppable's onDropped event string is fired. Bindings {drop.} refer to the data element of the dragged widget
    ondrop When a draggable widget is dropped onto a droppable widget, the drggable's onDrop event string is fired. This happens after the onDropped event. Bindings {drop.} refer to the data element of the dragged widget

    Other Links You May Find Useful:

    Framework Markup Language is an open source programming language created by AppDaddy Software Solutions Inc. FML and is licensed under a fair source license agreement and is maintained by a community of developers.

    ⚠️ **GitHub.com Fallback** ⚠️