|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.workspace.api.standalone.ditamap.TopicRefInfo
public class TopicRefInfo
A map holding information about the topic reference in the DITA Map. This is filled on the Oxygen side.
Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
Field Summary | |
---|---|
static java.lang.String |
ABSOLUTE_URL
The absolute URL of the topic reference computed by Oxygen from the "href" value. |
static java.lang.String |
HREF_VALUE
The value of the "href" attribute of the |
static java.lang.String |
ID_PATH
The ID location (if any) inside the targeted URL. |
Constructor Summary | |
---|---|
TopicRefInfo()
|
Method Summary | |
---|---|
java.lang.Object |
getProperty(java.lang.String propertyName)
Get the value of a recognized property. |
void |
setProperty(java.lang.String propertyName,
java.lang.Object propertyValue)
Get the value of a recognized property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ABSOLUTE_URL
public static final java.lang.String ID_PATH
public static final java.lang.String HREF_VALUE
Constructor Detail |
---|
public TopicRefInfo()
Method Detail |
---|
public java.lang.Object getProperty(java.lang.String propertyName)
propertyName
- The property name. One of the following constants:
For example if a DITA Map with the URL "cms://test/file.ditamap" references a topic using the HREF_VALUE
task.dita#task
then the ABSOLUTE_URL
of the topic reference will be cms://test/task.dita and the ID_PATH
will be task
null
if not available.public void setProperty(java.lang.String propertyName, java.lang.Object propertyValue)
propertyName
- The property name. One of the following constants:
propertyValue
- The value of the property.
java.lang.IllegalArgumentException
- If the property name is not one of the constants in this class.
|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |