Class QImageControlBase

This class will render an Image Control of any image file in the system

QBaseClass

Extended by

QHtmlAttributeManagerBase

Extended by

QHtmlAttributeManager

Extended by

QControlBase

Extended by

QControl

Extended by

QImageControlBase

Direct known subclasses

Abstract
Package: Controls
Located at includes/base_controls/QImageControlBase.class.php

Methods summary
`public`	# `ParsePostData( )` ParsePostData parses the value of this control from FormState ParsePostData parses the value of this control from FormState This abstract method must be implemented by all controls. When utilizing formgen, the programmer should never access form variables directly (e.g. via the $_FORM array). It can be assumed that at ANY given time, a control's values/properties will be "up to date" with whatever the webuser has entered in. When a Form is Created via Form::Create(string), the form will go through to check and see if it is a first-run of a form, or if it is a post-back. If it is a postback, it will go through its own private array of controls and call ParsePostData on EVERY control it has. Each control is responsible for "knowing" how to parse the $_POST data to update its own values/properties based on what was returned to via the postback.
`public boolean`	# `Validate( )` Checks if this controls contains a valid value. Checks if this controls contains a valid value. This abstract method defines how a control should validate itself based on the value/ properties it has. It should also include the handling of ensuring the "Required" requirements are obeyed if this control's "Required" flag is set to true. For Controls that can't realistically be "validated" (e.g. labels, datagrids, etc.), those controls should simply have Validate() return true. Returns boolean
`public`	# `__construct( QControl\|QForm\|QControlBase $objParentObject, string $strControlId = null )` Creates a QControlBase object This constructor will generally not be used to create a QControlBase object. Instead it is used by the classes which extend the class. Only the parent object parameter is required. If the option strControlId parameter is not used, QCubed will generate the id. Creates a QControlBase object This constructor will generally not be used to create a QControlBase object. Instead it is used by the classes which extend the class. Only the parent object parameter is required. If the option strControlId parameter is not used, QCubed will generate the id. Parameters `$objParentObject` `$strControlId` optional id of this Control. In html, this will be set as the value of the id attribute. The id can only contain alphanumeric characters. If this parameter is not passed, QCubed will generate the id. Throws Exception\|`QCallerException` Overrides `QControlBase::__construct()`
`public`	# `RenderAsImgSrc( $blnDisplayOutput = true )`
`protected string`	# `GetControlHtml( )` This method will render the control, itself, and will return the rendered HTML as a string This method will render the control, itself, and will return the rendered HTML as a string As an abstract method, any class extending QControlBase must implement it. This ensures that each control has its own specific html. When outputting html, you should call GetHtmlAttributes to get the attributes for the main control. If you are outputting a complex control, and need to include ids in subcontrols, your ids should be of the form: $parentControl->ControlId . '_' . $strSubcontrolId. The underscore indicates that actions and post data should be routed first to the parent control, and the parent control will handle the rest. Returns string
`public`	# `Serialize( )`
`public static`	# `Run( )`
`protected`	# `FlowThrough( $strPath )`
`protected`	# `SetupContentType( )`
`public`	# `RenderImage( $strPath = null )`
`public mixed`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QControlBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method implementation PHP magic method implementation Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QControlBase::__set()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetModelConnectorParams(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strBackColor`	# `'ffffff'`
`protected boolean`	`$blnScaleCanvasDown`	# `false`
`protected boolean`	`$blnScaleImageUp`	# `true`
`protected`	`$strImageType`	# `null`
`protected integer`	`$intQuality`	# `100`
`protected`	`$strImagePath`	#
`protected`	`$strAlternateText`	#
`protected`	`$strCacheFolder`	# `null`
`protected`	`$strCacheFilename`	# `null`
`protected`	`$strSourceImageType`	# `null`
`protected`	`$strCachedActualFilePath`	# `null`
`protected`	`$strWidth`	#
`protected`	`$strHeight`	#

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public boolean`	`$ScaleCanvasDown`
`public boolean`	`$ScaleImageUp`
`public string`	`$ImageType`
`public integer`	`$Quality`
`public string`	`$CacheFolder`
`public string`	`$CacheFilename`
`public string`	`$ImagePath`
`public string`	`$AlternateText`
`public write-only string`	`$BackColor`
`public write-only string`	`$Width`
`public write-only string`	`$Height`

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign`