API Docs for: 0.0.2
Show:

Window Class

Extends FramedView
Defined in: api/src/window.js:1
Module: ludo

Class for floating window

Constructor

Window

(
  • config
)

Defined in api/src/window.js:1

Parameters:

Example:

new ludo.Window({
   width:500,height:500,
   left:100,top:100,
   layout:'cols',
   children:[{
        layout:{
            weight:1
        },
       html : 'Panel 1'
   },{
        layout:{
            weight:1
        },
        html: 'Panel 2'
   }]
});

Methods

showAt

(
  • x
  • y
)

Defined in api/src/window.js:175

Show window at x and y position

Parameters:

Returns:

void

showCentered

()

Defined in api/src/window.js:202

Show window centered on screen

Returns:

void

Attributes

height

Number

Defined in api\src\window.js:58

Height of window

Default: 200

Fires event heightChange

Fires when the value for the configuration attribute height is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

hideBodyOnMove

Boolean

Defined in api\src\window.js:81

Hide content of window while moving/dragging the window

Default: false

Fires event hideBodyOnMoveChange

Fires when the value for the configuration attribute hideBodyOnMove is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

left

Number

Defined in api\src\window.js:46

Left position of window

Default: undefined

Fires event leftChange

Fires when the value for the configuration attribute left is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

movable

Boolean

Defined in api\src\window.js:30

True to make the window movable

Default: true

Fires event movableChange

Fires when the value for the configuration attribute movable is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

preserveAspectRatio

Boolean

Defined in api\src\window.js:88

Preserve aspect ratio when resizing

Default: false

Fires event preserveAspectRatioChange

Fires when the value for the configuration attribute preserveAspectRatio is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resizeLeft

Boolean

Defined in api\src\window.js:72

When set to true, resize handle will be added to the left ludo of the window. This can be useful to turn off when you're extending the ludo.Window component to create custom components where left position should be fixed.

Default: true

Fires event resizeLeftChange

Fires when the value for the configuration attribute resizeLeft is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

resizeTop

Boolean

Defined in api\src\window.js:64

When set to true, resize handle will be added to the top ludo of the window. This can be useful to turn off when you're extending the ludo.Window component to create custom components where top position should be fixed.

Default: true

Fires event resizeTopChange

Fires when the value for the configuration attribute resizeTop is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

top

Number

Defined in api\src\window.js:40

Top position of window

Default: undefined

Fires event topChange

Fires when the value for the configuration attribute top is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

width

Number

Defined in api\src\window.js:52

Width of window

Default: 300

Fires event widthChange

Fires when the value for the configuration attribute width is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.