PHP Class QControlBase, qcodo

Please note that not every control will utilize every single one of these properties. Keep in mind that Controls that are not Enabled or not Visible will not go through the form's Validation routine. All Controls must implement the following abstract functions:
  • {@link QControlBase::GetControlHtml()}
  • {@link QControlBase::ParsePostData()}
  • {@link QControlBase::Validate()}
Inheritance: extends QBaseClass
Afficher le fichier Open project: qcodo/qcodo Class Usage Examples

Protected Properties

Свойство Type Description
$blnActionsMustTerminate
$blnDisplay
$blnEnabled
$blnFontBold
$blnFontItalic
$blnFontOverline
$blnFontStrikeout
$blnFontUnderline
$blnIsBlockElement
$blnModified
$blnMoveable
$blnOnPage
$blnRendered
$blnRendering
$blnRequired
$blnVisible
$blnWrapperModified
$intOpacity
$intTabIndex
$mixCausesValidation
$objActionArray
$objChildControlArray
$objForm
$objParentControl
$strAccessKey BEHAVIOR
$strActionParameter
$strBackColor APPEARANCE
$strBorderColor
$strBorderStyle
$strBorderWidth
$strControlId MISC
$strCssClass
$strCursor
$strCustomAttributeArray
$strCustomStyleArray
$strDisplayStyle
$strFontNames
$strFontSize
$strForeColor
$strFormAttributes
$strHeight LAYOUT
$strHtmlAfter
$strHtmlBefore
$strInstructions
$strJavaScripts SETTINGS
$strLeft
$strName
$strOverflow
$strPosition
$strRenderMethod
$strStyleSheets
$strToolTip
$strTop
$strValidationError
$strWarning
$strWidth

Méthodes publiques

Méthode Description
AddAction ( $objEvent, $objAction )
AddActionArray ( $objEvent, $objActionArray )
AddChildControl ( QControl $objControl )
AddCssClass ( string $strCssClassName ) This will add a CssClass name to the CssClass property (if it does not yet exist), updating the CssClass property accordingly.
Blink ( $strFromColor = '#ffff66', $strToColor = '#ffffff' )
CountChildControls ( )
CreatePersistent ( $strClassName, $objParentObject, $strControlId )
Focus ( )
GetActionAttributes ( )
GetAllActions ( $strEventType, $strActionType = null )
GetAttributes ( $blnIncludeCustom = true, $blnIncludeAction = true ) (e.g. textbox will likely add the maxlength html attribute, etc.)
GetChildControl ( $strControlId )
GetChildControlIndex ( $strControlId )
GetChildControls ( $blnUseNumericIndexes = true )
GetCustomAttribute ( $strName )
GetCustomAttributes ( )
GetCustomStyle ( $strName )
GetEndHtml ( )
GetEndScript ( )
GetJavaScriptForEvent ( $strEventName )
GetStyleAttributes ( ) a control's HTML "style" attribute
MarkAsModified ( )
MarkAsRendered ( )
MarkAsWrapperModified ( )
MoveChildControlDown ( $strControlId )
MoveChildControlUp ( $strControlId )
MoveDownInParent ( )
MoveUpInParent ( )
ParsePostData ( ) $_POST data to update its own values/properties based on what was returned to via the postback.
Persist ( )
PrepForVarExport ( )
Refresh ( ) If not yet rendered during this server/ajax event, will force the control to redraw/refresh Otherwise, this will do nothing
RemoveAllActions ( string $strEventName ) Removes all events for a given event name.
RemoveChildControl ( $strControlId, $blnRemoveFromForm )
RemoveChildControls ( $blnRemoveFromForm )
RemoveCssClass ( string $strCssClassName ) This will remove a CssClass name from the CssClass property (if it exists), updating the CssClass property accordingly.
RemoveCustomAttribute ( $strName )
RemoveCustomStyle ( $strName )
Render ( $blnDisplayOutput = true ) it is by default), or it will return the rendered HTML as a string.
RenderAjax ( $blnDisplayOutput = true )
RenderWithError ( $blnDisplayOutput = true )
ResetFlags ( ) called by user code.
ResetOnPageStatus ( )
SetCustomAttribute ( $strName, $strValue )
SetCustomStyle ( $strName, $strValue )
SetFocus ( )
SetForm ( $objForm )
SetParentControl ( $objControl )
Validate ( ) have Validate() return true.
ValidationReset ( )
__construct ( $objParentObject, $strControlId = null )
__get ( $strName )
__set ( $strName, $mixValue )

Méthodes protégées

