Modifier and Type	Class and Description
pack-priv static class	OOTextIntoOO.MyPropertyStack

Field Summary

Modifier and Type	Field and Description
private static final String	ATTRIBUTE_NAME_REGEXP
private static final Pattern	ATTRIBUTE_PATTERN
private static final String	ATTRIBUTE_VALUE_REGEXP
private static final String	CHAR_AUTO_ESCAPEMENT
private static final String	CHAR_ESCAPEMENT
private static final String	CHAR_ESCAPEMENT_HEIGHT
private static final byte	CHAR_ESCAPEMENT_HEIGHT_DEFAULT
private static final short	CHAR_ESCAPEMENT_VALUE_DEFAULT
private static final String	CHAR_STRIKEOUT
private static final String	CHAR_STYLE_NAME
private static final String	CHAR_UNDERLINE
private static final Pattern	HTML_TAG
private static final Logger	LOGGER
private static final String	PARA_STYLE_NAME "ParaStyleName" is an OpenOffice Property name.
private static final byte	SUBSCRIPT_HEIGHT
private static final short	SUBSCRIPT_VALUE
private static final byte	SUPERSCRIPT_HEIGHT
private static final short	SUPERSCRIPT_VALUE
private static final String	TAG_NAME_REGEXP

Constructor Summary

Access	Constructor and Description
private	OOTextIntoOO()

Method Summary

Modifier and Type	Method and Description
private static void	insertParagraphBreak(com.sun.star.text.XText text, com.sun.star.text.XTextCursor cursor)
private static boolean	isPropertyDefault(com.sun.star.text.XTextCursor cursor, String propertyName) We rely on property values being either DIRECT_VALUE or DEFAULT_VALUE (not AMBIGUOUS_VALUE).
private static List<OOPair<String, String>>	parseAttributes(String attributes) Parse HTML-like attributes to a list of (name,value) pairs.
public static void	removeDirectFormatting(com.sun.star.text.XTextCursor cursor) Purpose: in some cases we do not want to inherit direct formatting from the context.
public static void	removeEscapementFormatting(@NonNull com.sun.star.text.XTextCursor cursor) Reset only direct superscript/subscript formatting before rewriting marked-up citation text.
private static List<OOPair<String, Object>>	setCharCaseMap(short value)
private static List<OOPair<String, Object>>	setCharEscapement(Optional<Short> value, Optional<Byte> height, boolean relative, OOTextIntoOO.MyPropertyStack formatStack)
private static List<OOPair<String, Object>>	setCharLocale(com.sun.star.lang.Locale value)
private static List<OOPair<String, Object>>	setCharLocale(String value) Locale from string encoding: language, language-country or language-country-variant
private static List<OOPair<String, Object>>	setCharPosture(com.sun.star.awt.FontSlant value)
private static List<OOPair<String, Object>>	setCharStrikeout(short value)
private static List<OOPair<String, Object>>	setCharStyleName(String value)
private static List<OOPair<String, Object>>	setCharUnderline(short value)
private static List<OOPair<String, Object>>	setCharWeight(float value)
public static boolean	setParagraphStyle(com.sun.star.text.XTextCursor cursor, String paragraphStyle) Returns: true on failure
private static List<OOPair<String, Object>>	setSubScript(OOTextIntoOO.MyPropertyStack formatStack)
private static List<OOPair<String, Object>>	setSuperScript(OOTextIntoOO.MyPropertyStack formatStack)
public static void	write(@NonNull com.sun.star.text.XTextDocument doc, @NonNull com.sun.star.text.XTextCursor The cursor giving the insert location. Not modified. position, @NonNull OOText The marked-up text to insert. ootext) Insert a text with formatting indicated by HTML-like tags, into a text at the position given by a cursor.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ATTRIBUTE_NAME_REGEXP	back to summary
private static final String ATTRIBUTE_NAME_REGEXP

ATTRIBUTE_PATTERN	back to summary
private static final Pattern ATTRIBUTE_PATTERN

ATTRIBUTE_VALUE_REGEXP	back to summary
private static final String ATTRIBUTE_VALUE_REGEXP

CHAR_AUTO_ESCAPEMENT	back to summary
private static final String CHAR_AUTO_ESCAPEMENT

CHAR_ESCAPEMENT	back to summary
private static final String CHAR_ESCAPEMENT

CHAR_ESCAPEMENT_HEIGHT	back to summary
private static final String CHAR_ESCAPEMENT_HEIGHT

CHAR_ESCAPEMENT_HEIGHT_DEFAULT	back to summary
private static final byte CHAR_ESCAPEMENT_HEIGHT_DEFAULT

CHAR_ESCAPEMENT_VALUE_DEFAULT	back to summary
private static final short CHAR_ESCAPEMENT_VALUE_DEFAULT

CHAR_STRIKEOUT	back to summary
private static final String CHAR_STRIKEOUT

CHAR_STYLE_NAME	back to summary
private static final String CHAR_STYLE_NAME

CHAR_UNDERLINE	back to summary
private static final String CHAR_UNDERLINE

