Class QDataGridLegacyColumn

This defines a specific column for a DataGrid All the appearance properties should be self-explanatory. The SortByCommand and ReverseSortByCommand are both optional -- and are explained in more depth in DataGrid.inc

QBaseClass

QDataGridLegacyColumn

Direct known subclasses

QCheckBoxLegacyColumn

Package: Controls
Located at includes/base_controls/QDataGridLegacyColumn.class.php

Methods summary
`public`	# `__construct( string $strName, null\|string $strHtml = null, null\|mixed $objOverrideParameters = null )` Constructor Constructor Parameters `$strName` Name of the column `$strHtml` Text for the column (Can be processed through HtmlEntities) `$objOverrideParameters` Parameters to be overriden (for func_get_args()) Throws Exception `QCallerException`
`public string`	# `GetAttributes( boolean $blnIncludeCustom,…, boolean $blnIncludeAction,… )` Returns the HTML attributes for the column Returns the HTML attributes for the column Parameters `$blnIncludeCustom`,… [For future use only] `$blnIncludeAction`,… [For future use only] Returns string
`public`	# `FilterAddListItem( null\|string $arg1 = null, null\|QQCondition $arg2 = null )` Creates a list for a column's filter Two ways of calling the fuction: 1. specify only one paramter and it should be an advanced list item 2. the other way is to call it using 2 parameters with first one being a name and other a value Creates a list for a column's filter Two ways of calling the fuction: 1. specify only one paramter and it should be an advanced list item 2. the other way is to call it using 2 parameters with first one being a name and other a value Parameters `$arg1` `$arg2` Throws Exception
`public boolean`	# `HasFilter( )` Tells whether or not the column has a filter Tells whether or not the column has a filter Returns boolean Does the column have a filter?
`public`	# `SetActiveFilterState( mixed $mixFilterValue )` Parameters `$mixFilterValue` for the custom filters, $mixFilterValue will be set as FilterByCommand['value']. Otherwise, if $mixFilterValue is a QQ condition, it's set as the active filter. If $mixFilterValue is not a QQ condition, then it's either the value of the filter for text box filters, or it's the index into the filter list for the list box filters.
`public`	# `GetActiveFilterState( )`
`public`	# `GetActiveFilterValue( )`
`public`	# `ClearFilter( )`
`public mixed`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QBaseClass::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QBaseClass::__set()`

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

Properties summary
`protected null\|string`	`$strBackColor` Background colour of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is Background colour of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is	# `null`
`protected null\|string`	`$strBorderColor` Border colour of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is Border colour of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is	# `null`
`protected string`	`$strBorderStyle` Border style of an element of this column (constant from QBorderStyle class) Border style of an element of this column (constant from QBorderStyle class)	# `QBorderStyle::NotSet`
`protected null\|string`	`$strBorderWidth` Border width of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is Border width of an element of this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is	# `null`
`protected null\|string`	`$strCssClass` CSS class of an element of this column null = not specified in rendered HTML string = applied as-is CSS class of an element of this column null = not specified in rendered HTML string = applied as-is	# `null`
`protected boolean`	`$blnFontBold` Determines if the font will be bold Determines if the font will be bold	# `false`
`protected boolean`	`$blnFontItalic` Determines if the font will be italicized Determines if the font will be italicized	# `false`
`protected null\|string`	`$strFontNames` Font family to be used (can use a value from QFontFamily class) Font family to be used (can use a value from QFontFamily class)	# `null`
`protected boolean`	`$blnFontOverline` Determines if the font will have an overline Determines if the font will have an overline	# `false`
`protected null\|string\|integer`	`$strFontSize` Font size of the element in this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applies as-is integer = interpreted as value in pixels Font size of the element in this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applies as-is integer = interpreted as value in pixels	# `null`
`protected boolean`	`$blnFontStrikeout` Determines if the font will be striked out Determines if the font will be striked out	# `false`
`protected boolean`	`$blnFontUnderline` Determines if the font will be underlined Determines if the font will be underlined	# `false`
`protected null\|string`	`$strForeColor` Text Color of the element in this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is Text Color of the element in this column null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applied as-is	# `null`
`protected string`	`$strHorizontalAlign` The horizontal text alignment attribute for the element in this column The horizontal text alignment attribute for the element in this column	# `QHorizontalAlign::NotSet`
`protected string`	`$strVerticalAlign` The vertical alignment attribute for the element in this column The vertical alignment attribute for the element in this column	# `QVerticalAlign::NotSet`
`protected null\|string\|integer`	`$strWidth` Column width null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applies as-is integer = interpreted as value in pixels Column width null = not specified in rendered HTML (browser or another CSS rule can determine value) string = applies as-is integer = interpreted as value in pixels	# `null`
`protected boolean`	`$blnWrap` Determines if the column will have nowrap html attribute set on it or not Determines if the column will have nowrap html attribute set on it or not	# `true`
`protected boolean`	`$blnHasResetButton` If the concerned row is a filter row then this variable determines if it has a Reset Button on it If the concerned row is a filter row then this variable determines if it has a Reset Button on it	# `false`
`protected null\|QQOrderBy`	`$objOrderByClause` The ordering clause associated with this column This clause is utilized when user clicks on the top row which can be used to order results The ordering clause associated with this column This clause is utilized when user clicks on the top row which can be used to order results	# `null`
`protected null\|QQOrderBy`	`$objReverseOrderByClause` The REVERSED ordering clause associated with this column The REVERSED ordering clause associated with this column	# `null`
`protected integer`	`$intFilterBoxSize` Determines the width ("size" attribute) of the input control of this column on the filter row Determines the width ("size" attribute) of the input control of this column on the filter row	# `10`
`protected string`	`$strFilterType` Type of filter to be used for this column (text/list) Type of filter to be used for this column (text/list)	# `QFilterType::None`
`protected null\|integer`	`$intFilterColId` The filter column id to be used for the column It is derived from the index of the column in the datagrid The filter column id to be used for the column It is derived from the index of the column in the datagrid	# `null`
`protected array`	`$arrFilterList`	# `array()`
`protected`	`$objActiveFilter`	# `null`
`protected`	`$objFilterConstant`	# `null`
`protected string`	`$strFilterPrefix`	# `''`
`protected string`	`$strFilterPostfix`	# `''`
`protected`	`$arrFilterByCommand`	# `null`
`protected string`	`$strName` Name of the column to be shown on the top row Name of the column to be shown on the top row	#
`protected null\|string`	`$strHtml` Contents of the column Contents of the column	#
`protected boolean`	`$blnHtmlEntities` Determines if the contents of this column have to be processed through HtmlEntities Determines if the contents of this column have to be processed through HtmlEntities	# `true`

Magic properties summary
`public string`	`$BackColor` Background colour of an element of this column
`public string`	`$BorderColor` Border colour of an element of this column
`public string`	`$BorderStyle` Border style of an element of this column (constant from QBorderStyle class)
`public string`	`$BorderWidth` Border width of an element of this column
`public string`	`$CssClass` CSS class of an element of this column
`public boolean`	`$FontBold` Determines if the font will be bold
`public boolean`	`$FontItalic` Determines if the font will be italicized
`public string`	`$FontNames` Font family to be used (can use a value from QFontFamily class)
`public boolean`	`$FontOverline` Determines if the font will have an overline
`public string\|integer`	`$FontSize` Font size of the element in this column
`public boolean`	`$FontStrikeout` Determines if the font will be striked out
`public boolean`	`$FontUnderline` Determines if the font will be underlined
`public null\|string`	`$ForeColor` Text Color of the element in this column
`public string`	`$HorizontalAlign` The horizontal text alignment attribute for the element in this column
`public string`	`$VerticalAlign` The vertical alignment attribute for the element in this column
`public string\|integer`	`$Width` Column width
`public boolean`	`$Wrap` Determines if the column will have nowrap html attribute set on it or not
`public mixed`	`$OrderByClause` The ordering clause associated with this column
`public null\|QQOrderBy`	`$ReverseOrderByClause` The REVERSED ordering clause associated with this column
`public mixed`	`$FilterByCommand`
`public integer`	`$FilterBoxSize` Determines the width ("size" attribute) of the input control of this column on the filter row
`public string`	`$FilterType` Type of filter to be used for this column (text/list)
`public mixed`	`$FilterList`
`public integer`	`$FilterColId` The filter column id to be used for the column
`public string`	`$FilterPrefix`
`public string`	`$FilterPostfix`
`public mixed`	`$FilterConstant`
`public mixed`	`$SortByCommand`
`public mixed`	`$ReverseSortByCommand`
`public string`	`$Html` is the contents of the column itself -- the $this->strHtml contents can contain backticks ` to deliniate commands that are to be PHP evaled (again, see DataGrid.inc for more info)
`public string`	`$Name` is the name of the column, as displayed in the DataGrid's header row for that column
`public boolean`	`$HtmlEntities` Determines if the contents of this column have to be processed through HtmlEntities
`public boolean`	`$HasResetButton` If the concerned row is a filter row then this variable determines if it has a Reset Button on it
`public read-only array`	`$FilterInfo`
`public read-only mixed`	`$ActiveFilter`
`public write-only mixed`	`$Filter`

Packages

Classes

Traits

Exceptions

Functions

Class QDataGridLegacyColumn

Direct known subclasses

Parameters

Throws

Parameters

Returns

Parameters

Throws

Returns

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides