OpenXMLOptions (OmegaT 5.7.0 API)

java.lang.Object
- org.omegat.filters2.AbstractOptions
- - org.omegat.filters3.xml.openxml.OpenXMLOptions

```
public class OpenXMLOptions
extends AbstractOptions
```
Options for OpenXML filter. Serializable to allow saving to / reading from configuration file.
OpenDoc filter have the following options ([+] means default on). Translatable elements:
- [] Hidden text (Word)
- [+] Comments (Word)
- [+] Footnotes (Word)
- [+] Endnotes (Word)
- [+] Header (Word)
- [+] Footer (Word)
- [] Duplicate fallback text (Word)
- [] Document properties (Word)
- [+] Comments (Excel)
- [] Sheet names (Excel)
- [+] Slide comments (PowerPoint)
- [] Slide Masters (PowerPoint)
- [] Slide Layouts (PowerPoint)
- [] External links (PowerPoint)
- [] Charts (Global)
- [] Diagrams (Global)
- [] Drawings (Global)
- [] WordArt (Global)
Other options:
- [+] Tags Aggregation
- [+] Preserve space for all tags
- [+] Start a new paragraph on Word soft return

Constructor Summary

Constructors
Constructor and Description

OpenXMLOptions(java.util.Map<java.lang.String,java.lang.String> options)

