|
Oxygen XML Editor 11.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ro.sync.contentcompletion.xml.CIValue
public class CIValue
Interface for objects holding information about element or attribute values used in the content completion process.
Field Summary | |
---|---|
protected int |
afterInsertCaretPosition
The position in text where to place the caret position after insert value. |
static int |
TYPE_PLAIN
Marks that the value is a plain text value with no additional meaning. |
static int |
TYPE_XSLT_AXIS
Marks that the value represents an axis in XSLT. |
static int |
TYPE_XSLT_ELEMENT
Marks that the value represents a name of an element from the document. |
static int |
TYPE_XSLT_FUNCTION
Marks that the value represents an XSLT function. |
Constructor Summary | |
---|---|
CIValue(String value)
Creates a CIValue. |
|
CIValue(String value,
boolean listValue)
Creates a CIValue. |
|
CIValue(String value,
boolean listValue,
String annotation)
Creates a CIValue. |
|
CIValue(String value,
boolean listValue,
String annotation,
boolean defaultValue)
Creates a CIValue. |
|
CIValue(String value,
boolean listValue,
String annotation,
String insertString,
int type)
Creates a CIValue. |
|
CIValue(String value,
boolean listValue,
String annotation,
String insertString,
int type,
boolean defaultValue)
Creates a CIValue. |
|
CIValue(String fullPrefix,
CIValue ciValue)
Create a CIValue from another one by adding a prefix to the original value. |
|
CIValue(String value,
String annotation)
Creates a CIValue. |
Method Summary | |
---|---|
int |
compareTo(CIValue other)
Compares the String values. |
boolean |
equals(Object obj)
Test if a CIValue is equal with this one. |
int |
getAfterInsertCaretPosition()
|
String |
getAnnotation()
Get the annotation associated with this value. |
static CIValue[] |
getCIValues(Collection<String> values)
Get an array of CIValue from a list of strings. |
static List<CIValue> |
getCIValuesAsList(Collection<String> values)
Get a list of CIValue from a list of strings. |
String |
getInsertString()
Get the insert string. |
int |
getType()
Get the type of the value. |
String |
getValue()
Get the actual value. |
boolean |
isDefaultValue()
Get the default value flag. |
boolean |
isListValue()
Get the value of the flag indicating if the value is an entry in a list value. |
void |
setAnnotation(String annotation)
Set the annotation associated with this value. |
void |
setDefaultValue()
Mark the value as default value. |
protected void |
setInsertString(String insertString)
Sets the insert string. |
void |
setListValue()
Mark the value as belonging to a list value. |
protected void |
setValue(String value)
Sets the value. |
String |
toString()
Get a String representation of this CIValue . |
Object |
valueOf(String str)
This is needed by a combo box editor to see if it is the same value as the old one. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected int afterInsertCaretPosition
-1
, then the caret position is not and must be computed.
public static final int TYPE_PLAIN
0
public static final int TYPE_XSLT_AXIS
1
public static final int TYPE_XSLT_FUNCTION
2
public static final int TYPE_XSLT_ELEMENT
3
Constructor Detail |
---|
public CIValue(String value)
value
- The actual value.public CIValue(String value, boolean listValue)
value
- The actual value.listValue
- Flag indicating if the value is an entry from a list value.public CIValue(String value, String annotation)
value
- The actual value.annotation
- The annotation associated with this value.public CIValue(String value, boolean listValue, String annotation)
value
- The actual value.listValue
- Flag indicating if the value is an entry from a list value.annotation
- The annotation associated with this value.public CIValue(String value, boolean listValue, String annotation, boolean defaultValue)
value
- The actual value.listValue
- Flag indicating if the value is an entry from a list value.annotation
- The annotation associated with this value.defaultValue
- true
if it is the default value.public CIValue(String value, boolean listValue, String annotation, String insertString, int type)
value
- The actual value.listValue
- Flag indicating if the value is an entry from a list value.annotation
- The annotation associated with this value.insertString
- The string to be inserted in the document when the CIValue
is chosen from the content completion list of proposals.
If null
, the value
will be used.type
- The type of the value. Use by the renderer.
TYPE_PLAIN
, TYPE_XSLT_AXIS
,
TYPE_XSLT_FUNCTION
, TYPE_XSLT_ELEMENT
public CIValue(String value, boolean listValue, String annotation, String insertString, int type, boolean defaultValue)
value
- The actual value.listValue
- Flag indicating if the value is an entry from a list value.annotation
- The annotation associated with this value.insertString
- The string to be inserted in the document when the CIValue
is chosen from the content completion list of proposals.
If null
, the value
will be used.type
- The type of the value. Use by the renderer.
TYPE_PLAIN
, TYPE_XSLT_AXIS
,
TYPE_XSLT_FUNCTION
, TYPE_XSLT_ELEMENT
defaultValue
- true
if it is the default value.public CIValue(String fullPrefix, CIValue ciValue)
fullPrefix
- The full prefix of the value
field.ciValue
- The CIValue to use when creating a new one.Method Detail |
---|
public String getValue()
CIValue
.public boolean isListValue()
true
if the value is part of a list.public void setListValue()
public String getAnnotation()
public void setAnnotation(String annotation)
annotation
- The value annotation.public static CIValue[] getCIValues(Collection<String> values)
CIValue
from a list of strings.
Assumes no annotations and no list types are present.
values
- A collection of String
values.
public static List<CIValue> getCIValuesAsList(Collection<String> values)
CIValue
from a list of strings.
Assumes no annotation and no list types are present.
values
- A collection of String
values.
CIValues
.public boolean equals(Object obj)
CIValue
is equal with this one.
equals
in class Object
Object.equals(java.lang.Object)
public boolean isDefaultValue()
public void setDefaultValue()
public String toString()
CIValue
.
toString
in class Object
Object.toString()
public int compareTo(CIValue other)
compareTo
in interface Comparable<CIValue>
Comparable.compareTo(java.lang.Object)
public String getInsertString()
value
field.
protected void setInsertString(String insertString)
insertString
- The value to be inserted in the document.public int getType()
TYPE_PLAIN
,
TYPE_XSLT_AXIS
,
TYPE_XSLT_FUNCTION
or
TYPE_XSLT_ELEMENT
.public Object valueOf(String str)
str
- The str.
public int getAfterInsertCaretPosition()
-1
the caret position was not computed.protected void setValue(String value)
value
- The new value.
|
Oxygen XML Editor 11.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |