Class: Pdfrb::Model::Type::BorderStyling

Inherits:
Cos::Dictionary show all
Defined in:
lib/pdfrb/model/type/border_styling.rb

Overview

BorderStyling (s12.5.4.1, PDF 2.0). Replaces the deprecated /Border array on annotations. Specifies width, dash, style.

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary collapse

Methods inherited from Cos::Dictionary

#[], #[]=, arlington_available?, arlington_default, arlington_key_to_symbol, arlington_loaded_for?, arlington_mark_loaded, arlington_object, arlington_one_type_to_ruby, arlington_required?, arlington_types_to_ruby, arlington_version, define_field, define_field_from_arlington, #delete, #each, each_field, #each_raw, #empty?, field, #initialize, #key?, #keys, lookup_type, own_fields, #pdf_type, register_type, type_map, #validate

Methods inherited from Object

#==, define_type, #deref, #indirect?, #initialize, #must_be_indirect?, #pdf_type, pdf_type

Constructor Details

This class inherits a constructor from Pdfrb::Model::Cos::Dictionary

Instance Method Details

#beveled? ⇒ Boolean

Returns:

  • (Boolean) 


18
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 18

def beveled?; style == :B; end

#dash ⇒ Object 



14
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 14

def dash; self[:D]; end

#dash_array ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 22

def dash_array
  return nil unless dash

  arr = dash.is_a?(Pdfrb::Model::PdfArray) ? dash.to_a : dash
  arr.is_a?(Array) && arr.size >= 1 ? arr[0] : nil
end

#dash_phase ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 29

def dash_phase
  return nil unless dash

  arr = dash.is_a?(Pdfrb::Model::PdfArray) ? dash.to_a : dash
  arr.is_a?(Array) && arr.size >= 2 ? arr[1] : 0
end

#dashed? ⇒ Boolean

Returns:

  • (Boolean) 


17
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 17

def dashed?; style == :D; end

#inset? ⇒ Boolean

Returns:

  • (Boolean) 


19
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 19

def inset?; style == :I; end

#solid? ⇒ Boolean

Returns:

  • (Boolean) 


16
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 16

def solid?; style.nil? || style == :S; end

#style ⇒ Object 



12
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 12

def style; self[:S]&.to_sym; end

#type ⇒ Object 



11
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 11

def type; self[:Type]; end

#underline? ⇒ Boolean

Returns:

  • (Boolean) 


20
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 20

def underline?; style == :U; end

#width ⇒ Object 



13
 
# File 'lib/pdfrb/model/type/border_styling.rb', line 13

def width; self[:W] || 1.0; end