blob: 3b77b2ad558c38e951e10ed5dbc1c4520c935c7b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*****************************************************************************
* Copyright (c) 2015 CEA LIST and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* CEA LIST - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.infra.nattable.filter.configuration;
import org.eclipse.nebula.widgets.nattable.config.IConfigRegistry;
import org.eclipse.nebula.widgets.nattable.style.ConfigAttribute;
import org.eclipse.papyrus.infra.nattable.configuration.IPapyrusNatTableConfiguration;
import org.eclipse.papyrus.infra.nattable.filter.IFilterValueToMatchManager;
import org.eclipse.papyrus.infra.nattable.model.nattable.nattablestyle.StringValueStyle;
import org.eclipse.papyrus.infra.nattable.model.nattable.nattablestyle.Style;
import org.eclipse.papyrus.infra.nattable.utils.NattableConfigAttributes;
/**
* This interface is used to register new cell editor for filter
*
*/
public interface IFilterConfiguration extends IPapyrusNatTableConfiguration {
/**
* key used to save a filter configuration id state when the system use the default filter provided by the configuration
* It is only used as name for a {@link StringValueStyle}
*/
public static final String FILTER_SYSTEM_ID = "filterId"; //$NON-NLS-1$
/**
* key used to save filter state (the value typed by the user to filter the rows)
* This key used as name for a {@link Style} without more precision
*/
public static final String FILTER_VALUE_TO_MATCH = "filterValueToMatch"; //$NON-NLS-1$
/**
* key used to save a filter configuration id state when the system use a filter choosen by the user
* It is only used as name for a {@link StringValueStyle}, we use a specific key in order to not destroyed it when we unapply filter on a column where filter has been definied by the user
*
*
*/
public static final String FILTER_FORCED_BY_USER_ID = "filterForcedByUserId"; //$NON-NLS-1$
/**
* the config attribute used to register the class loading and storing filter state
*/
public static final ConfigAttribute<IFilterValueToMatchManager> FILTER_VALUE_TO_MATCH_MANAGER = NattableConfigAttributes.FILTER_VALUE_TO_MATCH_MANAGER;
/**
*
* @param registry
* the config registry used by NatTable
* @param axis
* the axis for which we want a filter
* @return
* <code>true</code> if the configuration manage the axis
*/
public boolean handles(IConfigRegistry registry, final Object axis);
/**
*
* @param registry
* the config registry used by NatTable
* @param axis
* the axis for which we want a filter
* @param configLabel
* the label to use to declare the filter
*
* This method is used to store information required to filter the table into the config registry
*/
public void configureFilter(IConfigRegistry configRegistry, final Object axis, final String configLabel);
}
|
