Class: HexaPDF::Type::Annotations::SquareCircle

Inherits:
MarkupAnnotation show all
Includes:
BorderEffect, BorderStyling, InteriorColor
Defined in:
lib/hexapdf/type/annotations/square_circle.rb

Overview

This is the base class for the square and circle markup annotations which display a rectangle or ellipse inside the annotation rectangle.

The styling is done through methods included by various modules:

  • Changing the line width, line dash pattern and color is done using the method BorderStyling#border_style. While that method allows special styling of the line (like :beveled), only a simple line dash pattern is supported by the square and circle annotations.

  • The interior color can be changed through InteriorColor#interior_color.

  • The border effect can be changed through BorderEffect#border_effect. Note that cloudy borders are not supported.

See: PDF2.0 s12.5.6.8, HexaPDF::Type::Annotations::Square, HexaPDF::Type::Annotations::Circle, HexaPDF::Type::MarkupAnnotation

Direct Known Subclasses

Circle, Square

Constant Summary

Constants included from DictionaryFields

DictionaryFields::Boolean, DictionaryFields::PDFByteString, DictionaryFields::PDFDate

Instance Attribute Summary

Attributes inherited from Object

#data, #document, #must_be_indirect

Method Summary

Methods included from InteriorColor

#interior_color

Methods included from BorderEffect

#border_effect

Methods included from BorderStyling

#border_style

Methods inherited from HexaPDF::Type::Annotation

#appearance, #appearance_dict, #contents, #create_appearance, #flags, #must_be_indirect?, #opacity, #regenerate_appearance

Methods included from Utils::BitField

#bit_field

Methods inherited from Dictionary

#[], #[]=, define_field, define_type, #delete, #each, each_field, #empty?, field, #key?, #to_hash, type, #type

Methods inherited from Object

#<=>, #==, #cache, #cached?, #clear_cache, deep_copy, #deep_copy, #document?, #eql?, field, #gen, #gen=, #hash, #indirect?, #initialize, #inspect, make_direct, #must_be_indirect?, #null?, #oid, #oid=, #type, #validate, #value, #value=

Constructor Details

This class inherits a constructor from HexaPDF::Object