Package com.jbstrap.ui.components.filter

Class JBBaseFilter<T extends Component<?>>

java.lang.Object

com.jbstrap.core.messagebus.MessageBus

com.jbstrap.ui.Component<T>

com.jbstrap.ui.components.filter.BaseFilter<T>

com.jbstrap.ui.components.filter.JBBaseFilter<T>

Direct Known Subclasses:

AdvancedFilter, SimpleFilter, TextFilter

public abstract class JBBaseFilter<T extends Component<?>>
extends BaseFilter<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.jbstrap.ui.components.filter.BaseFilter

BaseFilter.ColumnParams

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADVANCED
protected Icon	cancelButtonIcon
protected String	cancelButtonText
protected Criteria	currentCriteria
protected OperatorType	defaultWorldOperator
protected Icon	filterButtonIcon
protected String	filterButtonText
protected List<String>	filteredColumn
protected static final List<OperatorType>	HIDDEN_OPERATORS
protected Icon	resetButtonIcon
protected String	resetButtonText
protected Icon	saveButtonIcon
protected String	saveButtonText
protected static final String	SIMPLE
protected static final String	TEXT

Fields inherited from class com.jbstrap.ui.components.filter.BaseFilter

columns, defaultEditor, ds, filtering, postInitScript, type

Fields inherited from class com.jbstrap.ui.Component

animation, attributes, backgroundColor, borderColor, color, defaultHotKeyHandler, handlers, hotKeys, styleClasses, textAlign, toolTip, toolTipPosition

Constructor Summary

Constructors

Constructor	Description
JBBaseFilter(FilterType type)
JBBaseFilter(FilterType type, String language)
JBBaseFilter(String id, FilterType type, String language, FilterBarFiltering<?> filtering)

Method Summary

Modifier and Type	Method	Description
protected String	getColumnParamsAsJson(BaseFilter<T>.ColumnParams param)	Generate JSON parameter object from the column parameters
Criteria	getCriteria()	Gets the user-specified filter criterion from the filter component.
void	init()	The component initialization method.
boolean	isShowEditor()
void	onChangeEditor(FilterbarChangeEditorEvent event)
void	onFilter(FilterbarFilteringEvent event)	Filter handling
T	reset()	Removes all filter conditions from the filter component and setting the filter component to default
protected void	setButtonsData()
abstract T	setCriteria(Criteria criteria)
T	setEnabled(boolean enabled)	Sets the component to be enabled.
T	setShowEditor(boolean showEditor)

Methods inherited from class com.jbstrap.ui.components.filter.BaseFilter

getComponents, getDataDescriptor, getFiltering, getType, onHide, runAfterDrawOnEditor, runOnHideOnEditor, runOnShowOnEdior, setDataDescriptor, setFiltering, writeHTML

Methods inherited from class com.jbstrap.ui.Component

_hide, _setAttribute, addAllowedRole, addComponent, addComponent, addComponents, addDeniedRole, addHandler, addStyle, addStyleClass, addStyleClasses, afterDraw, clearfix, closeTag, combinateAccess, containsStyle, containsStyleClass, draw, drawSubComponents, error, flattendComponentTree, getAccess, getAccessMode, getAllowedRoles, getAttribute, getAttributes, getBackgroundColor, getBorderColor, getClient, getComponentById, getComponents, getComponentsByClass, getData, getDeniedRoles, getHandlers, getId, getLanguageCode, getName, getParent, getParent, getRegisteredEvents, getStyle, getStyleClasses, getTextAlign, getTextColor, getToolTip, getToolTipPosition, getTypeName, getUI, insertComponentAfter, insertComponentBefore, isAccess, isDrawn, isEnabled, isEventBubbling, isVisible, onHotKeyEventHandler, onShow, openTag, redraw, removeAllComponents, removeAllowedRole, removeAllStyleClasses, removeAttribute, removeComponent, removeComponent, removeComponents, removeDeniedRole, removeHandler, removeStyle, removeStyle, removeStyleClass, removeStyleClasses, replaceComponent, replaceStyleClass, runAfterDraw, runJavaScript, runJavaScript, runJavaScript, runOnHide, runOnShow, say, setAttribute, setBackgroundColor, setBorder, setBorderColor, setData, setDisplayType, setEventBubbling, setFlex, setFloating, setHeight100, setHeight25, setHeight50, setHeight75, setHeightAuto, setLanguage, setMargin, setName, setOverflow, setPadding, setParent, setScrollable, setSelectionType, setShadow, setStyle, setTextAlign, setTextColor, setToolTip, setToolTipPosition, setVisible, setWidth100, setWidth25, setWidth50, setWidth75, setWidthAuto, showNotification, showNotification, showProcessIndicator, toggleStyleClass

