Table of Contents
About #
This class is the visual representation of the backdrop for GraffitiModalContainers and provides additional functionality to the GraffitiModal controller.
Enumerations #
| Name | Value |
|---|---|
| AnimationStyles | Fade SlideUp SlideDown SlideLeft SlideRight Grow Reveal RollHorizontal RollVertical WindowShade Doors None |
| Placements | LeftTop LeftMiddle LeftBottom CenterTop CenterMiddle CenterBottom RightTop RightMiddle RightBottom |
Constants #
This class exposes no constants.
Events #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| DataAvailable | modal as GraffitiModalInstance data as Dictionary | None | Raised when calling the Action method from within a GraffitiModalContainer. |
| Hidden | None | None | Raised when a modal instance has been hidden. |
| Paint | g as graphics areas() as Rect | None | Raised after all other drawing is complete. Can be used to customize appearance. |
| Shown | None | None | Raised when a modal instance has been shown. |
Methods #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| Constructor | name as String container as GraffitiModalContainer | None | Creates a new instance of the class with the specified properties. |
| Hide | None | None | Hides the modal instance, if visible. |
| Resize | None | None | Forces a resize and redraw to match changed parent dimensions. |
| Show | None | None | Begins the animation process to show the modal instance. Modal will not be completely shown until the Shown event is fired. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| AnimationEasing | GraffitiAnimator.Easings | Linear | Determines the curve of the animation operation. |
| AnimationLength | Integer | 750 | Time in milliseconds that the class will use for in/our animation before completing. |
| AnimationStyle | AnimationStyles | Fade | The method of drawing for in/out animations. |
| BackgroundColor | ColorGroup | Nil | Color applied to the child container’s area during animation and while visible. |
| BorderRadius | Integer | 0 | Size, in points, of the radius applied to the corners of the container’s drawn area. |
| Container | GraffitiModalContainer | Nil | The container object that is drawn for this instance. Read-only after Constructor. |
| DismissOnPress | Boolean | False | When True, if the user clicks on the backdrop around the container’s area, the modal will be hidden. |
| Placement | Placements | CenterMiddle | Position of the modal instance within the parent window. |
| PlacementBoundaryMargin | Integer | 10 | Determines distance from the window’s edge when using an outside placement. |
| Tag | Variant | Nil | Developer storage. |