Interface SortElementInterface
This interface describes a sort panel element.
-
DcGeneral\Panel\SortElementInterface
implements
DcGeneral\Panel\PanelElementInterface
Methods summary
public
DcGeneral\Panel\SearchElementInterface
|
#
setDefaultFlag( integer $intFlag )
Set the default flag to use when no flag has been defined for a certain
property.
Set the default flag to use when no flag has been defined for a certain
property.
Parameters
- $intFlag
integer $intFlag The flag to use.
Returns
|
public
integer
|
#
getDefaultFlag( )
Get the default flag to use when no flag has been defined for a certain
property.
Get the default flag to use when no flag has been defined for a certain
property.
Returns
integer
|
public
mixed
|
#
addProperty( string $strPropertyName, integer $intFlag )
Add a property for sorting.
Add a property for sorting.
Parameters
- $strPropertyName
string $strPropertyName The property name to enable sorting for.
- $intFlag
integer $intFlag The flag to use for sorting.
Returns
mixed
|
public
string[]
|
#
getPropertyNames( )
Retrieve the list of properties to allow search on.
Retrieve the list of properties to allow search on.
Returns
string[]
|
public
mixed
|
#
setSelected( string $strPropertyName )
Set the selected property for sorting.
Set the selected property for sorting.
Parameters
- $strPropertyName
string $strPropertyName The property name to mark as selected.
Returns
mixed
|
public
string
|
#
getSelected( )
Return the name of the currently selected property.
Return the name of the currently selected property.
Returns
string
|
public
integer
|
#
getFlag( )
Return the flag of the currently selected property.
Return the flag of the currently selected property.
Returns
integer
|