Class: Writexlsx::Worksheet::Hyperlink

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/worksheet/hyperlink.rb

Overview

:nodoc:

Direct Known Subclasses

ExternalHyperlink, InternalHyperlink

Constant Summary collapse

MAXIMUM_URLS_SIZE = 
2079

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Class Method 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, #get_image_properties, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color, #params_to_font, #pattern_properties, #pixels_to_points, #process_bmp, #process_gif, #process_jpg, #process_png, #process_workbook_options, #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(url, str, tip, max_url_length) ⇒ Hyperlink

Returns a new instance of Hyperlink.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 23

def initialize(url, str, tip, max_url_length)
  # The displayed string defaults to the url string.
  str ||= url.dup

  # Strip the mailto header.
  normalized_str = str.sub(/^mailto:/, '')

  # Split url into the link and optional anchor/location.
  url, @url_str = url.split("#", 2)

  # Escape URL unless it looks already escaped.
  url = escape_url(url)

  # Excel limits the escaped URL and location/anchor to 255 characters.
  raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)

  @url       = url
  @str       = normalized_str
  @tip       = tip
end

Instance Attribute Details

#str ⇒ Object (readonly)

Returns the value of attribute str.



9
10
11
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 9

def str
  @str
end

#tip ⇒ Object (readonly)

Returns the value of attribute tip.



9
10
11
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 9

def tip
  @tip
end

Class Method Details

.factory(url, str = nil, tip = nil, max_url_length = MAXIMUM_URLS_SIZE) ⇒ Object 



13
14
15
16
17
18
19
20
21
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 13

def self.factory(url, str = nil, tip = nil, max_url_length = MAXIMUM_URLS_SIZE)
  if url =~ /^internal:(.+)/
    InternalHyperlink.new($~[1], str, tip, max_url_length)
  elsif url =~ /^external:(.+)/
    ExternalHyperlink.new($~[1], str, tip, max_url_length)
  else
    new(url, str, tip, max_url_length)
  end
end

Instance Method Details

#attributes(row, col, id) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 44

def attributes(row, col, id)
  ref = xl_rowcol_to_cell(row, col)

  attr = [['ref', ref]]
  attr << r_id_attributes(id)

  attr << ['location', @url_str] if @url_str
  attr << ['display',  @display] if @display
  attr << ['tooltip',  @tip]     if @tip
  attr
end

#display_on ⇒ Object 



60
61
62
63
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 60

def display_on
  # @display = @url_str
  @display = @str
end

#external_hyper_link ⇒ Object 



56
57
58
 
# File 'lib/write_xlsx/worksheet/hyperlink.rb', line 56

def external_hyper_link
  ['/hyperlink', @url, 'External']
end