Home Reference Source
public class | source

PrintExportFilter

Extends:

TypedObjectFilter → PrintExportFilter

A class that extends the base filter object, but adds the additional properties, to store whether the user chose to print all pages, or specific pages of data.

Please note, this is only required when the grid's filterPageSortMode is server.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

The printOptions object or exportOptions object on basis of whether the user is printing or exporting.

Method Summary

Public Methods
public

Inherited Summary

From class TypedObject
public

typeCache: {}

public
public

Returns a list of strings that represent the object hierarchy for this object.

public

Returns true if the class name to check is in the list of class names defined for this class.

From class Filter
public

For the filter dropdown, show the label for the pre built filters.

public

A collection of com.flexicious.grids.filters.FilterExpression objects.

public

The number of pages

public

The current page index.

public

Size of the page

public

The total number of records

public

List of records

public

A collection of com.flexicious.grids.filters.FilterSort objects.

public

addCriteria(columnName: String, expression: Object)

Adds a FilterExpression to the current list Uses the default equality operator.

public

addFilterExpression(filterExpression: flexiciousNmsp.FilterExpression)

Expression to add

public

addOperatorCriteria(columnName: String, operation: String, compareValue: Object, wasContains: Boolean)

Adds a com.flexicious.grids.filters.FilterExpression to the current list.

public

addSort(sortColumn: String, isAscending: Boolean, sortComparisionType: String, sortCompareFunction: Function)

Adds a com.flexicious.grids.filters.FilterSort object to the list.

public

copyFrom(filter: Object)

Takes a filter and populates the current filter's properties with the provided filter

public
public

Given a filter column, returns the corresponding filter expression.

public
public

Given a filter column, returns the corresponding value of the filter expression of that column.

public

removeCriteria(searchField: String)

Removes a previously added FilterExpression from the current list that matches the specified search field.

public

Public Constructors

public constructor() source

Override:

Filter#constructor

Public Members

public printExportOptions: * source

The printOptions object or exportOptions object on basis of whether the user is printing or exporting.

Public Methods

public getClassNames(): string[] source

Returns a list of strings that represent the object hierarchy for this object.

Override:

Filter#getClassNames

Return:

string[]