Class TopicRefInfo
java.lang.Object
ro.sync.exml.workspace.api.standalone.ditamap.TopicRefInfo
A map holding information about the topic reference in the DITA Map.
This is filled on the Oxygen side.
- Since:
- 12.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The absolute URL of the map in which the topicref is located.static final String
The absolute URL of the topic reference computed by Oxygen from the "href" value.static final String
The value of the "href" attribute of the <topicref> element.static final String
The ID location (if any) inside the targeted URL.static final String
The key scopes context in which the topicref is placed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetProperty
(String propertyName) Get the value of a recognized property.void
setProperty
(String propertyName, Object propertyValue) Get the value of a recognized property.
-
Field Details
-
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:
-
ID_PATH
The ID location (if any) inside the targeted URL.- See Also:
-
HREF_VALUE
The value of the "href" attribute of the <topicref> element.- See Also:
-
KEY_SCOPES
The key scopes context in which the topicref is placed. Either empty string or something like "ks1.ks2".- See Also:
-
ABSOLUTE_BASE_URL
The absolute URL of the map in which the topicref is located.- See Also:
-
-
Constructor Details
-
TopicRefInfo
public TopicRefInfo()
-
-
Method Details
-
getProperty
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 theHREF_VALUE
task.dita#task then theABSOLUTE_URL
of the topic reference will be cms://test/task.dita and theID_PATH
will be task- Returns:
- The property value or
null
if not available.
-
setProperty
Get the value of a recognized property.- Parameters:
propertyName
- The property name. One of the following constants:propertyValue
- The value of the property.- Throws:
IllegalArgumentException
- If the property name is not one of the constants in this class.
-