Reference for the Mosaic class Effects::ShowHideTransition

Effects::ShowHideTransition
Alignment
HideAtStart
MarginBottom
MarginLeft
MarginRight
MarginTop
ShowAtStart
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 'Show or Hide' (visibility) Dialog transition?

The class Effects::ShowHideTransition provides functionality for the most primitive fade-in/out operation affecting the pure visibility 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 instantly appear or disappear in context of another component without any animation effects.

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.

Please note, with this transition the fade-in operation is performed just at the beginning of all other transitions running simultaneously, in other words, the GUI component appears during the start phase of the transition. In turn, to fade-out the component, the operation is executed during the end phase of the transition. This behavior can be modified by using the properties ShowAtStart and HideAtStart.

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 HideAtStart = false;

The property 'HideAtStart' determines the transition phase, when the affected GUI component should disappear. Initializing this property with the value 'true' causes the GUI component to be hidden just at the beginning of the transition. Initializing the property with the value 'false' causes the component to be hidden at the end of the transition. Using this property is essential only when the transition is intended to perform its animation simultaneously with other transition instances.

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.

property bool ShowAtStart = true;

The property 'ShowAtStart' determines the transition phase, when the affected GUI component should appear. Initializing this property with the value 'true' causes the GUI component to be shown just at the beginning of the transition. Initializing the property with the value 'false' causes the component to be shown at the end of the transition. Using this property is essential only when the transition is intended to perform its animation simultaneously with other transition instances.