org.docx4j.openpackaging.parts.WordprocessingML

Class StyleDefinitionsPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<E>

org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware<Styles>

org.docx4j.openpackaging.parts.WordprocessingML.StyleDefinitionsPart

All Implemented Interfaces:

XPathEnabled<Styles>

public final class StyleDefinitionsPart
extends JaxbXmlPartXPathAware<Styles>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	docDefaultsString
static java.lang.String	pPrDefaultsString
static java.lang.String	rPrDefaultsString

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

binder

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor and Description
StyleDefinitionsPart()
StyleDefinitionsPart(PartName partName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCss()
Style	getDefaultCharacterStyle()
Style	getDefaultParagraphStyle() if this returns null; invoke createVirtualStylesForDocDefaults() @since 3.2.0 then try again
Style	getDefaultTableStyle()
java.lang.String	getIDForStyleName(java.lang.String name) Given the name of a style known in this part, return the corresponding style ID.
static java.util.Map<java.lang.String,Style>	getKnownStyles() Returns a map of styles defined in docx4j's KnownStyles.xml (not styles defined in your pkg)
Style	getLinkedStyle(java.lang.String rStyleVal) For a run/character style return its linked paragraph style (if any), or vice versa.
java.lang.String	getMceIgnorable()
java.lang.String	getNameForStyleID(java.lang.String id) Given the ID of a style known in this part, return the corresponding style name.
Style	getStyleById(java.lang.String id)
void	init()
void	protectRestrictFormatting(java.util.List<java.lang.String> allowedStyleNames, boolean removedNotAllowedFormatting, java.util.Set<java.lang.String> stylesInUse) Restrict allowed formatting to specified styles.
void	refreshNameIdBiMaps() Refresh the style name - ID bimaps, based on styles currently defined in this part.
void	setCss(java.lang.String css)
void	setJaxbElement(Styles jaxbElement) You can't use this override to create/update a binder, since this would set the jaxbElement field to something different to the object being passed in (as a consequence of the process to create a binder).
protected void	setMceIgnorable(McIgnorableNamespaceDeclarator namespacePrefixMapper) Where the mc:Ignorable attribute is present, ensure its contents matches the ignorable namespaces actually present.
java.lang.Object	unmarshalDefaultStyles() Unmarshal a default set of styles, useful when creating this part from scratch.

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

createBinderAndJaxbElement, getBinder, getJAXBAssociationsForXPath, getJAXBAssociationsForXPath, getJAXBNodesViaXPath, getJAXBNodesViaXPath, unmarshal, unmarshal

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getXML, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, setContents, setJAXBContext, setJaxbElement, transform, transformToDom, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rPrDefaultsString

public static final java.lang.String rPrDefaultsString

See Also:

Constant Field Values

pPrDefaultsString

public static final java.lang.String pPrDefaultsString

See Also:

Constant Field Values

docDefaultsString

public static final java.lang.String docDefaultsString

See Also:

Constant Field Values

Constructor Detail

StyleDefinitionsPart

public StyleDefinitionsPart(PartName partName)
                     throws InvalidFormatException

Throws:

InvalidFormatException

StyleDefinitionsPart

public StyleDefinitionsPart()
                     throws InvalidFormatException

Throws:

InvalidFormatException

Method Detail

init

public void init()

setMceIgnorable

protected void setMceIgnorable(McIgnorableNamespaceDeclarator namespacePrefixMapper)

Description copied from class: JaxbXmlPart

Where the mc:Ignorable attribute is present, ensure its contents matches the ignorable namespaces actually present.

Overrides:

setMceIgnorable in class JaxbXmlPart<Styles>

getMceIgnorable

public java.lang.String getMceIgnorable()

Overrides:

getMceIgnorable in class JaxbXmlPart<Styles>

setJaxbElement

public void setJaxbElement(Styles jaxbElement)

Description copied from class: JaxbXmlPartXPathAware

You can't use this override to create/update a binder, since this would set the jaxbElement field to something different to the object being passed in (as a consequence of the process to create a binder). We don't want that, because calling code may then continue to manipulate the field, without effect.. See instead createBinderAndJaxbElement

Overrides:

setJaxbElement in class JaxbXmlPartXPathAware<Styles>

unmarshalDefaultStyles

public java.lang.Object unmarshalDefaultStyles()
                                        throws javax.xml.bind.JAXBException

Unmarshal a default set of styles, useful when creating this part from scratch.

Returns:

the newly created root object of the java content tree

Throws:

javax.xml.bind.JAXBException - If any unexpected errors occur while unmarshalling

getKnownStyles

public static java.util.Map<java.lang.String,Style> getKnownStyles()

Returns a map of styles defined in docx4j's KnownStyles.xml (not styles defined in your pkg)

Returns:

getStyleById

public Style getStyleById(java.lang.String id)

Parameters:

id -

Returns:

Since:

3.0.0

getDefaultCharacterStyle

public Style getDefaultCharacterStyle()

getDefaultParagraphStyle

public Style getDefaultParagraphStyle()

if this returns null; invoke createVirtualStylesForDocDefaults() @since 3.2.0 then try again

Returns:

getDefaultTableStyle

public Style getDefaultTableStyle()

Since:

3.0

getCss

public java.lang.String getCss()

setCss

public void setCss(java.lang.String css)

getLinkedStyle

public Style getLinkedStyle(java.lang.String rStyleVal)

For a run/character style return its linked paragraph style (if any), or vice versa.

Parameters:

rStyleVal -

Returns:

protectRestrictFormatting

public void protectRestrictFormatting(java.util.List<java.lang.String> allowedStyleNames,
                                      boolean removedNotAllowedFormatting,
                                      java.util.Set<java.lang.String> stylesInUse)
                               throws Docx4JException

Restrict allowed formatting to specified styles. You don't want to use this directly; use the method with the same name in WordprocessingMLPackage Formatting or styles that aren't allowed are not removed.

Parameters:

allowedStyleNames -

Throws:

Docx4JException

Since:

3.3.0

getNameForStyleID

public java.lang.String getNameForStyleID(java.lang.String id)

Given the ID of a style known in this part, return the corresponding style name.

Parameters:

id -

Returns:

Since:

3.3.0

getIDForStyleName

public java.lang.String getIDForStyleName(java.lang.String name)

Given the name of a style known in this part, return the corresponding style ID.

Parameters:

name -

Returns:

Since:

3.3.0

refreshNameIdBiMaps

public void refreshNameIdBiMaps()

Refresh the style name - ID bimaps, based on styles currently defined in this part.

Since:

3.3.0