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?, parse

Constructor Details

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

Returns a new instance of Folder.



1008
1009
1010
1011
1012
1013
 
# File 'lib/kamelopard/classes.rb', line 1008

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.



1006
1007
1008
 
# File 'lib/kamelopard/classes.rb', line 1006

def folders
  @folders
end

#parent_folder ⇒ Object

Returns the value of attribute parent_folder.



1006
1007
1008
 
# File 'lib/kamelopard/classes.rb', line 1006

def parent_folder
  @parent_folder
end

#styles ⇒ Object

Returns the value of attribute styles.



1006
1007
1008
 
# File 'lib/kamelopard/classes.rb', line 1006

def styles
  @styles
end

Instance Method Details

#has_parent? ⇒ Boolean

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

Returns:

  • (Boolean) 


1045
1046
1047
 
# File 'lib/kamelopard/classes.rb', line 1045

def has_parent?
    not @parent_folder.nil?
end

#to_kml(elem = nil) ⇒ Object 



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/kamelopard/classes.rb', line 1031

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