Methods inherited from class com.jbstrap.core.messagebus.MessageBus

closeMessageBus, messageBusOpened, openMessageBus, renewSubscription, sendMessageToMessageBus, subscribeMessageBus, unsubscribeAllListeners, unsubscribeMessageBus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HIDDEN_OPERATORS

protected static final List<OperatorType> HIDDEN_OPERATORS

TEXT

protected static final String TEXT

See Also:

• Constant Field Values

SIMPLE

protected static final String SIMPLE

See Also:

• Constant Field Values

ADVANCED

protected static final String ADVANCED

See Also:

• Constant Field Values

currentCriteria

protected Criteria currentCriteria

defaultWorldOperator

protected OperatorType defaultWorldOperator

filteredColumn

protected List<String> filteredColumn

filterButtonText

protected String filterButtonText

resetButtonText

protected String resetButtonText

saveButtonText

protected String saveButtonText

cancelButtonText

protected String cancelButtonText

filterButtonIcon

protected Icon filterButtonIcon

resetButtonIcon

protected Icon resetButtonIcon

saveButtonIcon

protected Icon saveButtonIcon

cancelButtonIcon

protected Icon cancelButtonIcon

Constructor Details

JBBaseFilter

public JBBaseFilter(FilterType type)

JBBaseFilter

public JBBaseFilter(FilterType type,
 String language)

JBBaseFilter

public JBBaseFilter(String id,
 FilterType type,
 String language,
 FilterBarFiltering<?> filtering)

Method Details

init

public void init()
          throws JavaScriptLoadError

Description copied from class: Component

The component initialization method.

Empty method, only needs to be overwritten when making a custom component, that needs to call an initializing JavaScript on the client side. The method is called by the framework after the component is drawn, but before the afterDraw() method. The use of this method during application development is not allowed. This method is meant for inner use only.

Overrides:

init in class Component<T extends Component<?>>

Throws:

JavaScriptLoadError - If there was a JavaScript error during the initialization.

getColumnParamsAsJson

protected String getColumnParamsAsJson(BaseFilter<T>.ColumnParams param)

Generate JSON parameter object from the column parameters

Parameters:

param - The column parameters object

Returns:

The generated JSON object

getCriteria

public Criteria getCriteria()

Gets the user-specified filter criterion from the filter component.

Specified by:

getCriteria in class BaseFilter<T extends Component<?>>

Returns:

The filter criterion in the component or null if no filter criterion is specified

reset

public T reset()

Removes all filter conditions from the filter component and setting the filter component to default

Specified by:

reset in class BaseFilter<T extends Component<?>>

Returns:

The filter component

onFilter

public void onFilter(FilterbarFilteringEvent event)

Filter handling

Parameters:

event - Filter event

setCriteria

public abstract T setCriteria(Criteria criteria)

Specified by:

setCriteria in class BaseFilter<T extends Component<?>>

onChangeEditor

public void onChangeEditor(FilterbarChangeEditorEvent event)

Parameters:

event - The change filter editor event

setEnabled

public T setEnabled(boolean enabled)

Sets the component to be enabled. Defaults to true

Overrides:

setEnabled in class Component<T extends Component<?>>

Parameters:

enabled - true, the component is enabled, otherwise it's disabled

Returns:

The component

setShowEditor

public T setShowEditor(boolean showEditor)

isShowEditor

public boolean isShowEditor()

setButtonsData

protected void setButtonsData()