Class: Pdfrb::Model::Type::OptionalContentMembership

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

Overview

Optional Content Membership (s8.11.4.2). Boolean combination of OCG visibility states.

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

#all_on_policy?Boolean

Returns:

  • (Boolean)


16
17
18
# File 'lib/pdfrb/model/type/optional_content_membership.rb', line 16

def all_on_policy?
  (policy || 1) == 1
end

#any_off_policy?Boolean

Returns:

  • (Boolean)


24
25
26
# File 'lib/pdfrb/model/type/optional_content_membership.rb', line 24

def any_off_policy?
  policy == 3
end

#any_on_policy?Boolean

Returns:

  • (Boolean)


20
21
22
# File 'lib/pdfrb/model/type/optional_content_membership.rb', line 20

def any_on_policy?
  policy == 2
end

#each_ocgObject



32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/pdfrb/model/type/optional_content_membership.rb', line 32

def each_ocg
  return enum_for(:each_ocg) unless block_given?
  return unless ocfgs && document

  arr = ocfgs.is_a?(Pdfrb::Model::Reference) ? document.object(ocfgs) : ocfgs
  return unless arr.is_a?(Array) || arr.is_a?(Pdfrb::Model::PdfArray)

  arr.each do |ref|
    obj = ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
    yield obj if obj
  end
end

#expressionObject



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

def expression; self[:VE]; end

#has_expression?Boolean

Returns:

  • (Boolean)


28
29
30
# File 'lib/pdfrb/model/type/optional_content_membership.rb', line 28

def has_expression?
  !!expression
end

#ocfgsObject



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

def ocfgs; self[:OCGs]; end

#policyObject



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

def policy; self[:P]; end