Class: Kamelopard::Folder

Inherits:
Container show all
Defined in:
lib/kamelopard/classes.rb

Overview

Corresponds to KML’s Folder object.

Instance Attribute Summary collapse

Attributes inherited from Feature

#abstractView, #addressDetails, #atom_author, #atom_link, #description, #extendedData, #metadata, #name, #open, #phoneNumber, #region, #snippet, #styleSelector, #styleUrl, #timeprimitive, #visibility

Attributes included from Snippet

#maxLines, #snippet_text

Attributes inherited from Object

#comment, #kml_id, #master_only

Instance Method Summary collapse

Methods inherited from Container

#<<, #features=

Methods inherited from Feature

add_author, #extended_data_to_kml, #hide, #show, #styles_to_kml, #timespan, #timespan=, #timestamp, #timestamp=

Methods included from Snippet

#snippet_to_kml

Methods inherited from Object

#_alternate_to_kml, #change, #master_only?

Constructor Details

#initialize(name = nil, options = {}) ⇒ Folder

Returns a new instance of Folder.



938
939
940
941
942
943
 
# File 'lib/kamelopard/classes.rb', line 938

def initialize(name = nil, options = {})
    @styles = []
    @folders = []
    super
    DocumentHolder.instance.current_document.folders << self
end

Instance Attribute Details

#folders ⇒ Object

Returns the value of attribute folders.



936
937
938
 
# File 'lib/kamelopard/classes.rb', line 936

def folders
  @folders
end

#parent_folder ⇒ Object

Returns the value of attribute parent_folder.



936
937
938
 
# File 'lib/kamelopard/classes.rb', line 936

def parent_folder
  @parent_folder
end

#styles ⇒ Object

Returns the value of attribute styles.



936
937
938
 
# File 'lib/kamelopard/classes.rb', line 936

def styles
  @styles
end

Instance Method Details

#has_parent? ⇒ Boolean

Folders can have parent folders; returns true if this folder has one

Returns:

  • (Boolean) 


975
976
977
 
# File 'lib/kamelopard/classes.rb', line 975

def has_parent?
    not @parent_folder.nil?
end

#to_kml(elem = nil) ⇒ Object 



961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/kamelopard/classes.rb', line 961

def to_kml(elem = nil)
    h = XML::Node.new 'Folder'
    super h
    @features.each do |a|
        a.to_kml(h)
    end
    @folders.each do |a|
        a.to_kml(h)
    end
    elem << h unless elem.nil?
    h
end