public interface GxClientFilterModel
When saving or restoring state on a filter the filter model is used. The filter model represents the state of the filter
Modifier and Type | Method and Description |
---|---|
BBjString | apply(BBjNumber send!) Apply the filter This method will only compose the model and send it to the client in case |
BBjString | apply() Apply the filter This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call |
void | clearFilter() Clear the filter |
BBjString | execute(BBjNumber send!) Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set. |
BBjString | execute() Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set. |
JsonObject | getAsJsonObject() Convert the model to JSON object |
BBjString | getColumn() Get the working column |
BBjGridExWidget | getWidget() Get the widget instance |
BBjNumber | isFilterActive() Check if the filter is action or not
|
void | setColumn(BBjString column!) Set the working column |
void | setWidget(BBjGridExWidget widget!) Set the widget instance |
BBjNumber | supportsCombinedModel() Check if the filter supported the combined model |
BBjString | update() Update the filter on the client and execute it. |
public BBjString apply(BBjNumber send!)
Apply the filter
This method will only compose the model and send it to the client in case send!
is true.
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
BBjNumber
send! when true the model will be send to the client , false otherwise 256 when the column or the widget are not defined
GxClientFilterModel.execute()
public BBjString apply()
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
256 when the column or the widget are not defined
GxClientFilterModel.execute()
public void clearFilter()
Clear the filter
public BBjString execute(BBjNumber send!)
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
BBjNumber
send! when true the execution code will executed on the client , false otherwise 256 when the column or the widget are not defined
public BBjString execute()
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
BBjNumber
send! when true the execution code will executed on the client , false otherwise 256 when the column or the widget are not defined
public JsonObject getAsJsonObject()
Convert the model to JSON object
public BBjString getColumn()
Get the working column
public BBjGridExWidget getWidget()
Get the widget instance
public BBjNumber isFilterActive()
Check if the filter is action or not
#API
256 when the column or the widget are not defined
public void setColumn(BBjString column!)
Set the working column
BBjString
column! the column idpublic void setWidget(BBjGridExWidget widget!)
Set the widget instance
BBjGridExWidget
widget!public BBjNumber supportsCombinedModel()
Check if the filter supported the combined model
public BBjString update()
Update the filter on the client and execute it.
256 when the column or the widget are not defined