HTML_TAG	back to summary
private static final Pattern HTML_TAG

LOGGER	back to summary
private static final Logger LOGGER

PARA_STYLE_NAME	back to summary
private static final String PARA_STYLE_NAME "ParaStyleName" is an OpenOffice Property name.

SUBSCRIPT_HEIGHT	back to summary
private static final byte SUBSCRIPT_HEIGHT

SUBSCRIPT_VALUE	back to summary
private static final short SUBSCRIPT_VALUE

SUPERSCRIPT_HEIGHT	back to summary
private static final byte SUPERSCRIPT_HEIGHT

SUPERSCRIPT_VALUE	back to summary
private static final short SUPERSCRIPT_VALUE

TAG_NAME_REGEXP	back to summary
private static final String TAG_NAME_REGEXP

Constructor Detail

OOTextIntoOO	back to summary
private OOTextIntoOO()

Method Detail

insertParagraphBreak	back to summary
private static void insertParagraphBreak(com.sun.star.text.XText text, com.sun.star.text.XTextCursor cursor)

isPropertyDefault	back to summary
private static boolean isPropertyDefault(com.sun.star.text.XTextCursor cursor, String propertyName) throws com.sun.star.beans.UnknownPropertyException We rely on property values being either DIRECT_VALUE or DEFAULT_VALUE (not AMBIGUOUS_VALUE). If the cursor covers a homogeneous region, or is collapsed, then this is true.

parseAttributes	back to summary
private static List<OOPair<String, String>> parseAttributes(String attributes) Parse HTML-like attributes to a list of (name,value) pairs.

removeDirectFormatting	back to summary
public static void removeDirectFormatting(com.sun.star.text.XTextCursor cursor) Purpose: in some cases we do not want to inherit direct formatting from the context. In particular, when filling the bibliography title and body.

removeDirectFormatting

back to summary

public static void removeDirectFormatting(com.sun.star.text.XTextCursor cursor)

Purpose: in some cases we do not want to inherit direct formatting from the context.

In particular, when filling the bibliography title and body.

removeEscapementFormatting	back to summary
public static void removeEscapementFormatting(@NonNull com.sun.star.text.XTextCursor cursor) Reset only direct superscript/subscript formatting before rewriting marked-up citation text.

setCharCaseMap	back to summary
private static List<OOPair<String, Object>> setCharCaseMap(short value)

setCharEscapement	back to summary
private static List<OOPair<String, Object>> setCharEscapement(Optional<Short> value, Optional<Byte> height, boolean relative, OOTextIntoOO.MyPropertyStack formatStack)

setCharLocale	back to summary
private static List<OOPair<String, Object>> setCharLocale(com.sun.star.lang.Locale value)

setCharLocale	back to summary
private static List<OOPair<String, Object>> setCharLocale(String value) Locale from string encoding: language, language-country or language-country-variant

setCharPosture	back to summary
private static List<OOPair<String, Object>> setCharPosture(com.sun.star.awt.FontSlant value)

setCharStrikeout	back to summary
private static List<OOPair<String, Object>> setCharStrikeout(short value)

setCharStyleName	back to summary
private static List<OOPair<String, Object>> setCharStyleName(String value)

setCharUnderline	back to summary
private static List<OOPair<String, Object>> setCharUnderline(short value)

setCharWeight	back to summary
private static List<OOPair<String, Object>> setCharWeight(float value)

setParagraphStyle	back to summary
public static boolean setParagraphStyle(com.sun.star.text.XTextCursor cursor, String paragraphStyle) Returns:boolean true on failure

setSubScript	back to summary
private static List<OOPair<String, Object>> setSubScript(OOTextIntoOO.MyPropertyStack formatStack)

setSuperScript	back to summary
private static List<OOPair<String, Object>> setSuperScript(OOTextIntoOO.MyPropertyStack formatStack)

write back to summary

write	back to summary
public static void write(@NonNull com.sun.star.text.XTextDocument doc, @NonNull com.sun.star.text.XTextCursor position, @NonNull OOText ootext) throws com.sun.star.lang.WrappedTargetException, CreationException Insert a text with formatting indicated by HTML-like tags, into a text at the position given by a cursor. Limitation: understands no entities. It does not receive any either, unless the user provides it. To limit the damage `TAG_NAME_REGEXP` and `ATTRIBUTE_NAME_REGEXP` explicitly lists the names we care about. Notable changes w.r.t insertOOFormattedTextAtCurrentLocation: new tags: `<span lang="zxx">` - earlier was applied from code `<span oo:CharStyleName="CharStylename">` - earlier was applied from code, for "CitationCharacterFormat" `<p>` start new paragraph - earlier was applied from code `<p oo:ParaStyleName="ParStyleName">` : start new paragraph and apply ParStyleName - earlier was applied from code `<tt>` - earlier: known, but ignored - now: equivalent to `<span oo:CharStyleName="Example">` - `<oo:referenceToPageNumberOfReferenceMark>` (self-closing) closing tags try to properly restore state (in particular, the "not directly set" state) instead of dictating an "off" state. This makes a difference when the value inherited from another level (for example the paragraph) is not the "off" state. An example: a style with `ReferenceParagraphFormat="JR_bibentry"` Assume JR_bibentry in LibreOffice is a paragraph style that prescribes "bold" font. LAYOUT only prescribes bold around year. Which parts of the bibliography entries should come out as bold? The user can format citation marks (it is enough to format their start) and the properties not (everywhere) dictated by the style are preserved (where they are not). Parameters position:@NonNull com.sun.star.text.XTextCursor The cursor giving the insert location. Not modified. ootext:@NonNull OOText The marked-up text to insert.

