Class: CSL::Style::Group

Inherits:
Node show all
Defined in:
lib/csl/style/group.rb

Overview

The Group rendering element must contain one or more rendering element (with the exception of Layout). Group nodes may carry the delimiter attribute to separate their child elements, as well as affixes and display attributes (applied to the output of the group as a whole) and formatting attributes (transmitted to the enclosed elements).

Groups implicitly act as a conditionals: a Group and its child elements are suppressed if a) at least one rendering element in the Group calls a variable (either directly or via a macro), and b) all variables that are called are empty.

Instance Attribute Summary

Attributes inherited from Node

#attributes

Attributes included from Treelike

#children, #nodename, #parent

Instance Method Summary collapse

Methods inherited from Node

#<=>, #attribute?, #attributes?, #attributes_for, constantize, create, create_attributes, #custom_attributes, #deep_copy, #default_attribute?, default_attributes, #default_attributes, #each, #exact_match?, #format_page_ranges?, #has_attributes?, #has_default_attributes?, #has_language?, hide_default_attributes!, hide_default_attributes?, #initialize, #initialize_copy, #inspect, #match?, match?, matches?, #merge!, #page_range_format, parse, parse!, #quotes?, #reverse_merge!, #save_to, show_default_attributes!, #strip_periods?, #tags, #textnode?, types

Methods included from Extensions::Nesting

#nesting

Methods included from PrettyPrinter

#pretty_print, #tags, #to_xml

Methods included from Treelike

#<<, #add_child, #add_children, #ancestors, #closest, #delete_child, #delete_children, #depth, #descendants, #each_ancestor, #each_child, #each_descendant, #each_sibling, #empty?, #find_child, #find_children, #has_children?, #root, #root?, #siblings, #unlink

Constructor Details

This class inherits a constructor from CSL::Node

Instance Method Details

#delimiter ⇒ Object 



18
19
20
 
# File 'lib/csl/style/group.rb', line 18

def delimiter
  attributes.fetch(:delimiter, '')
end

#formatting_options ⇒ Hash

Returns only those formatting options applicable to the Group node itself; not those which are transmitted to the enclosed elements.

Returns:

  • (Hash) —

    the node’s formatting options



27
28
29
 
# File 'lib/csl/style/group.rb', line 27

def formatting_options
  attributes_for :display, *Schema.attr(:affixes) 
end

#inheritable_formatting_options ⇒ Object 



31
32
33
 
# File 'lib/csl/style/group.rb', line 31

def inheritable_formatting_options
  attributes_for :'text-case', *Schema.attr(:font)
end