@Component(value="cuba_FilterParam")
@Scope(value="prototype")
public class Param
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Param.Builder |
static class |
Param.ParamValueChangedEvent |
static class |
Param.Type |
static class |
Param.ValueProperty |
Modifier and Type | Field and Description |
---|---|
protected BeanLocator |
beanLocator |
protected java.util.UUID |
categoryAttrId |
protected Configuration |
configuration |
protected DataComponents |
dataComponents |
protected DataManager |
dataManager |
protected DatatypeRegistry |
datatypeRegistry |
protected static java.util.List<java.lang.Class> |
dateTimeClasses |
protected java.lang.Object |
defaultValue |
protected Component |
editComponent |
protected java.lang.String |
entityView |
protected java.lang.String |
entityWhere |
protected boolean |
inExpr |
protected boolean |
isDateInterval |
protected boolean |
isFoldersFilterEntitiesSet |
protected java.lang.Class |
javaClass |
protected Messages |
messages |
protected Metadata |
metadata |
protected MetadataTools |
metadataTools |
protected java.lang.String |
name |
static java.lang.String |
NAME |
static java.lang.String |
NULL |
protected PersistenceManagerClient |
persistenceManager |
protected MetaProperty |
property |
protected boolean |
required |
protected java.util.List<java.lang.String> |
runtimeEnum |
protected ThemeConstants |
theme |
protected static java.util.List<java.lang.Class> |
timeClasses |
protected Param.Type |
type |
protected UiComponents |
uiComponents |
protected UserSessionSource |
userSessionSource |
protected boolean |
useUserTimeZone |
protected java.lang.Object |
value |
Constructor and Description |
---|
Param(Param.Builder builder) |
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
_getValue(Param.ValueProperty valueProperty) |
protected void |
_setValue(java.lang.Object value,
Param.ValueProperty valueProperty) |
Subscription |
addParamValueChangeListener(java.util.function.Consumer<Param.ParamValueChangedEvent> valueChangeHandler) |
void |
addValueChangeListener(java.util.function.Consumer<Param.ParamValueChangedEvent> valueChangeHandler)
Deprecated.
|
protected Component |
createBooleanField(Param.ValueProperty valueProperty) |
protected Component |
createDatatypeField(Datatype datatype,
Param.ValueProperty valueProperty) |
protected Component |
createDateField(java.lang.Class javaClass,
Param.ValueProperty valueProperty) |
protected Component |
createEditComponent(FilterDataContext context,
Param.ValueProperty valueProperty)
Creates an GUI component for condition parameter.
|
Component |
createEditComponentForDefaultValue(FilterDataContext filterDataContext)
Creates an GUI component for condition parameter to specify default value.
|
Component |
createEditComponentForFilterValue(FilterDataContext filterDataContext)
Creates an GUI component for condition parameter to specify value for filter.
|
protected Component |
createEntityLookup(FilterDataContext filterDataContext,
Param.ValueProperty valueProperty) |
protected CollectionLoader<Entity> |
createEntityOptionsLoader(MetaClass metaClass) |
protected Component |
createEnumLookup(Param.ValueProperty valueProperty) |
protected Component |
createNumberField(Datatype datatype,
Param.ValueProperty valueProperty) |
protected Component |
createRuntimeEnumLookup(Param.ValueProperty valueProperty) |
protected Component |
createTextField(Param.ValueProperty valueProperty) |
protected Component |
createTimeField(java.lang.Class javaClass,
Param.ValueProperty valueProperty) |
protected CheckBox |
createUnaryField(Param.ValueProperty valueProperty) |
protected Component |
createUuidField(Datatype datatype,
Param.ValueProperty valueProperty) |
protected java.lang.String |
formatSingleValue(java.lang.Object v) |
java.lang.String |
formatValue(java.lang.Object value) |
java.lang.Object |
getDefaultValue() |
protected EventHub |
getEventHub() |
java.lang.Class |
getJavaClass() |
java.lang.String |
getName() |
MetaProperty |
getProperty() |
Param.Type |
getType() |
java.lang.Object |
getValue() |
protected void |
initListEditor(ListEditor<java.util.List<?>> listEditor,
Param.ValueProperty valueProperty) |
boolean |
isDateInterval() |
boolean |
isFoldersFilterEntitiesSet() |
boolean |
isInExpr() |
boolean |
isUseUserTimeZone() |
protected java.lang.Object |
loadEntity(java.lang.String id) |
protected java.util.List<Entity> |
loadEntityList(java.lang.String[] ids) |
protected java.lang.Object |
parseSingleValue(java.lang.String text) |
void |
parseValue(java.lang.String text) |
void |
setDateInterval(boolean dateInterval) |
void |
setDefaultValue(java.lang.Object defaultValue) |
void |
setDefaultValue(java.lang.Object defaultValue,
boolean updateEditComponent) |
void |
setFoldersFilterEntitiesSet(boolean isFoldersFilterEntitiesSet)
Set true if param should be used for folder's filter entities set
|
void |
setInExpr(boolean inExpr) |
void |
setJavaClass(java.lang.Class javaClass) |
protected void |
setThemeConstantsManager(ThemeConstantsManager themeManager) |
void |
setUseUserTimeZone(boolean useUserTimeZone) |
void |
setValue(java.lang.Object value) |
protected void |
setValue(java.lang.Object value,
boolean updateEditComponent) |
protected void |
showParseExceptionNotification(java.lang.String message) |
void |
toXml(org.dom4j.Element element,
Param.ValueProperty valueProperty) |
public static final java.lang.String NAME
public static final java.lang.String NULL
protected static final java.util.List<java.lang.Class> dateTimeClasses
protected static final java.util.List<java.lang.Class> timeClasses
protected java.lang.String name
protected Param.Type type
protected java.lang.Class javaClass
protected java.lang.Object value
protected java.lang.Object defaultValue
protected boolean useUserTimeZone
protected java.lang.String entityWhere
protected java.lang.String entityView
protected MetaProperty property
protected boolean inExpr
protected boolean required
protected boolean isDateInterval
protected java.util.List<java.lang.String> runtimeEnum
protected java.util.UUID categoryAttrId
protected Component editComponent
protected boolean isFoldersFilterEntitiesSet
@Inject protected BeanLocator beanLocator
@Inject protected Metadata metadata
@Inject protected Messages messages
@Inject protected UserSessionSource userSessionSource
@Inject protected UiComponents uiComponents
@Inject protected MetadataTools metadataTools
@Inject protected DataManager dataManager
@Inject protected Configuration configuration
@Inject protected DataComponents dataComponents
@Inject protected PersistenceManagerClient persistenceManager
@Inject protected DatatypeRegistry datatypeRegistry
protected ThemeConstants theme
public Param(Param.Builder builder)
protected EventHub getEventHub()
@Inject protected void setThemeConstantsManager(ThemeConstantsManager themeManager)
public java.lang.String getName()
public Param.Type getType()
public void setJavaClass(java.lang.Class javaClass)
public boolean isDateInterval()
public void setDateInterval(boolean dateInterval)
public boolean isInExpr()
public void setInExpr(boolean inExpr)
public boolean isFoldersFilterEntitiesSet()
public void setFoldersFilterEntitiesSet(boolean isFoldersFilterEntitiesSet)
isFoldersFilterEntitiesSet
- filter entities set valuepublic boolean isUseUserTimeZone()
public void setUseUserTimeZone(boolean useUserTimeZone)
public java.lang.Class getJavaClass()
public java.lang.Object getValue()
public void setValue(@Nullable java.lang.Object value)
protected void setValue(@Nullable java.lang.Object value, boolean updateEditComponent)
public java.lang.Object getDefaultValue()
public void setDefaultValue(java.lang.Object defaultValue)
public void setDefaultValue(@Nullable java.lang.Object defaultValue, boolean updateEditComponent)
public void parseValue(java.lang.String text)
@Nullable protected java.lang.Object parseSingleValue(java.lang.String text)
protected java.util.List<Entity> loadEntityList(java.lang.String[] ids)
protected java.lang.Object loadEntity(java.lang.String id)
public java.lang.String formatValue(java.lang.Object value)
protected java.lang.String formatSingleValue(java.lang.Object v)
public Component createEditComponentForDefaultValue(FilterDataContext filterDataContext)
public Component createEditComponentForFilterValue(FilterDataContext filterDataContext)
protected Component createEditComponent(@Nullable FilterDataContext context, Param.ValueProperty valueProperty)
valueProperty
- What value the editor will be connected with: current filter value or default one.protected CheckBox createUnaryField(Param.ValueProperty valueProperty)
protected Component createDatatypeField(Datatype datatype, Param.ValueProperty valueProperty)
protected void _setValue(@Nullable java.lang.Object value, Param.ValueProperty valueProperty)
protected java.lang.Object _getValue(Param.ValueProperty valueProperty)
protected Component createTextField(Param.ValueProperty valueProperty)
protected Component createDateField(java.lang.Class javaClass, Param.ValueProperty valueProperty)
protected Component createTimeField(java.lang.Class javaClass, Param.ValueProperty valueProperty)
protected Component createNumberField(Datatype datatype, Param.ValueProperty valueProperty)
protected void showParseExceptionNotification(java.lang.String message)
protected Component createBooleanField(Param.ValueProperty valueProperty)
protected Component createUuidField(Datatype datatype, Param.ValueProperty valueProperty)
protected Component createEntityLookup(FilterDataContext filterDataContext, Param.ValueProperty valueProperty)
protected CollectionLoader<Entity> createEntityOptionsLoader(MetaClass metaClass)
protected Component createEnumLookup(Param.ValueProperty valueProperty)
protected Component createRuntimeEnumLookup(Param.ValueProperty valueProperty)
protected void initListEditor(ListEditor<java.util.List<?>> listEditor, Param.ValueProperty valueProperty)
public void toXml(org.dom4j.Element element, Param.ValueProperty valueProperty)
@Deprecated public void addValueChangeListener(java.util.function.Consumer<Param.ParamValueChangedEvent> valueChangeHandler)
addParamValueChangeListener(Consumer)
valueChangeHandler
- value change handlerpublic Subscription addParamValueChangeListener(java.util.function.Consumer<Param.ParamValueChangedEvent> valueChangeHandler)
public MetaProperty getProperty()