Class: Writexlsx::Package::SharedStrings

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/package/shared_strings.rb

Constant Summary collapse

PRESERVE_SPACE_ATTRIBUTES = 
['xml:space', 'preserve'].freeze

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::DEFAULT_COL_PIXELS, Utility::MAX_DIGIT_WIDTH, Utility::PADDING, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #color, #convert_date_time, #convert_font_args, #dash_types, delete_files, #escape_url, #fill_properties, #float_to_str, #get_font_latin_attributes, #get_font_style_attributes, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color_from_index, #params_to_font, #pattern_properties, #pixels_to_points, #ptrue?, #put_deprecate_message, #quote_sheetname, #r_id_attributes, #row_col_notation, #shape_style_base, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #v_shape_attributes_base, #v_shape_style_base, #value_or_raise, #write_a_body_pr, #write_a_def_rpr, #write_a_end_para_rpr, #write_a_lst_style, #write_a_p_formula, #write_a_p_pr_formula, #write_a_solid_fill, #write_a_srgb_clr, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_def_rpr_r_pr_common, #write_div, #write_fill, #write_font, #write_stroke, #write_tx_pr, #write_xml_declaration, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xl_string_pixel_width, #xml_str

Constructor Details

#initialize ⇒ SharedStrings

Returns a new instance of SharedStrings.



16
17
18
19
20
21
22
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 16

def initialize
  @writer        = Package::XMLWriterSimple.new
  @strings       = [] # string table
  @strings_index = {} # string table index
  @count         = 0 # count
  @str_unique    = 0
end

Instance Attribute Details

#strings ⇒ Object (readonly)

Returns the value of attribute strings.



14
15
16
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 14

def strings
  @strings
end

Instance Method Details

#add(string) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 29

def add(string)
  unless @strings_index[string]
    str = string.frozen? ? string : string.freeze
    @strings << str
    @str_unique += 1
    @strings_index[str] = @strings.size - 1
  end
  @count += 1
end

#assemble_xml_file ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 51

def assemble_xml_file
  write_xml_declaration do
    # Write the sst table.
    write_sst { write_sst_strings }
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 43

def empty?
  @strings.empty?
end

#index(string, params = {}) ⇒ Object 



24
25
26
27
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 24

def index(string, params = {})
  add(string) unless params[:only_query]
  @strings_index[string]
end

#set_xml_writer(filename) ⇒ Object 



47
48
49
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 47

def set_xml_writer(filename)
  @writer.set_xml_writer(filename)
end

#string(index) ⇒ Object 



39
40
41
 
# File 'lib/write_xlsx/package/shared_strings.rb', line 39

def string(index)
  @strings[index]
end