Reference for the Mosaic class Effects::FadeInOutTransition

Effects::FadeInOutTransition
Alignment
Buffered
Duration
MarginBottom
MarginLeft
MarginRight
MarginTop
Effects::Transition
CreateDismissFader()
CreateOverlayFader()
CreatePresentFader()
CreateRestoreFader()

SEE ALSO

How to manage the dialog between user and the GUI application?

How to modify the parameters for the 'Fade-In or Out' (opacity) Dialog transition?

The class Effects::FadeInOutTransition provides functionality for the fade-in/out operation affecting the opacity of a given GUI component. When using the transition for the fade-in operation, the GUI component is automatically arranged to appear (per default centered) within the area of its owner component. This transition is thus ideal wherever one GUI component should smoothly appear or disappear in context of another component.

Per default when the component is displayed, it is aligned in the center of its owner. This can be modified by using the property Alignment. Furthermore, with the four properties MarginLeft, MarginRight, MarginTop and MarginBottom the area to align the component within its owner can be limited.

How long the transition should take is determined in the property Duration, which is per default 500 ms. With the property Buffered you can configure, whether the transition should additionally enable the buffering mode for the affected GUI component while it perform the animation.

property Effects::DialogAlignment Alignment = Effects::DialogAlignment[AlignHorzCenter, AlignVertCenter];

The property 'Alignment' determines how the transition should align the dialog within the boundary area of this dialog's owner. This area can additionally be limitted by specifying margins in the properties MarginLeft, MarginTop, MarginRight and MarginBottom. Based on the specified alignment and margins the transition calculates the position where the dialog should appear. If the transition is used to hide the dialog, the properties have no effect.

property bool Buffered = false;

The property 'Buffered' determines, whether the buffered mode for the affected GUI component should be enabled while the transition is performed. Enabling this mode can optimize (speed up) the screen updates. On the other hand buffering requires additional memory to store inside the actual image of the affected GUI component. It is thus intended for target systems providing sufficient RAM resources.

property int32 Duration = 500;

The property 'Duration' determines how long the fade-in/out transition takes. The value is expressed in milliseconds.

property int32 MarginBottom = 0;

The property 'MarginBottom' determines the gap below the area destined to display the dialog within its owner. Based on the specified margin and the actual value of the Alignment property the transition calculates the vertical position where the dialog should appear. If the transition is used to hide the dialog, the property has no effect.

property int32 MarginLeft = 0;

The property 'MarginLeft' determines the gap on the left of the area destined to display the dialog within its owner. Based on the specified margin and the actual value of the Alignment property the transition calculates the horizontal position where the dialog should appear. If the transition is used to hide the dialog, the property has no effect.

property int32 MarginRight = 0;

The property 'MarginRight' determines the gap on the right of the area destined to display the dialog within its owner. Based on the specified margin and the actual value of the Alignment property the transition calculates the horizontal position where the dialog should appear. If the transition is used to hide the dialog, the property has no effect.

property int32 MarginTop = 0;

The property 'MarginTop' determines the gap above the area destined to display the dialog within its owner. Based on the specified margin and the actual value of the Alignment property the transition calculates the vertical position where the dialog should appear. If the transition is used to hide the dialog, the property has no effect.