classQControlBase
QControlBase Class Reference
Inherits QBaseClass.Inherited by QControl.

Public Member Functions
- __construct ($objParentObject, $strControlId=null)
- Persist ()
- AddChildControl (QControl $objControl)
- GetChildControls ($blnUseNumericIndexes=true)
- GetChildControl ($strControlId)
- RemoveChildControls ($blnRemoveFromForm)
- RemoveChildControl ($strControlId, $blnRemoveFromForm)
- AddAction ($objEvent, $objAction)
- AddActionArray ($objEvent, $objActionArray)
- RemoveAllActions ($strEventName)
- GetAllActions ($strEventType, $strActionType=null)
- SetCustomAttribute ($strName, $strValue)
- GetCustomAttribute ($strName)
- RemoveCustomAttribute ($strName)
- SetCustomStyle ($strName, $strValue)
- GetCustomStyle ($strName)
- RemoveCustomStyle ($strName)
- AddCssClass ($strCssClassName)
- RemoveCssClass ($strCssClassName)
- ParsePostData ()
- GetAttributes ($blnIncludeCustom=true, $blnIncludeAction=true)
- GetCustomAttributes ()
- GetActionAttributes ()
- GetJavaScriptForEvent ($strEventName)
- GetStyleAttributes ()
- Focus ()
- Blink ($strFromColor= '#ffff66', $strToColor= '#ffffff')
- GetEndScript ()
- GetEndHtml ()
- Refresh ()
- Render ($blnDisplayOutput=true)
- RenderAjax ($blnDisplayOutput=true)
- SetFocus ()
- RenderWithError ($blnDisplayOutput=true)
- Validate ()
- ResetFlags ()
- ResetOnPageStatus ()
- MarkAsModified ()
- MarkAsWrapperModified ()
- SetForm ($objForm)
- SetParentControl ($objControl)
- ValidationReset ()
- VarExport ($blnReturn=true)
- __get ($strName)
- __set ($strName, $mixValue)
Static Public Member Functions
- static CreatePersistent ($strClassName, $objParentObject, $strControlId)
Protected Member Functions
- PersistPrepare ()
- RenderHelper ($mixParameterArray, $strRenderMethod)
- GetNonWrappedHtml ()
- RenderOutput ($strOutput, $blnDisplayOutput, $blnForceAsBlockElement=false)
- GetControlHtml ()
- RenderChildren ($blnDisplayOutput=true)
Protected Attributes
- $strBackColor = null
- $strBorderColor = null
- $strBorderStyle = QBorderStyle::NotSet
- $strBorderWidth = null
- $strCssClass = null
- $blnDisplay = true
- $strDisplayStyle = QDisplayStyle::NotSet
- $blnFontBold = false
- $blnFontItalic = false
- $strFontNames = null
- $blnFontOverline = false
- $strFontSize = null
- $blnFontStrikeout = false
- $blnFontUnderline = false
- $strForeColor = null
- $intOpacity = null
- $strAccessKey = null
- $mixCausesValidation = false
- $strCursor = QCursor::NotSet
- $blnEnabled = true
- $blnRequired = false
- $intTabIndex = 0
- $strToolTip = null
- $strValidationError = null
- $blnVisible = true
- $strHeight = null
- $strWidth = null
- $strHtmlBefore = null
- $strHtmlAfter = null
- $strInstructions = null
- $strWarning = null
- $strOverflow = QOverflow::NotSet
- $strPosition = QPosition::NotSet
- $strTop = null
- $strLeft = null
- $blnMoveable = false
- $strControlId
- $objForm = null
- $objParentControl = null
- $objChildControlArray = array()
- $strName = null
- $blnRendered = false
- $blnRendering = false
- $blnOnPage = false
- $blnModified = false
- $blnWrapperModified = false
- $strRenderMethod
- $strCustomAttributeArray = null
- $strCustomStyleArray = null
- $objActionArray = array()
- $strActionParameter = null
- $strJavaScripts = null
- $strStyleSheets = null
- $strFormAttributes = null
- $blnActionsMustTerminate = false
- $blnIsBlockElement = false
Constructor & Destructor Documentation
| QControlBase::__construct | ( | $ | objParentObject, | |
| $ | strControlId = null | |||
| ) |
Reimplemented in QDataGridBase, QFileAssetBase, QFloatTextBox, QImageBase, QImageControlBase, QIntegerTextBox, QListBoxBase, QPaginatedControl, QPaginatorBase, QTextBoxBase, QWaitIcon, QWriteBox, QDataGrid, QFileAsset, QPaginator, and QSampleControl.
References $strControlId, and QCallerException::IncrementOffset().
Member Function Documentation
| QControlBase::__get | ( | $ | strName | ) |
Override method to perform a property "Get" This will get the value of $strName All inhereted objects that call __get() should always fall through to calling parent::__get() in a try/catch statement catching for CallerExceptions.
- Parameters:
-
string $strName Name of the property to get
- Returns:
- mixed the returned property
Reimplemented from QBaseClass.
Reimplemented in QBlockControl, QButtonBase, QCalendar, QCalendarPopup, QCheckBox, QCheckBoxList, QControlLabel, QDataGridBase, QDataRepeater, QDateTimePicker, QDateTimeTextBox, QDialogBox, QFileAssetBase, QFileControl, QFloatTextBox, QImageBase, QImageButton, QImageControlBase, QImageLabelBase, QImageRollover, QIntegerTextBox, QLinkButton, QListBoxBase, QListControl, QPaginatedControl, QPaginatorBase, QRadioButton, QRadioButtonList, QTextBoxBase, QTreeNav, QWaitIcon, QWriteBox, QPaginator, and QSampleControl.
References $strName, and QCallerException::IncrementOffset().
| QControlBase::__set | ( | $ | strName, | |
| $ | mixValue | |||
| ) |
Override method to perform a property "Set" This will set the property $strName to be $mixValue All inhereted objects that call __set() should always fall through to calling parent::__set() in a try/catch statement catching for CallerExceptions.
- Parameters:
-
string $strName Name of the property to set string $mixValue New value of the property
- Returns:
- mixed the property that was set
Reimplemented from QBaseClass.
Reimplemented in QBlockControl, QButtonBase, QCalendar, QCalendarPopup, QCheckBox, QCheckBoxList, QControlLabel, QDataGridBase, QDataRepeater, QDateTimePicker, QDateTimeTextBox, QDialogBox, QFileAssetBase, QFileControl, QFloatTextBox, QImageBase, QImageButton, QImageControlBase, QImageLabelBase, QImageRollover, QIntegerTextBox, QLinkButton, QListBoxBase, QListControl, QPaginatedControl, QPaginatorBase, QRadioButton, QRadioButtonList, QTextBoxBase, QTreeNav, QWaitIcon, QWriteBox, QPaginator, and QSampleControl.
References $strName, QDisplayStyle::Block, QType::Boolean, QType::Cast(), QCallerException::IncrementOffset(), QDisplayStyle::Inline, QType::Integer, MarkAsWrapperModified(), and QType::String.
| QControlBase::AddAction | ( | $ | objEvent, | |
| $ | objAction | |||
| ) |
Reimplemented in QCalendar.
Referenced by QPaginatorBase::__construct(), QDataGridBase::__construct(), QPaginatorBase::__set(), QDataGridBase::__set(), and AddActionArray().
| QControlBase::AddActionArray | ( | $ | objEvent, | |
| $ | objActionArray | |||
| ) |
References $objActionArray, and AddAction().
| QControlBase::AddChildControl | ( | QControl $ | objControl | ) |
| QControlBase::AddCssClass | ( | $ | strCssClassName | ) |
This will add a CssClass name to the CssClass property (if it does not yet exist), updating the CssClass property accordingly.
- Parameters:
-
string $strCssClassName
References $strCssClass.
| QControlBase::Blink | ( | $ | strFromColor = '#ffff66', |
|
| $ | strToColor = '#ffffff' | |||
| ) |
Referenced by QFileAssetDialog::ShowError().
| static QControlBase::CreatePersistent | ( | $ | strClassName, | |
| $ | objParentObject, | |||
| $ | strControlId | |||
| ) | [static] |
References $objForm, $objParentControl, $strControlId, and QCallerException::IncrementOffset().
| QControlBase::Focus | ( | ) |
| QControlBase::GetActionAttributes | ( | ) |
| QControlBase::GetAllActions | ( | $ | strEventType, | |
| $ | strActionType = null | |||
| ) |
| QControlBase::GetAttributes | ( | $ | blnIncludeCustom = true, |
|
| $ | blnIncludeAction = true | |||
| ) |
Reimplemented in QDataGridBase, QImageButton, QListBoxBase, and QTextBoxBase.
References GetActionAttributes(), and GetCustomAttributes().
Referenced by QSampleControl::GetControlHtml(), QPaginator::GetControlHtml(), QWaitIcon::GetControlHtml(), QTreeNav::GetControlHtml(), QLinkButton::GetControlHtml(), QImageRollover::GetControlHtml(), QImageLabelBase::GetControlHtml(), QImageControlBase::GetControlHtml(), QImageBase::GetControlHtml(), QFileControl::GetControlHtml(), QDateTimePicker::GetControlHtml(), QDataRepeater::GetControlHtml(), QControlLabel::GetControlHtml(), QCalendar::GetControlHtml(), QButtonBase::GetControlHtml(), and QBlockControl::GetControlHtml().
| QControlBase::GetChildControl | ( | $ | strControlId | ) |
References $strControlId.
| QControlBase::GetChildControls | ( | $ | blnUseNumericIndexes = true |
) |
Referenced by RenderChildren(), RenderHelper(), and QFormBase::ValidateControlAndChildren().
| QControlBase::GetControlHtml | ( | ) | [abstract, protected] |
Reimplemented in QBlockControl, QButtonBase, QCalendar, QCalendarPopup, QCheckBox, QCheckBoxList, QControlLabel, QControlProxy, QDataGridBase, QDataRepeater, QDateTimePicker, QDialogBox, QFileAssetBase, QFileControl, QImageBase, QImageButton, QImageControlBase, QImageLabelBase, QImageRollover, QLinkButton, QListBoxBase, QRadioButton, QRadioButtonList, QTextBoxBase, QTreeNav, QWaitIcon, QPaginator, and QSampleControl.
Referenced by Render(), RenderWithError(), and QControl::RenderWithName().
| QControlBase::GetCustomAttribute | ( | $ | strName | ) |
References $strName.
| QControlBase::GetCustomAttributes | ( | ) |
| QControlBase::GetCustomStyle | ( | $ | strName | ) |
References $strName.
| QControlBase::GetEndHtml | ( | ) |
| QControlBase::GetEndScript | ( | ) |
Reimplemented in QBlockControl, QCalendar, QDialogBox, and QImageRollover.
| QControlBase::GetJavaScriptForEvent | ( | $ | strEventName | ) |
| QControlBase::GetNonWrappedHtml | ( | ) | [protected] |
Referenced by RenderOutput().
| QControlBase::GetStyleAttributes | ( | ) |
Reimplemented in QBlockControl, QDataGridBase, QImageLabelBase, and QWaitIcon.
References $strBorderWidth, QType::Cast(), QType::Integer, QBrowserType::InternetExplorer, QOverflow::NotSet, QCursor::NotSet, QBorderStyle::NotSet, and QDisplayStyle::NotSet.
Referenced by QSampleControl::GetControlHtml(), QPaginator::GetControlHtml(), QTreeNav::GetControlHtml(), QTextBoxBase::GetControlHtml(), QRadioButtonList::GetControlHtml(), QRadioButton::GetControlHtml(), QListBoxBase::GetControlHtml(), QLinkButton::GetControlHtml(), QImageRollover::GetControlHtml(), QImageControlBase::GetControlHtml(), QImageButton::GetControlHtml(), QImageBase::GetControlHtml(), QFileControl::GetControlHtml(), QDateTimePicker::GetControlHtml(), QDataRepeater::GetControlHtml(), QControlLabel::GetControlHtml(), QCheckBoxList::GetControlHtml(), QCheckBox::GetControlHtml(), QCalendarPopup::GetControlHtml(), QCalendar::GetControlHtml(), and QButtonBase::GetControlHtml().
| QControlBase::MarkAsModified | ( | ) |
Referenced by SetParentControl(), and QFormBase::ValidateControlAndChildren().
| QControlBase::MarkAsWrapperModified | ( | ) |
Referenced by __set().
| QControlBase::ParsePostData | ( | ) | [abstract] |
Reimplemented in QActionControl, QBlockControl, QCalendar, QCalendarPopup, QCheckBox, QCheckBoxList, QControlLabel, QControlProxy, QDataGridBase, QDataRepeater, QDateTimePicker, QFileControl, QImageBase, QImageButton, QImageControlBase, QImageLabelBase, QImageRollover, QListBoxBase, QPaginatorBase, QRadioButton, QRadioButtonList, QTextBoxBase, QTreeNav, QWaitIcon, and QSampleControl.
| QControlBase::Persist | ( | ) |
| QControlBase::PersistPrepare | ( | ) | [protected] |
Reimplemented in QDataGridBase.
| QControlBase::Refresh | ( | ) |
If not yet rendered during this server/ajax event, will force the control to redraw/refresh Otherwise, this will do nothing
Referenced by QFileAssetBase::btnDelete_Click(), and QFileAssetBase::dlgFileAsset_Upload().
| QControlBase::RemoveAllActions | ( | $ | strEventName | ) |
Removes all events for a given event name. Be sure and use a QFooEvent::EventName constant here.
- Parameters:
-
string $strEventName
Referenced by QPaginatorBase::__set(), and QDataGridBase::__set().
| QControlBase::RemoveChildControl | ( | $ | strControlId, | |
| $ | blnRemoveFromForm | |||
| ) |
| QControlBase::RemoveChildControls | ( | $ | blnRemoveFromForm | ) |
References RemoveChildControl().
| QControlBase::RemoveCssClass | ( | $ | strCssClassName | ) |
This will remove a CssClass name from the CssClass property (if it exists), updating the CssClass property accordingly.
- Parameters:
-
string $strCssClassName
References $strCssClass.
| QControlBase::RemoveCustomAttribute | ( | $ | strName | ) |
References $strName.
| QControlBase::RemoveCustomStyle | ( | $ | strName | ) |
References $strName.
| QControlBase::Render | ( | $ | blnDisplayOutput = true |
) |
References GetControlHtml(), QCallerException::IncrementOffset(), RenderHelper(), and RenderOutput().
| QControlBase::RenderAjax | ( | $ | blnDisplayOutput = true |
) |
References $strRenderMethod.
| QControlBase::RenderChildren | ( | $ | blnDisplayOutput = true |
) | [protected] |
| QControlBase::RenderHelper | ( | $ | mixParameterArray, | |
| $ | strRenderMethod | |||
| ) | [protected] |
| QControlBase::RenderOutput | ( | $ | strOutput, | |
| $ | blnDisplayOutput, | |||
| $ | blnForceAsBlockElement = false | |||
| ) | [protected] |
References $blnIsBlockElement, $strLeft, $strTop, QCallType::Ajax, QType::Cast(), GetNonWrappedHtml(), QType::Integer, QPosition::NotSet, and QString::XmlEscape().
Referenced by Render(), RenderWithError(), and QControl::RenderWithName().
| QControlBase::RenderWithError | ( | $ | blnDisplayOutput = true |
) |
References GetControlHtml(), QCallerException::IncrementOffset(), RenderHelper(), and RenderOutput().
| QControlBase::ResetFlags | ( | ) |
| QControlBase::ResetOnPageStatus | ( | ) |
| QControlBase::SetCustomAttribute | ( | $ | strName, | |
| $ | strValue | |||
| ) |
References $strName.
| QControlBase::SetCustomStyle | ( | $ | strName, | |
| $ | strValue | |||
| ) |
References $strName.
| QControlBase::SetFocus | ( | ) |
| QControlBase::SetForm | ( | $ | objForm | ) |
References $objForm.
| QControlBase::SetParentControl | ( | $ | objControl | ) |
References MarkAsModified().
| QControlBase::Validate | ( | ) | [abstract] |
Reimplemented in QActionControl, QBlockControl, QCalendar, QCalendarPopup, QCheckBox, QCheckBoxList, QControlLabel, QControlProxy, QDateTimePicker, QDateTimeTextBox, QFileAssetBase, QFileControl, QFloatTextBox, QImageBase, QImageControlBase, QImageLabelBase, QImageRollover, QIntegerTextBox, QListBoxBase, QPaginatedControl, QPaginatorBase, QRadioButton, QRadioButtonList, QTextBoxBase, QTreeNav, QWaitIcon, and QSampleControl.
Referenced by QFormBase::ValidateControlAndChildren().
| QControlBase::ValidationReset | ( | ) |
| QControlBase::VarExport | ( | $ | blnReturn = true |
) |
Member Data Documentation
QControlBase::$blnActionsMustTerminate = false [protected] |
Reimplemented in QButtonBase, and QImageButton.
QControlBase::$blnDisplay = true [protected] |
Reimplemented in QWaitIcon.
QControlBase::$blnEnabled = true [protected] |
QControlBase::$blnFontBold = false [protected] |
QControlBase::$blnFontItalic = false [protected] |
QControlBase::$blnFontOverline = false [protected] |
QControlBase::$blnFontStrikeout = false [protected] |
QControlBase::$blnFontUnderline = false [protected] |
QControlBase::$blnIsBlockElement = false [protected] |
Reimplemented in QPaginatedControl, QPaginatorBase, QPanel, and QTreeNav.
Referenced by RenderOutput().
QControlBase::$blnModified = false [protected] |
QControlBase::$blnMoveable = false [protected] |
QControlBase::$blnOnPage = false [protected] |
QControlBase::$blnRendered = false [protected] |
QControlBase::$blnRendering = false [protected] |
QControlBase::$blnRequired = false [protected] |
QControlBase::$blnVisible = true [protected] |
QControlBase::$blnWrapperModified = false [protected] |
QControlBase::$intOpacity = null [protected] |
QControlBase::$intTabIndex = 0 [protected] |
QControlBase::$mixCausesValidation = false [protected] |
QControlBase::$objActionArray = array() [protected] |
Referenced by AddActionArray(), and GetAllActions().
QControlBase::$objChildControlArray = array() [protected] |
QControlBase::$objForm = null [protected] |
Referenced by CreatePersistent(), and SetForm().
QControlBase::$objParentControl = null [protected] |
Referenced by CreatePersistent(), and QPaginatedControl::SetDataBinder().
QControlBase::$strAccessKey = null [protected] |
QControlBase::$strActionParameter = null [protected] |
Referenced by QControlProxy::RenderAsEvents(), and QControlProxy::RenderAsHref().
QControlBase::$strBackColor = null [protected] |
Reimplemented in QImageControlBase, and QImageLabelBase.
Referenced by QImageBase::GetControlHtml().
QControlBase::$strBorderColor = null [protected] |
QControlBase::$strBorderStyle = QBorderStyle::NotSet [protected] |
QControlBase::$strBorderWidth = null [protected] |
Referenced by QImageLabelBase::GetStyleAttributes(), and GetStyleAttributes().
QControlBase::$strControlId [protected] |
Referenced by QSampleControl::__construct(), QPaginator::__construct(), QFileAsset::__construct(), QDataGrid::__construct(), QWriteBox::__construct(), QWaitIcon::__construct(), QTextBoxBase::__construct(), QPaginatorBase::__construct(), QPaginatedControl::__construct(), QListBoxBase::__construct(), QIntegerTextBox::__construct(), QImageControlBase::__construct(), QImageBase::__construct(), QFloatTextBox::__construct(), QFileAssetDialog::__construct(), QFileAssetBase::__construct(), QDataGridBase::__construct(), __construct(), QCalendar::__construct(), QFileAssetDialog::btnUpload_Click(), CreatePersistent(), GetChildControl(), QImageRollover::GetControlHtml(), QBlockControl::RemoveAllDropZones(), and RemoveChildControl().
QControlBase::$strCssClass = null [protected] |
Reimplemented in QCalendar, QDateTimePicker, QDialogBox, QButton, QListBox, QPaginator, and QTextBox.
Referenced by AddCssClass(), QRadioButtonList::GetControlHtml(), QRadioButton::GetControlHtml(), QCheckBoxList::GetControlHtml(), QCheckBox::GetControlHtml(), and RemoveCssClass().
QControlBase::$strCursor = QCursor::NotSet [protected] |
QControlBase::$strCustomAttributeArray = null [protected] |
QControlBase::$strCustomStyleArray = null [protected] |
QControlBase::$strDisplayStyle = QDisplayStyle::NotSet [protected] |
QControlBase::$strFontNames = null [protected] |
QControlBase::$strFontSize = null [protected] |
Reimplemented in QImageLabelBase.
QControlBase::$strForeColor = null [protected] |
Reimplemented in QImageLabelBase.
QControlBase::$strFormAttributes = null [protected] |
Reimplemented in QFileControl.
QControlBase::$strHeight = null [protected] |
QControlBase::$strHtmlAfter = null [protected] |
QControlBase::$strHtmlBefore = null [protected] |
QControlBase::$strInstructions = null [protected] |
Referenced by QControl::RenderWithName().
QControlBase::$strJavaScripts = null [protected] |
Reimplemented in QCalendar, QCalendarPopup, QDateTimePicker, QDialogBox, QImageRollover, QListBoxBase, and QTreeNav.
QControlBase::$strLeft = null [protected] |
Referenced by RenderOutput().
QControlBase::$strName = null [protected] |
Referenced by QSampleControl::__get(), QPaginator::__get(), QWriteBox::__get(), QWaitIcon::__get(), QTreeNav::__get(), QTextBoxBase::__get(), QRadioButtonList::__get(), QRadioButton::__get(), QPaginatorBase::__get(), QPaginatedControl::__get(), QListControl::__get(), QListBoxBase::__get(), QLinkButton::__get(), QIntegerTextBox::__get(), QImageRollover::__get(), QImageLabelBase::__get(), QImageControlBase::__get(), QImageButton::__get(), QImageBase::__get(), QFloatTextBox::__get(), QFileControl::__get(), QFileAssetBase::__get(), QDialogBox::__get(), QDateTimeTextBox::__get(), QDateTimePicker::__get(), QDataRepeater::__get(), QDataGridBase::__get(), QControlLabel::__get(), __get(), QCheckBoxList::__get(), QCheckBox::__get(), QCalendarPopup::__get(), QCalendar::__get(), QButtonBase::__get(), QBlockControl::__get(), QSampleControl::__set(), QPaginator::__set(), QWriteBox::__set(), QWaitIcon::__set(), QTreeNav::__set(), QTextBoxBase::__set(), QRadioButtonList::__set(), QRadioButton::__set(), QPaginatorBase::__set(), QPaginatedControl::__set(), QListControl::__set(), QListBoxBase::__set(), QLinkButton::__set(), QIntegerTextBox::__set(), QImageRollover::__set(), QImageLabelBase::__set(), QImageControlBase::__set(), QImageButton::__set(), QImageBase::__set(), QFloatTextBox::__set(), QFileControl::__set(), QFileAssetBase::__set(), QDialogBox::__set(), QDateTimeTextBox::__set(), QDateTimePicker::__set(), QDataRepeater::__set(), QDataGridBase::__set(), QControlLabel::__set(), __set(), QCheckBoxList::__set(), QCheckBox::__set(), QCalendarPopup::__set(), QCalendar::__set(), QButtonBase::__set(), QBlockControl::__set(), QDataGridBase::GetColumnByName(), QDataGridBase::GetColumnsByName(), GetCustomAttribute(), QImageRollover::GetCustomLinkStyle(), GetCustomStyle(), QDataGridBase::GetHeaderRowHtml(), QRadioButton::ParsePostData(), QDataGridBase::RemoveColumnByName(), QDataGridBase::RemoveColumnsByName(), RemoveCustomAttribute(), QImageRollover::RemoveCustomLinkStyle(), RemoveCustomStyle(), SetCustomAttribute(), QImageRollover::SetCustomLinkStyle(), and SetCustomStyle().
QControlBase::$strOverflow = QOverflow::NotSet [protected] |
QControlBase::$strPosition = QPosition::NotSet [protected] |
Reimplemented in QDialogBox.
QControlBase::$strRenderMethod [protected] |
Referenced by RenderAjax(), and RenderHelper().
QControlBase::$strStyleSheets = null [protected] |
QControlBase::$strToolTip = null [protected] |
QControlBase::$strTop = null [protected] |
Referenced by RenderOutput().
QControlBase::$strValidationError = null [protected] |
QControlBase::$strWarning = null [protected] |
QControlBase::$strWidth = null [protected] |
The documentation for this class was generated from the following file:
- qcodo/_core/qform/QControlBase.class.php