public static void write(@NonNull com.sun.star.text.XTextDocument doc, @NonNull com.sun.star.text.XTextCursor position, @NonNull OOText ootext) throws com.sun.star.lang.WrappedTargetException, CreationException

Insert a text with formatting indicated by HTML-like tags, into a text at the position given by a cursor.

Limitation: understands no entities. It does not receive any either, unless the user provides it.

To limit the damage TAG_NAME_REGEXP and ATTRIBUTE_NAME_REGEXP explicitly lists the names we care about.

Notable changes w.r.t insertOOFormattedTextAtCurrentLocation:

new tags:
 - earlier was applied from code
 - earlier was applied from code, for "CitationCharacterFormat"
 start new paragraph - earlier was applied from code
 : start new paragraph and apply ParStyleName - earlier was applied from code
<tt> - earlier: known, but ignored - now: equivalent to  - <oo:referenceToPageNumberOfReferenceMark> (self-closing)
closing tags try to properly restore state (in particular, the "not directly set" state) instead of dictating an "off" state. This makes a difference when the value inherited from another level (for example the paragraph) is not the "off" state.

An example: a style with ReferenceParagraphFormat="JR_bibentry" Assume JR_bibentry in LibreOffice is a paragraph style that prescribes "bold" font. LAYOUT only prescribes bold around year. Which parts of the bibliography entries should come out as bold?

The user can format citation marks (it is enough to format their start) and the properties not (everywhere) dictated by the style are preserved (where they are not).

Parameters

position:@NonNull com.sun.star.text.XTextCursor: The cursor giving the insert location. Not modified.
ootext:@NonNull OOText: The marked-up text to insert.

org.jabref.model.openoffice.ootext back to summary

pack-priv Class OOTextIntoOO.MyPropertyStack

Class Inheritance

extends Object

java.lang.Object
org.jabref.model.openoffice.ootext.OOTextIntoOO.MyPropertyStack

Field Summary

Modifier and Type	Field and Description
pack-priv static final Set<String>	CONTROLLED_PROPERTIES
pack-priv final String[]	goodNames From index to property name.
pack-priv final Map<String, Integer>	goodNameToIndex From property name to index in goodNames.
pack-priv final int	goodSize The number of properties actually controlled.
pack-priv final Deque<ArrayList<Optional<Object>>>	layers Maintain a stack of layers, each containing a description of the desired state of properties.

Constructor Summary

Access	Constructor and Description
pack-priv	MyPropertyStack(com.sun.star.text.XTextCursor cursor)

Method Summary

Modifier and Type	Method and Description
pack-priv void	apply(com.sun.star.text.XTextCursor cursor) Apply the current desired formatting state to a cursor.
pack-priv Optional<Object>	getPropertyValue(String name)
pack-priv void	popLayer() Closing tags just pop a layer.
pack-priv void	pushLayer(List<OOPair<String, Object>> settings) Given a list of property name, property value pairs, construct and push a new layer describing the intended state after these have been applied.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CONTROLLED_PROPERTIES	back to summary
pack-priv static final Set<String> CONTROLLED_PROPERTIES

goodNames	back to summary
pack-priv final String[] goodNames From index to property name.

goodNameToIndex	back to summary
pack-priv final Map<String, Integer> goodNameToIndex From property name to index in goodNames.

goodSize	back to summary
pack-priv final int goodSize The number of properties actually controlled.

layers	back to summary
pack-priv final Deque<ArrayList<Optional<Object>>> layers Maintain a stack of layers, each containing a description of the desired state of properties. Each description is an ArrayList of property values, Optional.empty() encoding "not directly set".

Constructor Detail

MyPropertyStack	back to summary
pack-priv MyPropertyStack(com.sun.star.text.XTextCursor cursor)

Method Detail

apply

back to summary

pack-priv void apply(com.sun.star.text.XTextCursor cursor)

Apply the current desired formatting state to a cursor.

The idea is to minimize the number of calls to OpenOffice.

getPropertyValue	back to summary
pack-priv Optional<Object> getPropertyValue(String name)

popLayer	back to summary
pack-priv void popLayer() Closing tags just pop a layer.

pushLayer

back to summary

pack-priv void pushLayer(List<OOPair<String, Object>> settings)

Given a list of property name, property value pairs, construct and push a new layer describing the intended state after these have been applied.

Opening tags usually call this.

public Class OOTextIntoOO

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class OOTextIntoOO.MyPropertyStack

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail