Class: Spreadsheet::Excel::Writer::Format

Inherits:
Format
  • Object
show all
Includes:
Internals
Defined in:
lib/spreadsheet/excel/writer/format.rb

Overview

This class encapsulates everything that is needed to write an XF record.

Constant Summary

Constants included from Internals

Internals::BINARY_FORMATS, Internals::BUILTIN_FORMATS, Internals::BUILTIN_STYLES, Internals::CODEPAGES, Internals::COLOR_CODES, Internals::EIGHT_BYTE_DOUBLE, Internals::ESCAPEMENT_TYPES, Internals::FONT_ENCODINGS, Internals::FONT_FAMILIES, Internals::FONT_WEIGHTS, Internals::LEAP_ERROR, Internals::NGILA_H_FX, Internals::NGILA_V_FX, Internals::NOITCERID_TXET_FX, Internals::OPCODES, Internals::OPCODE_SIZE, Internals::ROW_HEIGHT, Internals::SEDOCPO, Internals::SEDOC_ROLOC, Internals::SEGAPEDOC, Internals::SEILIMAF_TNOF, Internals::SEPYT_ENILREDNU, Internals::SEPYT_TNEMEPACSE, Internals::SGNIDOCNE_TNOF, Internals::SST_CHUNKSIZE, Internals::TWIPS, Internals::UNDERLINE_TYPES, Internals::XF_H_ALIGN, Internals::XF_TEXT_DIRECTION, Internals::XF_V_ALIGN

Instance Attribute Summary collapse

Attributes inherited from Format

#font, #name, #number_format, #pattern, #rotation, #used_merge

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internals

#binfmt, #opcode

Methods inherited from Format

#align=, #border, #border=, #border_color, #border_color=, #bottom_color, #center_across!, #cross_down, #date?, #date_or_time?, #datetime?, #indent_level, #time?

Methods included from Datatypes

append_features

Methods included from Compatibility

#ivar_name, #method_name

Constructor Details

#initialize(writer, workbook, format = workbook.default_format, opts = {}) ⇒ Format

Returns a new instance of Format.



35
36
37
38
39
40
41
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 35

def initialize writer, workbook, format=workbook.default_format, opts={}
  @opts = { :type => :format }.merge opts
  @format = format
  @writer = writer
  @workbook = workbook
  super format
end

Instance Attribute Details

#format ⇒ Object (readonly)

Returns the value of attribute format.



34
35
36
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 34

def format
  @format
end

#xf_index ⇒ Object

Returns the value of attribute xf_index.



33
34
35
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 33

def xf_index
  @xf_index
end

Class Method Details

.boolean(*args) ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 12

def Format.boolean *args
  args.each do |key|
    define_method key do
      @format.send("#{key}?") ? 1 : 0
    end
  end
end

.color(key, default) ⇒ Object 



19
20
21
22
23
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 19

def Format.color key, default
  define_method key do
    color_code(@format.send(key) || default)
  end
end

Instance Method Details

#color_code(color) ⇒ Object 



42
43
44
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 42

def color_code color
  SEDOC_ROLOC[color]
end

#font_index ⇒ Object 



45
46
47
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 45

def font_index
  @writer.font_index @workbook, font.key
end

#horizontal_align ⇒ Object 



48
49
50
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 48

def horizontal_align
  XF_H_ALIGN.fetch @format.horizontal_align, 0
end

#num_format ⇒ Object 



51
52
53
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 51

def num_format
  @writer.number_format_index @workbook, @format.number_format
end

#text_direction ⇒ Object 



54
55
56
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 54

def text_direction
  XF_TEXT_DIRECTION.fetch @format.text_direction, 0
end

#vertical_align ⇒ Object 



57
58
59
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 57

def vertical_align
  XF_V_ALIGN.fetch @format.vertical_align, 2
end

#write_op(writer, op, *args) ⇒ Object 



60
61
62
63
64
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 60

