Oxygen XML Editor 12.2 Author API

ro.sync.exml.workspace.api.standalone.ditamap
Class TopicRefInfo

java.lang.Object
  extended by ro.sync.exml.workspace.api.standalone.ditamap.TopicRefInfo

public class TopicRefInfo
extends java.lang.Object

A map holding information about the topic reference in the DITA Map. This is filled on the Oxygen side.

Since:
12.2

*********************************
EXPERIMENTAL - Subject to change
********************************

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 element.
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

ABSOLUTE_URL

public static final java.lang.String ABSOLUTE_URL
The absolute URL of the topic reference computed by Oxygen from the "href" value. It does not include the id location.

See Also:
Constant Field Values

ID_PATH

public static final java.lang.String ID_PATH
The ID location (if any) inside the targeted URL.

See Also:
Constant Field Values

HREF_VALUE

public static final java.lang.String HREF_VALUE
The value of the "href" attribute of the element.

See Also:
Constant Field Values
Constructor Detail

TopicRefInfo

public TopicRefInfo()
Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)
Get the value of a recognized property.

Parameters:
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
Returns:
The property value or null if not available.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)
Get the value of a recognized property.

Parameters:
propertyName - The property name. One of the following constants:
propertyValue - The value of the property.
Throws:
java.lang.IllegalArgumentException - If the property name is not one of the constants in this class.

Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.