VEGAS JS

Class: Layout

graphics. Layout

new Layout()

A base class that manages the layout rendering in visual elements on the screen of your applications.

A base class that manages layouts in visual elements on the screen of your applications.

Extends

Members

align :number

The alignement of the layout.

Type:
  • number
Default Value:
  • graphics.Align.TOP_LEFT
See:

<readonly> bounds :graphics.geom.Rectangle

A rectangle that defines the current visible area of the layout.

Type:

<readonly> bufferMode :graphics.LayoutBufferMode

A rectangle that defines the current visible area of the layout.

Type:
Default Value:
  • LayoutBufferMode.AUTO

<constant> changeIt :system.signals.Signal

The signal emit when the task is changed.

Type:
Inherited From:

<constant> clearIt :system.signals.Signal

The signal emit when the task is cleared.

Type:
Inherited From:

container

Indicates the container reference to change with the layout.

<constant> finishIt :system.signals.Signal

This signal emit when the action is finished.

Type:
Inherited From:

<constant> infoIt :system.signals.Signal

The signal emit when the task emit a message.

Type:
Inherited From:

looping :boolean

The flag to determinate if the task must be looped.

Type:
  • boolean
Inherited From:
Default Value:
  • false

<constant> loopIt :system.signals.Signal

The signal emit when the task is looped.

Type:
Inherited From:

<readonly> measuredHeight :number

The default height of the layout, in pixels.

Type:
  • number

<readonly> measuredWidth :number

The default width of the layout, in pixels.

Type:
  • number

<constant> pauseIt :system.signals.Signal

The signal emit when the task is paused.

Type:
Inherited From:

<readonly> phase :string

Indicates the current phase.

Type:
  • string
Inherited From:
See:

<constant> progressIt :system.signals.Signal

The signal emit when the task is in progress.

Type:
Inherited From:

<constant> renderer :system.signals.Signal

The signal invoked when the render method is called.

Type:

<constant> resumeIt :system.signals.Signal

The signal emit when the task is resumed.

Type:
Inherited From:

<readonly> running :boolean

Indicates action is running.

Type:
  • boolean
Inherited From:

<constant> startIt :system.signals.Signal

This signal emit when the action is started.

Type:
Inherited From:

<constant> stopIt :system.signals.Signal

This signal emit when the task is stopped.

Type:
Inherited From:

<constant> timeoutIt :system.signals.Signal

The signal emit when the task is out of time.

Type:
Inherited From:

<constant> updater :system.signals.Signal

The signal invoked when the update method is called.

Type:

Methods

clone()

Creates a copy of the object.

Inherited From:
Returns:

a shallow copy of this object.

initialize( [children])

Initialize the layout container with the specific elements. This method flush the layout container and remove all old elements register in the collection before initialize it.

Parameters:
Name Type Argument Default Description
children Array <optional>
 null

An Array, a container or a list of element references to register. If this argument is null the layout is only flushed.

isLocked()

Returns true if the object is locked.

Inherited From:
Implements:
Returns:

true if the object is locked.

lock()

Locks the object.

Inherited From:
Implements:

measure()

Calculates the default sizes and minimum and maximum values. You can overrides this method in the specific layouts.

notifyChanged()

Notify when the process is changed.

Inherited From:

notifyCleared()

Notify when the process is cleared.

Inherited From:

notifyFinished()

Notify when the process is finished.

Inherited From:

notifyInfo()

Notify a specific information when the process is changed.

Inherited From:

notifyLooped()

Notify when the process is looped.

Inherited From:

notifyPaused()

Notify when the process is paused.

Inherited From:

notifyProgress()

Notify when the process is progress.

Inherited From:

notifyResumed()

Notify when the process is resumed.

Inherited From:

notifyStarted()

Notify when the process is started.

Inherited From:

notifyStopped()

Notify when the process is stopped.

Inherited From:

notifyTimeout()

Notify when the process is out of time.

Inherited From:

render()

Render the layout, refresh and change the position of all childs in a specific container.

reset()

Resets the task.

Inherited From:
Implements:

resume()

Resumes the task.

Inherited From:

run()

Run the process.

Overrides:

start()

Starts the task.

Inherited From:
Implements:

stop()

Starts the process.

Inherited From:
Implements:

unlock()

Unlocks the object.

Inherited From:
Implements:

update()

This method is invoked when the rendering is finished to finalize the it after the measure invokation.