Impact Acquire SDK Java
TComponentFlag Class Reference

Flags defining access rights and other component properties. More...

Static Public Attributes

static final int cfAllowValueCombinations = acquireJNI.cfAllowValueCombinations_get()
 Allows combinations of translation dictionary entry as valid values.
 
static final int cfAlwaysForceClone = acquireJNI.cfAlwaysForceClone_get()
 If set this component is always cloned completely.
 
static final int cfAlwaysForceUpdate = acquireJNI.cfAlwaysForceUpdate_get()
 This feature will ALWAYS execute internal update callbacks and will treat each write attempt to this feature as a value different from the current one.
 
static final int cfContainsBinaryData = acquireJNI.cfContainsBinaryData_get()
 Specifies a property, which contains binary data.
 
static final int cfDisallowSerialize = acquireJNI.cfDisallowSerialize_get()
 If set this component or derived components can't be stored as external data.
 
static final int cfFixedSize = acquireJNI.cfFixedSize_get()
 This components element count can be modified.
 
static final int cfInvisible = acquireJNI.cfInvisible_get()
 The component is shadowed by other settings currently if set.
 
static final int cfNotAvailable = acquireJNI.cfNotAvailable_get()
 If set, this component is currently not available due to the setting of another feature.
 
static final int cfNotImplemented = acquireJNI.cfNotImplemented_get()
 If set, this feature has been defined, but so far has not been implemented.
 
static final int cfReadAccess = acquireJNI.cfReadAccess_get()
 This component can be accessed for reading.
 
static final int cfRWAccess = acquireJNI.cfRWAccess_get()
 This component can be accessed for both reading and writing.
 
static final int cfShouldBeDisplayedAsEnumeration = acquireJNI.cfShouldBeDisplayedAsEnumeration_get()
 Informs a displaying GUI that this component should be displayed as an enumeration(e.g.
 
static final int cfShouldBeDisplayedAsList = acquireJNI.cfShouldBeDisplayedAsList_get()
 Informs a displaying GUI that this component should be displayed as a list.
 
static final int cfUndefined = acquireJNI.cfUndefined_get()
 This is used to define an inconsistent/invalid flag.
 
static final int cfWriteAccess = acquireJNI.cfWriteAccess_get()
 This component can be accessed for writing.
 

Detailed Description

Flags defining access rights and other component properties.

Flags defining access rights and other component properties

Member Data Documentation

◆ cfAllowValueCombinations

final int cfAllowValueCombinations = acquireJNI.cfAllowValueCombinations_get()
static

Allows combinations of translation dictionary entry as valid values.

If this flag is set for a property that defines a translation dictionary not only values, which are registered in the translation dictionary are allowed values for this property, but also values logical OR-ed together with values from the translation dictionary (these obviously can't be set as strings).

A property defines two entries ("one", 1) and ("two", 2) then 1 | 2 = 3 will be a valid value as well, but "three" obviously won't.

In a GUI application a property specifying this flag should be displayed as a set of check-box controls (one for each dictionary entry) or something similar.

Note
If this flag is specified for a component, which is not a property, it will have no effect on the behaviour of the component. Only integer properties can use this feature

◆ cfAlwaysForceClone

final int cfAlwaysForceClone = acquireJNI.cfAlwaysForceClone_get()
static

If set this component is always cloned completely.

This results in the component being completely independent from its parent no matter whether it has been built while deriving or cloning a list and thus the components within this list and its sub-lists.

This will change the behaviour to that effect that changing the parent component will no longer affect the 'derived' component. So different default values, constants and translation dictionaries for properties within an inheritance hierarchy can be defined.

Note
This feature is currently only supported for components of type mvIMPACT.acquire.TComponentType.ctPropInt, mvIMPACT.acquire.TComponentType.ctPropInt64 and mvIMPACT.acquire.TComponentType.ctPropFloat.

◆ cfAlwaysForceUpdate

final int cfAlwaysForceUpdate = acquireJNI.cfAlwaysForceUpdate_get()
static

This feature will ALWAYS execute internal update callbacks and will treat each write attempt to this feature as a value different from the current one.

Since
2.0.11

◆ cfContainsBinaryData

final int cfContainsBinaryData = acquireJNI.cfContainsBinaryData_get()
static

Specifies a property, which contains binary data.

This flag is used to specify a property that contains data in binary format

◆ cfDisallowSerialize

final int cfDisallowSerialize = acquireJNI.cfDisallowSerialize_get()
static

If set this component or derived components can't be stored as external data.

◆ cfFixedSize

final int cfFixedSize = acquireJNI.cfFixedSize_get()
static

This components element count can be modified.

If this flag is set this components element count can't be modified. For a list this would mean, that the number of elements stored in this list can't be modified. For a property this means, that the number of values stored in the property can't be modified.

◆ cfInvisible

final int cfInvisible = acquireJNI.cfInvisible_get()
static

The component is shadowed by other settings currently if set.

This flag is used to specify that this component currently has no effect on the behaviour of the system. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

◆ cfNotAvailable

final int cfNotAvailable = acquireJNI.cfNotAvailable_get()
static

If set, this component is currently not available due to the setting of another feature.

In this case this feature can't be written to nor can it be read.

◆ cfNotImplemented

final int cfNotImplemented = acquireJNI.cfNotImplemented_get()
static

If set, this feature has been defined, but so far has not been implemented.

◆ cfReadAccess

final int cfReadAccess = acquireJNI.cfReadAccess_get()
static

This component can be accessed for reading.

If this flag is set this component can be accessed for reading. This involves reading a property's data, reading a component list's elements reading the size of a component list and so on.

◆ cfRWAccess

final int cfRWAccess = acquireJNI.cfRWAccess_get()
static

This component can be accessed for both reading and writing.

This just combines mvIMPACT.acquire.TComponentFlag.cfReadAccess and mvIMPACT.acquire.TComponentFlag.cfWriteAccess

◆ cfShouldBeDisplayedAsEnumeration

final int cfShouldBeDisplayedAsEnumeration = acquireJNI.cfShouldBeDisplayedAsEnumeration_get()
static

Informs a displaying GUI that this component should be displayed as an enumeration(e.g.

with a combo box).

This flag e.g. can be set for a property to inform a displaying GUI, that this property is best displayed as a combo box or something similar. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

Since
1.12.57

◆ cfShouldBeDisplayedAsList

final int cfShouldBeDisplayedAsList = acquireJNI.cfShouldBeDisplayedAsList_get()
static

Informs a displaying GUI that this component should be displayed as a list.

This flag e.g. can be set for an array property to inform a displaying GUI, that this property is best displayed as a list with a entry for each element. This flag is just meant as a hint for the user. The property module itself does NOT use this flag for anything.

◆ cfUndefined

final int cfUndefined = acquireJNI.cfUndefined_get()
static

This is used to define an inconsistent/invalid flag.

This e.g. can be used as a return value for a function, that could not calculate a valid flag mask.

◆ cfWriteAccess

final int cfWriteAccess = acquireJNI.cfWriteAccess_get()
static

This component can be accessed for writing.

If this flag is set this component can be accessed for writing or modifying its data. This involves writing values to a property, adding components to a list and so on.