Méthode Description
GetControlHtml ( ) This method will render the control, itself, and will return the rendered HTML as a string
GetNonWrappedHtml ( )
PersistPrepare ( )
RenderChildren ( $blnDisplayOutput = true )
RenderHelper ( $mixParameterArray, $strRenderMethod ) if ($this->RenderHelper(func_get_args())) return;
RenderOutput ( $strOutput, $blnDisplayOutput, $blnForceAsBlockElement = false )

Method Details

AddAction() public méthode

public AddAction ( $objEvent, $objAction )

AddActionArray() public méthode

public AddActionArray ( $objEvent, $objActionArray )

AddChildControl() public méthode

public AddChildControl ( QControl $objControl )
$objControl QControl

AddCssClass() public méthode

This will add a CssClass name to the CssClass property (if it does not yet exist), updating the CssClass property accordingly.
public AddCssClass ( string $strCssClassName )
$strCssClassName string

CountChildControls() public méthode

public CountChildControls ( )

CreatePersistent() public static méthode

public static CreatePersistent ( $strClassName, $objParentObject, $strControlId )

Focus() public méthode

public Focus ( )

GetActionAttributes() public méthode

public GetActionAttributes ( )

GetAllActions() public méthode

public GetAllActions ( $strEventType, $strActionType = null )

GetAttributes() public méthode

(e.g. textbox will likely add the maxlength html attribute, etc.)
public GetAttributes ( $blnIncludeCustom = true, $blnIncludeAction = true )

GetChildControl() public méthode

public GetChildControl ( $strControlId )

GetChildControlIndex() public méthode

public GetChildControlIndex ( $strControlId )

GetChildControls() public méthode

public GetChildControls ( $blnUseNumericIndexes = true )

GetControlHtml() abstract protected méthode

This method will render the control, itself, and will return the rendered HTML as a string
abstract protected GetControlHtml ( )

GetCustomAttribute() public méthode

public GetCustomAttribute ( $strName )

GetCustomAttributes() public méthode

public GetCustomAttributes ( )

GetCustomStyle() public méthode

public GetCustomStyle ( $strName )

GetEndHtml() public méthode

public GetEndHtml ( )

GetEndScript() public méthode

public GetEndScript ( )

GetJavaScriptForEvent() public méthode

public GetJavaScriptForEvent ( $strEventName )

GetNonWrappedHtml() protected méthode

protected GetNonWrappedHtml ( )

GetStyleAttributes() public méthode

a control's HTML "style" attribute
public GetStyleAttributes ( )

MarkAsModified() public méthode

public MarkAsModified ( )

MarkAsRendered() public méthode

public MarkAsRendered ( )

MarkAsWrapperModified() public méthode

MoveChildControlDown() public méthode

public MoveChildControlDown ( $strControlId )

MoveChildControlUp() public méthode

public MoveChildControlUp ( $strControlId )

MoveDownInParent() public méthode

public MoveDownInParent ( )

MoveUpInParent() public méthode

public MoveUpInParent ( )

ParsePostData() abstract public méthode

$_POST data to update its own values/properties based on what was returned to via the postback.
abstract public ParsePostData ( )

Persist() public méthode

public Persist ( )

PersistPrepare() protected méthode

protected PersistPrepare ( )

PrepForVarExport() public méthode

public PrepForVarExport ( )

Refresh() public méthode

If not yet rendered during this server/ajax event, will force the control to redraw/refresh Otherwise, this will do nothing
public Refresh ( )

RemoveAllActions() public méthode

Be sure and use a QFooEvent::EventName constant here.
public RemoveAllActions ( string $strEventName )
$strEventName string

RemoveChildControl() public méthode

public RemoveChildControl ( $strControlId, $blnRemoveFromForm )

RemoveChildControls() public méthode

public RemoveChildControls ( $blnRemoveFromForm )

RemoveCssClass() public méthode

This will remove a CssClass name from the CssClass property (if it exists), updating the CssClass property accordingly.
public RemoveCssClass ( string $strCssClassName )
$strCssClassName string

RemoveCustomAttribute() public méthode

public RemoveCustomAttribute ( $strName )

RemoveCustomStyle() public méthode

public RemoveCustomStyle ( $strName )

Render() public méthode

it is by default), or it will return the rendered HTML as a string.
public Render ( $blnDisplayOutput = true )

RenderAjax() public méthode

public RenderAjax ( $blnDisplayOutput = true )

RenderChildren() protected méthode

protected RenderChildren ( $blnDisplayOutput = true )

RenderHelper() protected méthode

if ($this->RenderHelper(func_get_args())) return;
protected RenderHelper ( $mixParameterArray, $strRenderMethod )

