# region Import
from __future__ import annotations
from typing import Any, cast, Type, TypeVar, TYPE_CHECKING
from ooo.dyn.drawing.hatch_style import HatchStyle
from ooodev.format.inner.common.props.area_hatch_props import AreaHatchProps
from ooodev.format.inner.direct.write.fill.area.hatch import Hatch as InnerHatch
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_hatch import PresetHatchKind
from ooodev.format.writer.style.page.kind.writer_style_page_kind import WriterStylePageKind
from ooodev.units.angle import Angle
from ooodev.utils.color import Color
from ooodev.utils.color import StandardColor
if TYPE_CHECKING:
from ooodev.units.unit_obj import UnitT
# endregion Import
_THatch = TypeVar("_THatch", bound="Hatch")
[docs]class Hatch(PageStyleBaseMulti):
"""
Page Footer Hatch
.. seealso::
- :ref:`help_writer_format_modify_page_header_area`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
style: HatchStyle = HatchStyle.SINGLE,
color: Color = StandardColor.BLACK,
space: float | UnitT = 0.0,
angle: Angle | int = 0,
bg_color: Color = StandardColor.AUTO_COLOR,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> None:
"""
Constructor
Args:
style (HatchStyle, optional): Specifies the kind of lines used to draw this hatch.
Default ``HatchStyle.SINGLE``.
color (:py:data:`~.utils.color.Color`, optional): Specifies the color of the hatch lines. Default ``0``.
space (float, UnitT, optional): Specifies the space between the lines in the hatch (in ``mm`` units)
or :ref:`proto_unit_obj`. Default ``0.0``
angle (Angle, int, optional): Specifies angle of the hatch in degrees.
Default to ``0``.
bg_color(:py:data:`~.utils.color.Color`, optional): Specifies the background Color. Set this ``-1`` (default) for no background color.
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 = InnerHatch(
style=style,
color=color,
space=space,
angle=angle,
bg_color=bg_color,
_cattribs=self._get_inner_cattribs(), # type: ignore
)
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) -> AreaHatchProps:
return AreaHatchProps(
color="HeaderFillColor",
style="HeaderFillStyle",
bg="HeaderFillBackground",
hatch_prop="HeaderFillHatch",
)
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[_THatch],
doc: Any,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _THatch:
"""
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 = InnerHatch.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[_THatch],
preset: PresetHatchKind,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _THatch:
"""
Gets instance from preset.
Args:
preset (PresetHatchKind): 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 = InnerHatch.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) -> InnerHatch:
"""Gets/Sets Inner Hatch instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerHatch, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerHatch) -> None:
if not isinstance(value, InnerHatch):
raise TypeError(f'Expected type of InnerHatch, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
self._set_style("direct", value, *value.get_attrs())
# endregion Properties