LimeSurvey API - Master branch

PreviewModalWidget extends CWidget

in package

• Application

Used for question type select, display export options.

Tags

todo

Split into two widgets?

Table of Contents

Properties

$buttonClasses  : array<string|int, string>

If the button should have any extra classes or modifications.

$closeButton  : string

These are pretty standard and may not need to be changed

$currentSelected  : string

This may be the value also, but oftentimes you'd want this to be an easy to read title

$debug  : bool

$debugKeyCheck  : string

Display this with the items key in debug mode

$groupItemsKey  : string

If using the grouped view this should be the key of the grouped items array key

$groupStructureArray  : array<string|int, mixed>

Either a group or an items array must be given

$groupTitleKey  : string

If using the grouped view this should be the key to get the group title

$iconPosition  : string

The position the icon has in the modal button

$itemsArray  : array<string|int, mixed>

$modalTitle  : string

The title the widgets modal will have

$optionArray  : array<string|int, mixed>

This is the option array that gets fed into the javascript.

$previewWindowTitle  : string

The title of the preview window

$renderType  : string

RenderType should either be modal, simple, group-simple or group-modal

$selectButton  : string

$survey_active  : bool

$theme  : string

QuestionTheme name

$value  : mixed

There should be a value set

$widgetsJsName  : string

The name the widget will be rendered to, please make sure it is unique!

Methods

getButtonOrSelect()  : string|void

getModal()  : string|void

getView()  : string

run()  : void

registerScripts()  : void