# region Imports
from __future__ import annotations
from typing import cast
from ooo.dyn.awt.gradient_style import GradientStyle
from ooodev.format.inner.direct.write.fill.transparent.gradient import Gradient as InnerGradient
from ooodev.format.inner.modify.write.frame.frame_style_base_multi import FrameStyleBaseMulti
from ooodev.format.writer.style.frame.style_frame_kind import StyleFrameKind
from ooodev.units.angle import Angle
from ooodev.utils.data_type.intensity import Intensity
from ooodev.utils.data_type.intensity_range import IntensityRange
from ooodev.utils.data_type.offset import Offset
# endregion Imports
[docs]class Gradient(FrameStyleBaseMulti):
"""
Frame Style Transparency Gradient.
.. versionadded:: 0.9.0
"""
# region Init
[docs] def __init__(
self,
*,
style: GradientStyle = GradientStyle.LINEAR,
offset: Offset = Offset(50, 50),
angle: Angle | int = 0,
border: Intensity | int = 0,
grad_intensity: IntensityRange = IntensityRange(0, 0),
style_name: StyleFrameKind | str = StyleFrameKind.FRAME,
style_family: str = "FrameStyles",
) -> None:
"""
Constructor
Args:
style (GradientStyle, optional): Specifies the style of the gradient. Defaults to ``GradientStyle.LINEAR``.
offset (offset, optional): Specifies the X-coordinate (start) and Y-coordinate (end), where the
gradient begins. X is effectively the center of the ``RADIAL``, ``ELLIPTICAL``, ``SQUARE`` and ``RECT``
style gradients. Defaults to ``Offset(50, 50)``.
angle (Angle, int, optional): Specifies angle of the gradient. Defaults to 0.
border (int, optional): Specifies percent of the total width where just the start color is used.
Defaults to ``0``.
grad_intensity (IntensityRange, optional): Specifies the intensity at the start point and stop point of the
gradient. Defaults to ``IntensityRange(0, 0)``.
style_name (StyleFrameKind, str, optional): Specifies the Frame Style that instance applies to.
Default is Default Frame Style.
style_family (str, optional): Style family. Default ``FrameStyles``.
Returns:
None:
"""
direct = InnerGradient(
style=style,
offset=offset,
angle=angle,
border=border,
grad_intensity=grad_intensity,
_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())
# endregion Init
# region Static Methods
[docs] @classmethod
def from_style(
cls,
doc: object,
style_name: StyleFrameKind | str = StyleFrameKind.FRAME,
style_family: str = "FrameStyles",
) -> Gradient:
"""
Gets instance from Document.
Args:
doc (object): UNO Document Object.
style_name (StyleFrameKind, str, optional): Specifies the Frame Style that instance applies to.
Default is Default Frame Style.
style_family (str, optional): Style family. Default ``FrameStyles``.
Returns:
Gradient: ``Gradient`` instance from style properties.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerGradient.from_obj(obj=inst.get_style_props(doc), _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
# endregion Static Methods
# region internal methods
def _get_inner_cattribs(self) -> dict:
return {"_format_kind_prop": self.prop_format_kind, "_supported_services_values": self._supported_services()}
# endregion internal methods
# region Properties
@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 | StyleFrameKind):
self._style_name = str(value)
@property
def prop_inner(self) -> InnerGradient:
"""Gets Inner Gradient instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerGradient, self._get_style_inst("direct"))
return self._direct_inner
# endregion Properties