RenderOutput() protected méthode

protected RenderOutput ( $strOutput, $blnDisplayOutput, $blnForceAsBlockElement = false )

RenderWithError() public méthode

public RenderWithError ( $blnDisplayOutput = true )

ResetFlags() public méthode

called by user code.
public ResetFlags ( )

ResetOnPageStatus() public méthode

public ResetOnPageStatus ( )

SetCustomAttribute() public méthode

..... onfocus="alert('You are about to edit this field')" nowrap="nowrap" blah="foo" />
public SetCustomAttribute ( $strName, $strValue )

SetCustomStyle() public méthode

public SetCustomStyle ( $strName, $strValue )

SetFocus() public méthode

public SetFocus ( )

SetForm() public méthode

public SetForm ( $objForm )

SetParentControl() public méthode

public SetParentControl ( $objControl )

Validate() abstract public méthode

have Validate() return true.
abstract public Validate ( )

ValidationReset() public méthode

public ValidationReset ( )

__construct() public méthode

public __construct ( $objParentObject, $strControlId = null )

__get() public méthode

public __get ( $strName )

__set() public méthode

public __set ( $strName, $mixValue )

Property Details

$blnActionsMustTerminate protected_oe property

protected $blnActionsMustTerminate

$blnDisplay protected_oe property

protected $blnDisplay

$blnEnabled protected_oe property

protected $blnEnabled

$blnFontBold protected_oe property

protected $blnFontBold

$blnFontItalic protected_oe property

protected $blnFontItalic

$blnFontOverline protected_oe property

protected $blnFontOverline

$blnFontStrikeout protected_oe property

protected $blnFontStrikeout

$blnFontUnderline protected_oe property

protected $blnFontUnderline

$blnIsBlockElement protected_oe property

protected $blnIsBlockElement

$blnModified protected_oe property

protected $blnModified

$blnMoveable protected_oe property

protected $blnMoveable

$blnOnPage protected_oe property

protected $blnOnPage

$blnRendered protected_oe property

protected $blnRendered

$blnRendering protected_oe property

protected $blnRendering

$blnRequired protected_oe property

protected $blnRequired

$blnVisible protected_oe property

protected $blnVisible

$blnWrapperModified protected_oe property

protected $blnWrapperModified

$intOpacity protected_oe property

protected $intOpacity

$intTabIndex protected_oe property

protected $intTabIndex

$mixCausesValidation protected_oe property

protected $mixCausesValidation

$objActionArray protected_oe property

protected $objActionArray

$objChildControlArray protected_oe property

protected $objChildControlArray

$objForm protected_oe property

protected $objForm

$objParentControl protected_oe property

protected $objParentControl

$strAccessKey protected_oe property

BEHAVIOR
protected $strAccessKey

$strActionParameter protected_oe property

protected $strActionParameter

$strBackColor protected_oe property

APPEARANCE
protected $strBackColor

$strBorderColor protected_oe property

protected $strBorderColor

$strBorderStyle protected_oe property

protected $strBorderStyle

$strBorderWidth protected_oe property

protected $strBorderWidth

$strControlId protected_oe property

MISC
protected $strControlId

$strCssClass protected_oe property

protected $strCssClass

$strCursor protected_oe property

protected $strCursor

$strCustomAttributeArray protected_oe property

protected $strCustomAttributeArray

$strCustomStyleArray protected_oe property

protected $strCustomStyleArray

$strDisplayStyle protected_oe property

protected $strDisplayStyle

$strFontNames protected_oe property

protected $strFontNames

$strFontSize protected_oe property

protected $strFontSize

$strForeColor protected_oe property

protected $strForeColor

$strFormAttributes protected_oe property

protected $strFormAttributes

$strHeight protected_oe property

LAYOUT
protected $strHeight

$strHtmlAfter protected_oe property

protected $strHtmlAfter

$strHtmlBefore protected_oe property

protected $strHtmlBefore

$strInstructions protected_oe property

protected $strInstructions

$strJavaScripts protected_oe property

SETTINGS
protected $strJavaScripts

$strLeft protected_oe property

protected $strLeft

$strName protected_oe property

protected $strName

$strOverflow protected_oe property

protected $strOverflow

$strPosition protected_oe property

protected $strPosition

$strRenderMethod protected_oe property

protected $strRenderMethod

$strStyleSheets protected_oe property

protected $strStyleSheets

$strToolTip protected_oe property

protected $strToolTip

$strTop protected_oe property

protected $strTop

$strValidationError protected_oe property

protected $strValidationError

$strWarning protected_oe property

protected $strWarning

$strWidth protected_oe property

protected $strWidth