def write_op writer, op, *args
  data = args.join
  writer.write [op,data.size].pack("v2")
  writer.write data
end

#write_xf(writer, type = ) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 65

def write_xf writer, type=@opts[:type]
  xf_type = xf_type_prot type
  data = [
    font_index,   # Index to FONT record (➜ 6.43)
    num_format,   # Index to FORMAT record (➜ 6.45)
    xf_type,      #  Bit  Mask    Contents
                  #  2-0  0x0007  XF_TYPE_PROT – XF type, cell protection
                  #               Bit  Mask  Contents
                  #                 0  0x01  1 = Cell is locked
                  #                 1  0x02  1 = Formula is hidden
                  #                 2  0x04  0 = Cell XF; 1 = Style XF
                  # 15-4  0xfff0  Index to parent style XF
                  #               (always 0xfff in style XFs)
    xf_align,     #  Bit  Mask    Contents
                  #  2-0  0x07    XF_HOR_ALIGN – Horizontal alignment
                  #               Value  Horizontal alignment
                  #               0x00   General
                  #               0x01   Left
                  #               0x02   Centred
                  #               0x03   Right
                  #               0x04   Filled
                  #               0x05   Justified (BIFF4-BIFF8X)
                  #               0x06   Centred across selection
                  #                      (BIFF4-BIFF8X)
                  #               0x07   Distributed (BIFF8X)
                  #    3  0x08    1 = Text is wrapped at right border
                  #  6-4  0x70    XF_VERT_ALIGN – Vertical alignment
                  #               Value  Vertical alignment
                  #               0x00   Top
                  #               0x01   Centred
                  #               0x02   Bottom
                  #               0x03   Justified (BIFF5-BIFF8X)
                  #               0x04   Distributed (BIFF8X)
    xf_rotation,  # XF_ROTATION:  Text rotation angle
                  #  Value  Text rotation
                  #      0  Not rotated
                  #   1-90  1 to 90 degrees counterclockwise
                  # 91-180  1 to 90 degrees clockwise
                  #    255  Letters are stacked top-to-bottom,
                  #         but not rotated
    xf_indent,    #  Bit  Mask  Contents
                  #  3-0  0x0f  Indent level
                  #    4  0x10  1 = Shrink content to fit into cell
                  #    5  0x40  1 = Merge Range (djberger)
                  #  7-6  0xc0  Text direction (BIFF8X only)
                  #             0 = According to context
                  #             1 = Left-to-right
                  #             2 = Right-to-left
    xf_used_attr, #  Bit  Mask  Contents
                  #  7-2  0xfc  XF_USED_ATTRIB – Used attributes
                  #             Each bit describes the validity of a
                  #             specific group of attributes. In cell XFs
                  #             a cleared bit means the attributes of the
                  #             parent style XF are used (but only if the
                  #             attributes are valid there), a set bit
                  #             means the attributes of this XF are used.
                  #             In style XFs a cleared bit means the
                  #             attribute setting is valid, a set bit
                  #             means the attribute should be ignored.
                  #             Bit  Mask  Contents
                  #               0  0x01  Flag for number format
                  #               1  0x02  Flag for font
                  #               2  0x04  Flag for horizontal and
                  #                        vertical alignment, text wrap,
                  #                        indentation, orientation,
                  #                        rotation, and text direction
                  #               3  0x08  Flag for border lines
                  #               4  0x10  Flag for background area style
                  #               5  0x20  Flag for cell protection (cell
                  #                        locked and formula hidden)
    xf_borders,   # Cell border lines and background area:
                  #   Bit  Mask        Contents
                  #  3- 0  0x0000000f  Left line style (➜ 3.10)
                  #  7- 4  0x000000f0  Right line style (➜ 3.10)
                  # 11- 8  0x00000f00  Top line style (➜ 3.10)
                  # 15-12  0x0000f000  Bottom line style (➜ 3.10)
                  # 22-16  0x007f0000  Colour index (➜ 6.70)
                  #                    for left line colour
                  # 29-23  0x3f800000  Colour index (➜ 6.70)
                  #                    for right line colour
                  #    30  0x40000000  1 = Diagonal line
                  #                    from top left to right bottom
                  #    31  0x80000000  1 = Diagonal line
                  #                    from bottom left to right top
    xf_brdcolors, #   Bit  Mask        Contents
                  #  6- 0  0x0000007f  Colour index (➜ 6.70)
                  #                    for top line colour
                  # 13- 7  0x00003f80  Colour index (➜ 6.70)
                  #                    for bottom line colour
                  # 20-14  0x001fc000  Colour index (➜ 6.70)
                  #                    for diagonal line colour
                  # 24-21  0x01e00000  Diagonal line style (➜ 3.10)
                  # 31-26  0xfc000000  Fill pattern (➜ 3.11)
    xf_pattern    #   Bit  Mask        Contents
                  #   6-0  0x007f      Colour index (➜ 6.70)
                  #                    for pattern colour
                  #  13-7  0x3f80      Colour index (➜ 6.70)
                  #                    for pattern background
  ]
  write_op writer, 0x00e0, data.pack(binfmt(:xf))
