Verified Owner
Top Description Fields Constructors Methods
org.jabref.model.openoffice.uno

public Class UnoUserDefinedProperty

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, .Optional, com.sun.star.beans.IllegalTypeException, com.sun.star.beans.NotRemoveableException, com.sun.star.beans.PropertyAttribute, com.sun.star.beans.PropertyExistException, com.sun.star.beans.PropertyVetoException, com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.XPropertyContainer, com.sun.star.beans.XPropertySet, com.sun.star.beans.XPropertySetInfo, com.sun.star.document.XDocumentProperties, com.sun.star.lang.WrappedTargetException, com.sun.star.text.XTextDocument, com.sun.star.uno.Any, .Type, org.jspecify.annotations.NonNull, org.slf4j.Logger, .LoggerFactory
Document level user-defined properties.

LibreOffice GUI: [File]/[Properties]/[Custom Properties]

Field Summary

Modifier and TypeField and Description
private static final Logger
LOGGER

Constructor Summary

AccessConstructor and Description
private
UnoUserDefinedProperty()

Method Summary

Modifier and TypeMethod and Description
public static List<String>
getListOfNames(com.sun.star.text.XTextDocument doc)

public static Optional<com.sun.star.beans.XPropertyContainer>
getPropertyContainer(com.sun.star.text.XTextDocument doc)

public static Optional<String>
getStringValue(com.sun.star.text.XTextDocument doc, String
Name of a custom document property in the current document.
property)

Returns: The value of the property or Optional.empty() These properties are used to store extra data about individual citation.

public static void
remove(com.sun.star.text.XTextDocument doc, @NonNull String
Name of a custom document property in the current document. Logs warning if does not exist.
property)

public static void
removeIfExists(com.sun.star.text.XTextDocument doc, @NonNull String
Name of a custom document property in the current document. Keep silent if property did not exist.
property)

public static void
setStringProperty(com.sun.star.text.XTextDocument doc, @NonNull String
Name of a custom document property in the current document. Created if does not exist yet.
property, @NonNull String
The value to be stored.
value)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

LOGGERback to summary
private static final Logger LOGGER

Constructor Detail

UnoUserDefinedPropertyback to summary
private UnoUserDefinedProperty()

Method Detail

getListOfNamesback to summary
public static List<String> getListOfNames(com.sun.star.text.XTextDocument doc)
getPropertyContainerback to summary
public static Optional<com.sun.star.beans.XPropertyContainer> getPropertyContainer(com.sun.star.text.XTextDocument doc)
getStringValueback to summary
public static Optional<String> getStringValue(com.sun.star.text.XTextDocument doc, String property) throws com.sun.star.lang.WrappedTargetException
Parameters
property:String

Name of a custom document property in the current document.

Returns:Optional<String>

The value of the property or Optional.empty() These properties are used to store extra data about individual citation. In particular, the pageInfo part.

removeback to summary
public static void remove(com.sun.star.text.XTextDocument doc, @NonNull String property) throws com.sun.star.beans.NotRemoveableException
Parameters
property:@NonNull String

Name of a custom document property in the current document. Logs warning if does not exist.

removeIfExistsback to summary
public static void removeIfExists(com.sun.star.text.XTextDocument doc, @NonNull String property) throws com.sun.star.beans.NotRemoveableException
Parameters
property:@NonNull String

Name of a custom document property in the current document. Keep silent if property did not exist.

setStringPropertyback to summary
public static void setStringProperty(com.sun.star.text.XTextDocument doc, @NonNull String property, @NonNull String value) throws com.sun.star.beans.IllegalTypeException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.WrappedTargetException
Parameters
property:@NonNull String

Name of a custom document property in the current document. Created if does not exist yet.

value:@NonNull String

The value to be stored.