public interface PropFeature extends SelectionEntity
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getAllowedPropertyValues(java.lang.String name)
Returns the set of allowed values for a property if it is a finite set
of strings, null otherwise.
|
boolean |
getBoolean(java.lang.String name)
Gets boolean property.
|
boolean |
getBoolean(java.lang.String name,
int index)
Gets boolean value from string vector property.
|
boolean |
getBoolean(java.lang.String name,
java.lang.String key)
Gets boolean value from string vector property.
|
boolean[] |
getBooleanArray(java.lang.String name)
Gets boolean vector property.
|
boolean[][] |
getBooleanMatrix(java.lang.String name)
Gets boolean matrix property.
|
double |
getDouble(java.lang.String name)
Gets double property.
|
double |
getDouble(java.lang.String name,
int index)
Gets double value from double vector property.
|
double |
getDouble(java.lang.String name,
java.lang.String key)
Gets double value from double vector property.
|
double[] |
getDoubleArray(java.lang.String name)
Gets double vector property.
|
double[][] |
getDoubleMatrix(java.lang.String name)
Gets double matrix property.
|
int |
getEntryKeyIndex(java.lang.String name,
java.lang.String key)
Returns the index of a given key in a property.
|
java.lang.String[] |
getEntryKeys(java.lang.String name)
Returns the possible entry keys for a given property.
|
int |
getInt(java.lang.String name)
Gets integer property.
|
int |
getInt(java.lang.String name,
int index)
Gets integer value from string vector property.
|
int |
getInt(java.lang.String name,
java.lang.String key)
Gets integer value from string vector property.
|
int[] |
getIntArray(java.lang.String name)
Gets integer vector property.
|
int[][] |
getIntMatrix(java.lang.String name)
Gets integer matrix property.
|
java.util.List<?> |
getReferenceArray(java.lang.String name)
Deprecated.
Shouldn't be used.
|
java.lang.String |
getString(java.lang.String name)
Gets string property.
|
java.lang.String |
getString(java.lang.String name,
int index)
Gets string value from string vector property.
|
java.lang.String |
getString(java.lang.String name,
int firstIndex,
int secondIndex)
Gets string value from string matrix property.
|
java.lang.String |
getString(java.lang.String name,
java.lang.String key)
Gets string value from string vector property.
|
java.lang.String[] |
getStringArray(java.lang.String name)
Gets string vector property.
|
java.lang.String[][] |
getStringMatrix(java.lang.String name)
Gets string matrix property.
|
java.lang.String |
getType()
Get the type identifier.
|
java.lang.String |
getValueType(java.lang.String name)
Returns the main data type which a property can return.
|
boolean |
hasProperty(java.lang.String name)
Returns true if this feature supports a given property.
|
boolean |
hasSelection()
Test if the object has selection.
|
PropFeature |
move(java.lang.String name,
int[] indices,
int relativeChange)
Move a number of features in a list.
|
PropFeature |
move(java.lang.String name,
int firstIndex,
int lastIndex,
int newPosition)
Move a group of features in a list.
|
java.lang.String[] |
properties()
Returns the names of all properties.
|
PropFeature |
remove(java.lang.String name,
int index)
Removes an indexed element from an array property.
|
PropFeature |
remove(java.lang.String name,
int[] indices)
Removes indexed elements from an array property.
|
AbstractSelection |
selection(java.lang.String name)
Returns selection.
|
PropFeature |
set(java.lang.String name,
boolean value)
Sets boolean property value.
|
PropFeature |
set(java.lang.String name,
boolean[] value)
Sets boolean vector property value.
|
PropFeature |
set(java.lang.String name,
boolean[][] value)
Sets boolean matrix property value.
|
PropFeature |
set(java.lang.String name,
double value)
Sets double property value.
|
PropFeature |
set(java.lang.String name,
double[] value)
Sets double vector property value.
|
PropFeature |
set(java.lang.String name,
double[][] value)
Sets double matrix property value.
|
PropFeature |
set(java.lang.String name,
int value)
Sets integer property value.
|
PropFeature |
set(java.lang.String name,
int[] value)
Sets integer vector property value.
|
PropFeature |
set(java.lang.String name,
int[][] value)
Sets integer matrix property value.
|
PropFeature |
set(java.lang.String name,
java.lang.String value)
Sets string property value.
|
PropFeature |
set(java.lang.String name,
java.lang.String[] value)
Sets string vector property value.
|
PropFeature |
set(java.lang.String name,
java.lang.String[][] value)
Sets string matrix property value.
|
PropFeature |
setEntry(java.lang.String name,
java.lang.String key,
boolean value)
Sets boolean vector property value at specified entry.
|
PropFeature |
setEntry(java.lang.String name,
java.lang.String key,
double value)
Sets double vector property value at specified entry.
|
PropFeature |
setEntry(java.lang.String name,
java.lang.String key,
int value)
Sets integer vector property value at specified entry.
|
PropFeature |
setEntry(java.lang.String name,
java.lang.String key,
java.lang.String value)
Sets string vector property value at specified entry.
|
PropFeature |
setIndex(java.lang.String name,
boolean[] value,
int index)
Sets boolean matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
boolean value,
int vector)
Sets boolean vector property value at index.
|
PropFeature |
setIndex(java.lang.String name,
boolean value,
int firstIndex,
int secondIndex)
Sets boolean matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
double[] value,
int index)
Sets double matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
double value,
int index)
Sets string vector property value at index.
|
PropFeature |
setIndex(java.lang.String name,
double value,
int firstIndex,
int secondIndex)
Sets string matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
int[] value,
int index)
Sets integer matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
int value,
int index)
Sets string vector property value at index.
|
PropFeature |
setIndex(java.lang.String name,
int value,
int firstIndex,
int secondIndex)
Sets string matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
java.lang.String[] value,
int index)
Sets string matrix property value at index.
|
PropFeature |
setIndex(java.lang.String name,
java.lang.String value,
int vector)
Sets string vector property value at index.
|
PropFeature |
setIndex(java.lang.String name,
java.lang.String value,
int firstIndex,
int secondIndex)
Sets string matrix property value at index.
|
selection
active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version
getContainer, getDisplayString
java.lang.String[] getAllowedPropertyValues(java.lang.String name)
name
- Property name.boolean getBoolean(java.lang.String name)
name
- Property name.boolean getBoolean(java.lang.String name, java.lang.String key)
name
- Property name.key
- Index key.boolean getBoolean(java.lang.String name, int index)
name
- Property name.index
- Index.boolean[] getBooleanArray(java.lang.String name)
name
- Property name.boolean[][] getBooleanMatrix(java.lang.String name)
name
- Property name.double getDouble(java.lang.String name)
name
- Property name.double getDouble(java.lang.String name, java.lang.String key)
name
- Property name.key
- Index key.double getDouble(java.lang.String name, int index)
name
- Property name.index
- Index.double[] getDoubleArray(java.lang.String name)
name
- Property name.double[][] getDoubleMatrix(java.lang.String name)
name
- Property name.int getEntryKeyIndex(java.lang.String name, java.lang.String key)
name
- Property name.key
- Entry key.java.lang.String[] getEntryKeys(java.lang.String name)
name
- Property name.int getInt(java.lang.String name)
name
- Property name.int getInt(java.lang.String name, java.lang.String key)
name
- Property name.key
- Index key.int getInt(java.lang.String name, int index)
name
- Property name.index
- Index.int[] getIntArray(java.lang.String name)
name
- Property name.int[][] getIntMatrix(java.lang.String name)
name
- Property name.java.lang.String getString(java.lang.String name)
name
- Property name.java.lang.String getString(java.lang.String name, java.lang.String key)
name
- Property name.key
- Index key.java.lang.String getString(java.lang.String name, int index)
name
- Property name.index
- Index.java.lang.String getString(java.lang.String name, int firstIndex, int secondIndex)
name
- Property name.firstIndex
- First index.secondIndex
- Second index.java.lang.String[] getStringArray(java.lang.String name)
name
- Property name.java.lang.String[][] getStringMatrix(java.lang.String name)
name
- Property name.java.lang.String getType()
java.lang.String getValueType(java.lang.String name)
name
- The name of the property.Boolean
, String
,
StringArray
, StringMatrix
,
Int
, IntArray
,
Double
, DoubleArray
,
DoubleMatrix
,
DoubleRowMatrix
.boolean hasProperty(java.lang.String name)
name
- Property name.true
if a feature supports the property.boolean hasSelection()
true
if object has a selection.PropFeature move(java.lang.String name, int[] indices, int relativeChange)
name
- Property name.indices
- Indices of features.relativeChange
- How much to move features.PropFeature move(java.lang.String name, int firstIndex, int lastIndex, int newPosition)
name
- Property name.firstIndex
- First position in group.lastIndex
- Last position in group.newPosition
- Where to move group.java.lang.String[] properties()
PropFeature remove(java.lang.String name, int index)
name
- Property name.index
- Index of element.PropFeature remove(java.lang.String name, int[] indices)
name
- Property name.indices
- Indices of elements.AbstractSelection selection(java.lang.String name)
name
- Selection tag.PropFeature set(java.lang.String name, java.lang.String value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, java.lang.String[] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, java.lang.String[][] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, boolean value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, boolean[] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, boolean[][] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, double value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, double[] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, double[][] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, int value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, int[] value)
name
- Property name.value
- Property value.PropFeature set(java.lang.String name, int[][] value)
name
- Property name.value
- Property value.PropFeature setEntry(java.lang.String name, java.lang.String key, java.lang.String value)
name
- Property name.key
- Index key.value
- Property value.PropFeature setEntry(java.lang.String name, java.lang.String key, boolean value)
name
- Property name.key
- Index key.value
- Property value.PropFeature setEntry(java.lang.String name, java.lang.String key, double value)
name
- Property name.key
- Index key.value
- Property value.PropFeature setEntry(java.lang.String name, java.lang.String key, int value)
name
- Property name.key
- Index key.value
- Property value.PropFeature setIndex(java.lang.String name, java.lang.String value, int vector)
name
- Property name.value
- Property value.vector
- Index in vector.PropFeature setIndex(java.lang.String name, java.lang.String[] value, int index)
name
- Property name.value
- Property value.index
- Index in matrix.PropFeature setIndex(java.lang.String name, boolean value, int vector)
name
- Property name.value
- Property value.vector
- Index in vector.PropFeature setIndex(java.lang.String name, boolean[] value, int index)
name
- Property name.value
- Property value.index
- Index in matrix.PropFeature setIndex(java.lang.String name, double value, int index)
name
- Property name.value
- Property value.index
- Index in vector.PropFeature setIndex(java.lang.String name, double[] value, int index)
name
- Property name.value
- Property value.index
- Index in matrix.PropFeature setIndex(java.lang.String name, int value, int index)
name
- Property name.value
- Property value.index
- Index in vector.PropFeature setIndex(java.lang.String name, int[] value, int index)
name
- Property name.value
- Property value.index
- Index in matrix.PropFeature setIndex(java.lang.String name, java.lang.String value, int firstIndex, int secondIndex)
name
- Property name.value
- Property value.firstIndex
- First index in matrix.secondIndex
- Second index in matrix.PropFeature setIndex(java.lang.String name, boolean value, int firstIndex, int secondIndex)
name
- Property name.value
- Property value.firstIndex
- First index in matrix.secondIndex
- Second index in matrix.PropFeature setIndex(java.lang.String name, double value, int firstIndex, int secondIndex)
name
- Property name.value
- Property value.firstIndex
- First index in matrix.secondIndex
- Second index in matrix.PropFeature setIndex(java.lang.String name, int value, int firstIndex, int secondIndex)
name
- Property name.value
- Property value.firstIndex
- First index in matrix.secondIndex
- Second index in matrix.@Deprecated java.util.List<?> getReferenceArray(java.lang.String name)