Constructors
Constructor and Description
`OpenXMLOptions(java.util.Map<java.lang.String,java.lang.String> options)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`getAggregateTags()` Returns whether OpenXML tags should be aggregated.
`boolean`	`getBreakOnBr()` Returns whether a new paragraph should be created on "w:br"
`boolean`	`getSpacePreserving()` Returns whether spaces should be preserved for all tags
`boolean`	`getTranslateCharts()` Returns whether Charts should be translated.
`boolean`	`getTranslateComments()` Returns whether Commments should be translated.
`boolean`	`getTranslateDiagrams()` Returns whether Diagrams should be translated.
`boolean`	`getTranslateDocumentProperties()` Returns whether Word document properties should be translated
`boolean`	`getTranslateDrawings()` Returns whether Drawings should be translated.
`boolean`	`getTranslateEndnotes()` Returns whether Endnotes should be translated.
`boolean`	`getTranslateExcelComments()` Returns whether Excel Comments should be translated.
`boolean`	`getTranslateFallbackText()`
`boolean`	`getTranslateFooters()` Returns whether Footers should be translated.
`boolean`	`getTranslateFootnotes()` Returns whether Footnotes should be translated.
`boolean`	`getTranslateHeaders()` Returns whether Headers should be translated.
`boolean`	`getTranslateHiddenText()` Returns whether Hidden Text should be translated.
`boolean`	`getTranslateLinks()` Returns whether Slide Links should be translated.
`boolean`	`getTranslateSheetNames()` Returns whether Excel Sheet Names should be translated.
`boolean`	`getTranslateSlideComments()` Returns whether Slide Comments should be translated.
`boolean`	`getTranslateSlideLayouts()` Returns whether Slide Layouts should be translated.
`boolean`	`getTranslateSlideLinks()` Deprecated. use getTranslateLinks()
`boolean`	`getTranslateSlideMasters()` Returns whether Slide Masters should be translated.
`boolean`	`getTranslateWordArt()` Returns whether Word art should be translated.
`void`	`setAggregateTags(boolean aggregateTags)` Sets whether OpenXML tags should be aggregated.
`void`	`setBreakOnBr(boolean breakOnBr)` Sets whether a new paragraph should be created on "w:br"
`void`	`setSpacePreserving(boolean onOff)` Sets whether spaces should be preserved for all tags
`void`	`setTranslateCharts(boolean translateCharts)` Sets whether Charts should be translated.
`void`	`setTranslateComments(boolean translateComments)` Sets whether Comments should be translated.
`void`	`setTranslateDiagrams(boolean translateDiagrams)` Sets whether Diagrams should be translated.
`void`	`setTranslateDocumentProperties(boolean translateDocumentProperties)` Sets whether Word document properties should be translated
`void`	`setTranslateDrawings(boolean translateDrawings)` Sets whether Drawings should be translated.
`void`	`setTranslateEndnotes(boolean translateEndnotes)` Sets whether Footnotes should be translated.
`void`	`setTranslateExcelComments(boolean translateExcelComments)` Sets whether Excel Comments should be translated.
`void`	`setTranslateFallbackText(boolean translateFallbackText)` Sets whether Fallback Text should be translated.
`void`	`setTranslateFooters(boolean translateFooters)` Sets whether Footers should be translated.
`void`	`setTranslateFootnotes(boolean translateFootnotes)` Sets whether Footnotes should be translated.
`void`	`setTranslateHeaders(boolean translateHeaders)` Sets whether Headers should be translated.
`void`	`setTranslateHiddenText(boolean translateHiddenText)` Sets whether Hidden Text should be translated.
`void`	`setTranslateLinks(boolean translateLinks)` Sets whether Slide Links should be translated.
`void`	`setTranslateSheetNames(boolean translateExcelSheetNames)` Sets whether Excel Comments should be translated.
`void`	`setTranslateSlideComments(boolean translateSlideComments)` Sets whether Slide Comments should be translated.
`void`	`setTranslateSlideLayouts(boolean translateSlideLayouts)` Sets whether Slide Layouts should be translated.
`void`	`setTranslateSlideLinks(boolean translateSlideLinks)` Deprecated. use setTranslateLinks(boolean)
`void`	`setTranslateSlideMasters(boolean translateSlideMasters)` Sets whether Slide Masters should be translated.
`void`	`setTranslateWordArt(boolean translateWordArt)` Sets whether Word art should be translated.

Methods inherited from class org.omegat.filters2.AbstractOptions
getBoolean, getEnum, getOptionsMap, getString, setBoolean, setEnum, setString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OpenXMLOptions
```
public OpenXMLOptions(java.util.Map<java.lang.String,java.lang.String> options)
```
- Method Detail
  - getTranslateHiddenText
```
public boolean getTranslateHiddenText()
```
    Returns whether Hidden Text should be translated.
  - setTranslateHiddenText
```
public void setTranslateHiddenText(boolean translateHiddenText)
```
    Sets whether Hidden Text should be translated.
  - getTranslateComments
```
public boolean getTranslateComments()
```
    Returns whether Commments should be translated.
  - setTranslateComments
```
public void setTranslateComments(boolean translateComments)
```
    Sets whether Comments should be translated.
  - getTranslateFootnotes
```
public boolean getTranslateFootnotes()
```
    Returns whether Footnotes should be translated.
  - setTranslateFootnotes
```
public void setTranslateFootnotes(boolean translateFootnotes)
```
    Sets whether Footnotes should be translated.
  - getTranslateEndnotes
```
public boolean getTranslateEndnotes()
```
    Returns whether Endnotes should be translated.
  - setTranslateEndnotes
```
public void setTranslateEndnotes(boolean translateEndnotes)
```
    Sets whether Footnotes should be translated.
  - getTranslateHeaders
```
public boolean getTranslateHeaders()
```
    Returns whether Headers should be translated.
  - setTranslateHeaders
```
public void setTranslateHeaders(boolean translateHeaders)
```
    Sets whether Headers should be translated.
  - getTranslateFooters
```
public boolean getTranslateFooters()
```
    Returns whether Footers should be translated.
  - setTranslateFooters
```
public void setTranslateFooters(boolean translateFooters)
```
    Sets whether Footers should be translated.
  - getTranslateFallbackText
```
public boolean getTranslateFallbackText()
```
    Returns:
    
    whether Fallback Text should be translated.
  - setTranslateFallbackText
```
public void setTranslateFallbackText(boolean translateFallbackText)
```
    Sets whether Fallback Text should be translated.
  - getTranslateDiagrams
```
public boolean getTranslateDiagrams()
```
    Returns whether Diagrams should be translated.
  - setTranslateDiagrams
```
public void setTranslateDiagrams(boolean translateDiagrams)
```
    Sets whether Diagrams should be translated.
  - getTranslateExcelComments
```
public boolean getTranslateExcelComments()
```
    Returns whether Excel Comments should be translated.
  - setTranslateExcelComments
```
public void setTranslateExcelComments(boolean translateExcelComments)
```
    Sets whether Excel Comments should be translated.
  - getTranslateSheetNames
```
public boolean getTranslateSheetNames()
```
    Returns whether Excel Sheet Names should be translated.
  - setTranslateSheetNames
```
public void setTranslateSheetNames(boolean translateExcelSheetNames)
```
    Sets whether Excel Comments should be translated.
  - getTranslateSlideComments
```
public boolean getTranslateSlideComments()
```
    Returns whether Slide Comments should be translated.
  - setTranslateSlideComments
```
public void setTranslateSlideComments(boolean translateSlideComments)
```
    Sets whether Slide Comments should be translated.
  - getTranslateSlideMasters
```
public boolean getTranslateSlideMasters()
```
    Returns whether Slide Masters should be translated.
  - setTranslateSlideMasters
```
public void setTranslateSlideMasters(boolean translateSlideMasters)
```
    Sets whether Slide Masters should be translated.
  - getTranslateSlideLayouts
```
public boolean getTranslateSlideLayouts()
```
    Returns whether Slide Layouts should be translated.
  - setTranslateSlideLayouts
```
public void setTranslateSlideLayouts(boolean translateSlideLayouts)
```
    Sets whether Slide Layouts should be translated.
  - getTranslateSlideLinks
```
@Deprecated
public boolean getTranslateSlideLinks()
```
    Deprecated. use getTranslateLinks()
    
    Returns whether Slide Links should be translated.
    
    Returns:
    
    the state of OPTION_TRANSLATE_SLIDE_LINKS
  - setTranslateSlideLinks
```
@Deprecated
public void setTranslateSlideLinks(boolean translateSlideLinks)
```
    Deprecated. use setTranslateLinks(boolean)
    
    Sets whether Slide Links should be translated.
    
    Parameters:
    
    translateSlideLinks - The option to translate external links
  - getTranslateLinks
```
public boolean getTranslateLinks()
```
    Returns whether Slide Links should be translated.
    
    Returns:
    
    the state of OPTION_TRANSLATE_SLIDE_LINKS
  - setTranslateLinks
```
public void setTranslateLinks(boolean translateLinks)
```
    Sets whether Slide Links should be translated.
    
    Parameters:
    
    translateSlideLinks - The option to translate external links
  - getTranslateCharts
```
public boolean getTranslateCharts()
```
    Returns whether Charts should be translated.
  - setTranslateCharts
```
public void setTranslateCharts(boolean translateCharts)
```
    Sets whether Charts should be translated.
  - getTranslateDrawings
```
public boolean getTranslateDrawings()
```
    Returns whether Drawings should be translated.
  - setTranslateDrawings
```
public void setTranslateDrawings(boolean translateDrawings)
```
    Sets whether Drawings should be translated.
  - getTranslateWordArt
```
public boolean getTranslateWordArt()
```
    Returns whether Word art should be translated.
  - setTranslateWordArt
```
public void setTranslateWordArt(boolean translateWordArt)
```
    Sets whether Word art should be translated.
  - getAggregateTags
```
public boolean getAggregateTags()
```
    Returns whether OpenXML tags should be aggregated.
  - setAggregateTags
```
public void setAggregateTags(boolean aggregateTags)
```
    Sets whether OpenXML tags should be aggregated.
  - getSpacePreserving
```
public boolean getSpacePreserving()
```
    Returns whether spaces should be preserved for all tags
    
    Returns:
    
    the state of OPTION_PRESERVE_SPACES
  - setSpacePreserving
```
public void setSpacePreserving(boolean onOff)
```
    Sets whether spaces should be preserved for all tags
    
    Parameters:
    
    onOff - The option for space preserving
  - getBreakOnBr
```
public boolean getBreakOnBr()
```
    Returns whether a new paragraph should be created on "w:br"
    
    Returns:
    
    the state of OPTION_BREAK_ON_BR
  - setBreakOnBr
```
public void setBreakOnBr(boolean breakOnBr)
```
    Sets whether a new paragraph should be created on "w:br"
    
    Parameters:
    
    breakOnBr - The option whether to break or not
  - getTranslateDocumentProperties
```
public boolean getTranslateDocumentProperties()
```
    Returns whether Word document properties should be translated
    
    Returns:
    
    the state of OPTION_DOCUMENT_PROPERTIES
  - setTranslateDocumentProperties
```
public void setTranslateDocumentProperties(boolean translateDocumentProperties)
```
    Sets whether Word document properties should be translated
    
    Parameters:
    
    translateDocumentProperties - The option whether to translate document properties or not

Class OpenXMLOptions

Constructor Summary

Method Summary

Methods inherited from class org.omegat.filters2.AbstractOptions

Methods inherited from class java.lang.Object

Constructor Detail

OpenXMLOptions

Method Detail

getTranslateHiddenText

setTranslateHiddenText

getTranslateComments

setTranslateComments

getTranslateFootnotes

setTranslateFootnotes

getTranslateEndnotes

setTranslateEndnotes

getTranslateHeaders

setTranslateHeaders

getTranslateFooters

setTranslateFooters

getTranslateFallbackText

setTranslateFallbackText

getTranslateDiagrams

setTranslateDiagrams

getTranslateExcelComments

setTranslateExcelComments

getTranslateSheetNames

setTranslateSheetNames

getTranslateSlideComments

setTranslateSlideComments

getTranslateSlideMasters

setTranslateSlideMasters

getTranslateSlideLayouts

setTranslateSlideLayouts

getTranslateSlideLinks

setTranslateSlideLinks

getTranslateLinks

setTranslateLinks

getTranslateCharts

setTranslateCharts

getTranslateDrawings

setTranslateDrawings

getTranslateWordArt

setTranslateWordArt

getAggregateTags

setAggregateTags

getSpacePreserving

setSpacePreserving

getBreakOnBr

setBreakOnBr

getTranslateDocumentProperties

setTranslateDocumentProperties