end

#xf_align ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 166

def xf_align
  align = horizontal_align
  align |= text_wrap      << 3
  align |= vertical_align << 4
  align |= text_justlast  << 7
  align
end

#xf_borders ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 173

def xf_borders
  border  = left
  border |= right       <<  4
  border |= top         <<  8
  border |= bottom      << 12
  border |= left_color  << 16
  border |= right_color << 23
  border |= cross_down  << 30
  border |= cross_up    << 31
  border
end

#xf_brdcolors ⇒ Object 



184
185
186
187
188
189
190
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 184

def xf_brdcolors
  border  = top_color
  border |= bottom_color   << 7
  border |= diagonal_color << 14
  border |= pattern        << 26
  border
end

#xf_indent ⇒ Object 



191
192
193
194
195
196
197
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 191

def xf_indent
  indent  = indent_level & 0x0f
  indent |= shrink         << 4
  indent |= merge_range    << 5
  indent |= text_direction << 6
  indent
end

#xf_pattern ⇒ Object 



198
199
200
201
202
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 198

def xf_pattern
  ptrn  = pattern_fg_color
  ptrn |= pattern_bg_color << 7
  ptrn
end

#xf_rotation ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 203

def xf_rotation
  rot = @format.rotation
  if @format.rotation_stacked?
    rot = 255
  elsif rot >= -90 or rotation <= 90
    rot = -rot + 90 if rot < 0
  else
    warn "rotation outside -90..90; rotation set to 0"
    rot = 0
  end
  rot
end

#xf_type_prot(type) ⇒ Object 



215
216
217
218
219
220
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 215

def xf_type_prot type
  type = type.to_s.downcase == 'style' ? 0xfff5 : 0x0000
  type |= locked
  type |= hidden << 1
  type
end

#xf_used_attr ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 221

def xf_used_attr
  atr_num = num_format & 1
  atr_fnt = font_index & 1
  atr_fnt = 1 unless @format.font.color == :text
  atr_alc = 0
  if horizontal_align != 0 \
    || vertical_align != 2 \
    || indent_level > 0 \
    || shrink? || merge_range? || text_wrap?
  then
    atr_alc = 1
  end
  atr_bdr = [top, bottom, left, right, cross_up, cross_down].max
  atr_pat = 0
  if  @format.pattern_fg_color != :border \
    || @format.pattern_bg_color != :pattern_bg \
    || pattern != 0x00
  then
    atr_pat = 1
  end
  atr_prot = hidden? || locked? ? 1 : 0
  attrs  = atr_num
  attrs |= atr_fnt << 1
  attrs |= atr_alc << 2
  attrs |= atr_bdr << 3
  attrs |= atr_pat << 4
  attrs |= atr_prot << 5
  attrs << 2
end