# region Import
from __future__ import annotations
from typing import Any, cast, Type, TypeVar
from com.sun.star.awt import XBitmap
from ooodev.format.inner.common.props.area_pattern_props import AreaPatternProps
from ooodev.format.inner.direct.write.fill.area.pattern import Pattern as InnerPattern
from ooodev.format.inner.kind.format_kind import FormatKind
from ooodev.format.inner.modify.write.page.page_style_base_multi import PageStyleBaseMulti
from ooodev.format.inner.preset.preset_pattern import PresetPatternKind
from ooodev.format.writer.style.page.kind.writer_style_page_kind import WriterStylePageKind
# endregion Import
_TPattern = TypeVar("_TPattern", bound="Pattern")
[docs]class Pattern(PageStyleBaseMulti):
"""
Page Footer Pattern
.. seealso::
- :ref:`help_writer_format_modify_page_header_area`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
bitmap: XBitmap | None = None,
name: str = "",
tile: bool = True,
stretch: bool = False,
auto_name: bool = False,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> None:
"""
Constructor
Args:
bitmap (XBitmap, optional): Bitmap instance. If ``name`` is not already in the Bitmap Table then this
property is required.
name (str, optional): Specifies the name of the pattern. This is also the name that is used to store
bitmap in LibreOffice Bitmap Table.
tile (bool, optional): Specified if bitmap is tiled. Defaults to ``True``.
stretch (bool, optional): Specifies if bitmap is stretched. Defaults to ``False``.
auto_name (bool, optional): Specifies if ``name`` is ensured to be unique. Defaults to ``False``.
style_name (StyleParaKind, str, optional): Specifies the Page Style that instance applies to.
Default is Default Page Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
None:
See Also:
- :ref:`help_writer_format_modify_page_header_area`
"""
direct = InnerPattern(
bitmap=bitmap,
name=name,
tile=tile,
stretch=stretch,
auto_name=auto_name,
_cattribs=self._get_inner_cattribs(),
)
super().__init__()
self._style_name = str(style_name)
self._style_family_name = style_family
self._set_style("direct", direct, *direct.get_attrs())
# region Internal Methods
def _get_inner_props(self) -> AreaPatternProps:
return AreaPatternProps(
style="HeaderFillStyle",
name="HeaderFillBitmapName",
tile="HeaderFillBitmapTile",
stretch="HeaderFillBitmapStretch",
bitmap="HeaderFillBitmap",
)
def _get_inner_cattribs(self) -> dict:
return {
"_supported_services_values": self._supported_services(),
"_format_kind_prop": self.prop_format_kind,
"_props_internal_attributes": self._get_inner_props(),
}
# endregion Internal Methods
# region Static Methods
[docs] @classmethod
def from_style(
cls: Type[_TPattern],
doc: Any,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _TPattern:
"""
Gets instance from Document.
Args:
doc (Any): UNO Document Object.
style_name (StyleParaKind, str, optional): Specifies the Paragraph Style that instance applies to.
Default is Default Paragraph Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
Hatch: ``Hatch`` instance from document properties.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerPattern.from_obj(inst.get_style_props(doc), _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
[docs] @classmethod
def from_preset(
cls: Type[_TPattern],
preset: PresetPatternKind,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _TPattern:
"""
Gets instance from preset.
Args:
preset (PresetPatternKind): Preset.
style_name (StyleParaKind, str, optional): Specifies the Paragraph Style that instance applies to.
Default is Default Paragraph Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
Gradient: ``Gradient`` instance from preset.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerPattern.from_preset(preset=preset, _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
# endregion Static Methods
# region Properties
@property
def prop_format_kind(self) -> FormatKind:
"""Gets the kind of style"""
try:
return self._format_kind_prop
except AttributeError:
self._format_kind_prop = FormatKind.DOC | FormatKind.STYLE | FormatKind.HEADER
return self._format_kind_prop
@property
def prop_style_name(self) -> str:
"""Gets/Sets property Style Name"""
return self._style_name
@prop_style_name.setter
def prop_style_name(self, value: str | WriterStylePageKind):
self._style_name = str(value)
@property
def prop_inner(self) -> InnerPattern:
"""Gets/Sets Inner Pattern instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerPattern, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerPattern) -> None:
if not isinstance(value, InnerPattern):
raise TypeError(f'Expected type of InnerPattern, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
self._set_style("direct", value, *value.get_attrs())
# endregion Properties