Overview

Packages

  • Actions
  • Codegen
  • Controls
    • Base
  • DatabaseAdapters
  • Events
  • None
  • Sessions
  • Tests

Classes

  • BasicForm
  • CalculatorWidget
  • DataRepeaterExample
  • ExampleCheckColumn1
  • ExampleCheckColumn2
  • ExampleSingleForm
  • NestedTabForm
  • PaginatorForm
  • ParamsForm
  • PersistentExampleForm
  • PersonEditPanel
  • PluginEditForm
  • PluginManagerForm
  • ProjectEditPanel
  • ProjectListForm
  • ProjectViewPanel
  • QAccordion
  • QActionControl
  • QAutocomplete
  • QBlockControl
  • QButton
  • QButtonBase
  • QCalendar
  • QCheckBox
  • QCheckBoxLegacyColumn
  • QCheckBoxList
  • QControl
  • QControlBase
  • QControlGrouping
  • QControlLabel
  • QCsvTextBox
  • QDataGrid
  • QDataGrid_CheckBoxColumn
  • QDataGrid_SortEvent
  • QDataGridBase
  • QDataGridLegacy
  • QDataGridLegacyBase
  • QDataGridLegacyColumn
  • QDataGridLegacyRow
  • QDataGridLegacyRowStyle
  • QDataRepeater
  • QDatepicker
  • QDatepickerBox
  • QDateTimePicker
  • QDateTimeTextBox
  • QDialog
  • QDialogBox
  • QDraggable
  • QDroppable
  • QDropZoneGrouping
  • QEmailTextBox
  • QFileAsset
  • QFileAssetBase
  • QFileAssetDialog
  • QFileControl
  • QFilterType
  • QFloatTextBox
  • QFontFamily
  • QForm
  • QFormBase
  • QHListItem
  • QHtmlAttributeManager
  • QHtmlAttributeManagerBase
  • QHtmlTable
  • QHtmlTableBase
  • QImageBase
  • QImageBrowser
  • QImageBrowserBase
  • QImageBrowserNav
  • QImageBrowserThumbnails
  • QImageButton
  • QImageControl
  • QImageControlBase
  • QImageFileAsset
  • QImageLabel
  • QImageLabelBase
  • QImageRollover
  • QIntegerTextBox
  • QJqButton
  • QJqCheckBox
  • QJqRadioButton
  • QJsTimer
  • QJsTimerBase
  • QLabel
  • QLinkButton
  • QListBox
  • QListBoxBase
  • QListControl
  • QListItem
  • QListItemBase
  • QListItemStyle
  • QNumericTextBox
  • QPaginatedControl
  • QPaginator
  • QPaginatorBase
  • QPanel
  • QProgressbar
  • QRadioButton
  • QRadioButtonList
  • QResizable
  • QSampleControl
  • QSelectable
  • QSlider
  • QSortable
  • QTabs
  • QTagStyler
  • QTestControl
  • QTextBox
  • QTimerExpiredEvent
  • QTreeNav
  • QTreeNavItem
  • QUrlTextBox
  • QWaitIcon
  • QWriteBox
  • RecordsSummary
  • RefreshForm
  • SampleForm
  • SelectableLabel
  • SpeedForm
  • TestImageBrowser
  • UrlForm

Traits

  • QListItemManager

Exceptions

  • QCrossScriptingException

Functions

  • __QForm_EvaluateTemplate_ObHandler
  • DataGridEvalHandleError
  • Overview
  • Package
  • Class

Class QForm

QForm is one of the most important parts of QCubed - it is what ultimately creates the web page

QForm is based on QFormBase class and is supposed to be used against QForm. The reason for such recommendation is - QFormBase is a lengthy, confusing and very important file. If you want to modify any behavior or QFormBase, please override the corresponding method here. If you want to add a new feature, add it as a method in this class.

QBaseClass
Extended by QFormBase
Extended by QForm

Direct known subclasses

