Module flower.widget.DialogBox
This is the class that displays a message in the panel.
Extends:
Info:
- Release: V3.0.0
- Author: Makoto
Functions
DialogBox:_initInternal () | Initializes the internal variables. |
DialogBox:_createChildren () | Create a child objects. |
DialogBox:_createAnimations () | Create a animation objects. |
DialogBox:updateDisplay () | Update the display. |
DialogBox:spoolingEnabled (enable) | Turns spooling ON or OFF. |
DialogBox:show (scene) | Displays a message box in the pop-up effect. |
DialogBox:hide () | To hide the message box in the pop-up effect. |
DialogBox:spool () | Spools the text. |
DialogBox:nextPage () | Displays the next page. |
DialogBox:more () | Returns the next page if exists. |
DialogBox:isBusy () | Returns in the process whether messages are displayed. |
DialogBox:setType (value) | Sets the type. |
DialogBox:getType () | Returns the type |
DialogBox:setButtons (...) | Sets the Buttons. |
DialogBox:getButtons () | Sets the type |
DialogBox:setTitle (title) | Sets the title. |
DialogBox:getTitle () | Returns the title |
DialogBox:setText (text) | Sets the text. |
DialogBox:getText () | Returns the text. |
DialogBox:setTextColor (r, g, b, a) | Sets the color of the text. |
DialogBox:setTextSize (points) | Sets the size of the text. |
DialogBox:setOnShow (func) | Sets the event listener was called to display a message box. |
DialogBox:setOnHide (func) | Sets the event listener was called to hide a message box. |
DialogBox:setOnResult (func) | Sets the event listener was called to end a message box. |
Fields
STYLE_FONT_NAME | Style: fontName |
STYLE_TEXT_COLOR | Style : textColor |
STYLE_TEXT_SIZE | Style : textSize |
STYLE_BUTTONS_PADDING | Style : buttonsPadding |
STYLE_TITLE_PADDING | Style : titlePadding |
STYLE_TITLE_COLOR | Style : titleColor |
STYLE_TITLE_SIZE | Style : titleSize |
STYLE_TITLE_FONT_NAME | Style : titleFontName |
STYLE_ICON_PADDING | Style : iconPadding |
STYLE_ICON_SCALE_FACTOR | Style : iconScaleFactor |
EVENT_SHOW | Event: show |
EVENT_HIDE | Event: hide |
EVENT_RESULT | Event: result |
TYPE_INFO | Type : Info |
TYPE_CONFIRM | Type : Confirm |
TYPE_WARNING | Type : Warning |
TYPE_ERROR | Type : Error |
Functions
- DialogBox:_initInternal ()
- Initializes the internal variables.
- DialogBox:_createChildren ()
- Create a child objects.
- DialogBox:_createAnimations ()
- Create a animation objects.
- DialogBox:updateDisplay ()
- Update the display.
- DialogBox:spoolingEnabled (enable)
-
Turns spooling ON or OFF.
If self is currently spooling and enable is false, stop spooling and reveal
entire page.
Parameters:
- enable Boolean for new state
Returns:
-
none
- DialogBox:show (scene)
-
Displays a message box in the pop-up effect.
Parameters:
- scene
- DialogBox:hide ()
- To hide the message box in the pop-up effect.
- DialogBox:spool ()
- Spools the text.
- DialogBox:nextPage ()
- Displays the next page.
- DialogBox:more ()
-
Returns the next page if exists.
Returns:
-
If the next page there is a true
- DialogBox:isBusy ()
-
Returns in the process whether messages are displayed.
Returns:
-
busy
- DialogBox:setType (value)
-
Sets the type.
Parameters:
- value type
- DialogBox:getType ()
-
Returns the type
Returns:
-
type
- DialogBox:setButtons (...)
-
Sets the Buttons.
Parameters:
- ... button
- DialogBox:getButtons ()
-
Sets the type
Returns:
-
type
- DialogBox:setTitle (title)
-
Sets the title.
Parameters:
- title title
- DialogBox:getTitle ()
-
Returns the title
Returns:
-
title
- DialogBox:setText (text)
-
Sets the text.
Parameters:
- text text
- DialogBox:getText ()
-
Returns the text.
Returns:
-
text
- DialogBox:setTextColor (r, g, b, a)
-
Sets the color of the text.
Parameters:
- r red
- g green
- b blue
- a alpha
- DialogBox:setTextSize (points)
-
Sets the size of the text.
Parameters:
- points points
- DialogBox:setOnShow (func)
-
Sets the event listener was called to display a message box.
Parameters:
- func event listener
- DialogBox:setOnHide (func)
-
Sets the event listener was called to hide a message box.
Parameters:
- func event listener
- DialogBox:setOnResult (func)
-
Sets the event listener was called to end a message box.
Parameters:
- func event listener
Fields
- STYLE_FONT_NAME
- Style: fontName
- STYLE_TEXT_COLOR
- Style : textColor
- STYLE_TEXT_SIZE
- Style : textSize
- STYLE_BUTTONS_PADDING
- Style : buttonsPadding
- STYLE_TITLE_PADDING
- Style : titlePadding
- STYLE_TITLE_COLOR
- Style : titleColor
- STYLE_TITLE_SIZE
- Style : titleSize
- STYLE_TITLE_FONT_NAME
- Style : titleFontName
- STYLE_ICON_PADDING
- Style : iconPadding
- STYLE_ICON_SCALE_FACTOR
- Style : iconScaleFactor
- EVENT_SHOW
- Event: show
- EVENT_HIDE
- Event: hide
- EVENT_RESULT
- Event: result
- TYPE_INFO
- Type : Info
- TYPE_CONFIRM
- Type : Confirm
- TYPE_WARNING
- Type : Warning
- TYPE_ERROR
- Type : Error