AjaxTimingForm, BasicForm, PluginManagerForm, ProjectListForm, RefreshForm, SampleForm, SpeedForm, TestImageBrowser, UrlForm, DataRepeaterExample, ExampleSingleForm, InjectForm, NestedTabForm, PaginatorForm, ParamsForm, PersistentExampleForm, PluginEditForm
Abstract
Package: Controls
Author: Qcubed
Located at install/project/includes/controls/QForm.class.php
Methods inherited from QFormBase
AddControl(), AddGrouping(), CallDataBinder(), CheckableControlValue(), EvaluateTemplate(), Form_Create(), Form_Exit(), Form_Initialize(), Form_Invalid(), Form_Load(), Form_PreRender(), Form_Run(), Form_Validate(), GenerateAjaxActionId(), GenerateControlId(), GetAllControls(), GetAllGroupings(), GetChildControls(), GetControl(), GetCssFileUri(), GetCustomAttribute(), GetErrorControls(), GetErrorMessages(), GetFormJavaScripts(), GetGrouping(), GetJsFileUri(), GetModifiedControls(), InvalidFormState(), IsControlModified(), IsPostBack(), ProcessJavaScriptList(), ProcessStyleSheetList(), RemoveControl(), RemoveCustomAttribute(), RemoveGrouping(), Render(), RenderAjax(), RenderAjaxHelper(), RenderBegin(), RenderChildren(), RenderEnd(), RenderStyles(), ResetValidationStates(), RestoreControlState(), Run(), SaveControlState(), Serialize(), SetCustomAttribute(), TriggerActions(), TriggerMethod(), UnpackPostVar(), Unserialize(), ValidateControlAndChildren(), VarExport(), __construct(), __get(), __set()
Methods inherited from QBaseClass
OverrideAttributes(), __call()
Constants inherited from QFormBase
FormStatusRenderBegun, FormStatusRenderEnded, FormStatusUnrendered
Properties summary
public static string $EncryptionKey

If you wish to encrypt the resulting formstate data to be put on the form (via QCryptography), please specify a key to use. The default cipher and encrypt mode on QCryptography will be used, and because the resulting encrypted data will be sent via HTTP POST, it will be Base64 encoded.

If you wish to encrypt the resulting formstate data to be put on the form (via QCryptography), please specify a key to use. The default cipher and encrypt mode on QCryptography will be used, and because the resulting encrypted data will be sent via HTTP POST, it will be Base64 encoded.

# null
public static string $FormStateHandler

The QFormStateHandler to use to handle the actual serialized form. Please refer configuration.inc.php file (in includes/configuration directory) to learn more about what FORM_STATE_HANDLER does. Though you can change it here, try to change the FORM_STATE_HANDLER in the configuration file alone.

The QFormStateHandler to use to handle the actual serialized form. Please refer configuration.inc.php file (in includes/configuration directory) to learn more about what FORM_STATE_HANDLER does. Though you can change it here, try to change the FORM_STATE_HANDLER in the configuration file alone.

It overrides the default value in the QFormBase Class file

# __FORM_STATE_HANDLER__
protected array $strIgnoreJavaScriptFileArray

These are the list of core QForm JavaScript files, or JavaScript files needed by a QControl, which QForm should IGNORE trying to load during a RenderBegin() or RenderAjax() call.

These are the list of core QForm JavaScript files, or JavaScript files needed by a QControl, which QForm should IGNORE trying to load during a RenderBegin() or RenderAjax() call.

It is used in the ProcessJavaScriptList function in the QFormBase class.

# array()
protected array $strIgnoreStyleSheetFileArray

This should be very rarely used.

This should be very rarely used.

This mechanism acts similarly to the strIgnoreJavascriptFileArray, except it applies to StyleSheets. However, any QControl that specifies a StyleSheet file to include is MEANT to have that property be modified / customized.

Therefore, there should be little to no need for this attribute. However, it is here anyway, just in case. Also note that QFormBase does not implement its feature. It is there if you (a developer building your application using QCubed) want to use it.

# array()
Properties inherited from QFormBase
$blnRenderedBodyTag, $blnStylesRendered, $checkableControlValues, $intFormStatus, $intNextAjaxActionId, $intNextControlId, $objControlArray, $objDefaultWaitIcon, $objGroupingArray, $strCallType, $strCssClass, $strCustomAttributeArray, $strFormAttributeArray, $strFormId, $strHtmlIncludeFilePath, $strIncludedJavaScriptFileArray, $strIncludedStyleSheetFileArray, $strPreviousRequestMode
Magic properties inherited from QFormBase
$CallType, $CssClass, $DefaultWaitIcon, $FormId, $FormStatus, $HtmlIncludeFilePath
API documentation generated by ApiGen