From 058faf2581970fa18c314ad07f5658adeca32c69 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 27 Nov 2011 22:08:55 +0900 Subject: update to README --- doc/Axlsx/Xf.html | 322 +++++++++++++++++++++++------------------------------- 1 file changed, 134 insertions(+), 188 deletions(-) (limited to 'doc/Axlsx/Xf.html') diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index b7da1702..911b8ba0 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -94,10 +94,9 @@

Overview

-

-The Xf class defines a formatting record for use in Styles. The recommended -way to manage styles for your workbook is with Styles#add_style -

+ +

The Xf class defines a formatting record for use in Styles. The recommended +way to manage styles for your workbook is with Styles#add_style

@@ -136,9 +135,8 @@ way to manage styles for your workbook is with Styles#add_style -

-The cell alignment for this style. -

+
+

The cell alignment for this style.

 @@ -163,9 +161,8 @@ The cell alignment for this style. -

-Indicates if the alignment options should be applied. -

+
+

Indicates if the alignment options should be applied.

 @@ -190,9 +187,8 @@ Indicates if the alignment options should be applied. -

-indicates if the borderId should be applied. -

+
+

indicates if the borderId should be applied.

 @@ -217,9 +213,8 @@ indicates if the borderId should be applied. -

-indicates if the fillId should be applied. -

+
+

indicates if the fillId should be applied.

 @@ -244,9 +239,8 @@ indicates if the fillId should be applied. -

-indicates if the fontId should be applied. -

+
+

indicates if the fontId should be applied.

 @@ -271,9 +265,8 @@ indicates if the fontId should be applied. -

-indicates if the numFmtId should be applied. -

+
+

indicates if the numFmtId should be applied.

 @@ -298,9 +291,8 @@ indicates if the numFmtId should be applied. -

-Indicates if the protection options should be applied. -

+
+

Indicates if the protection options should be applied.

 @@ -325,9 +317,8 @@ Indicates if the protection options should be applied. -

-index (0 based) of the border to be used in this style. -

+
+

index (0 based) of the border to be used in this style.

 @@ -352,9 +343,8 @@ index (0 based) of the border to be used in this style. -

-index (0 based) of the fill to be used in this style. -

+
+

index (0 based) of the fill to be used in this style.

 @@ -379,9 +369,8 @@ index (0 based) of the fill to be used in this style. -

-index (0 based) of the font to be used in this style. -

+
+

index (0 based) of the font to be used in this style.

 @@ -406,9 +395,8 @@ index (0 based) of the font to be used in this style. -

-id of the numFmt to apply to this style. -

+
+

id of the numFmt to apply to this style.

 @@ -433,9 +421,8 @@ id of the numFmt to apply to this style. -

-indicates if the cell has a pivot table drop down button. -

+
+

indicates if the cell has a pivot table drop down button.

 @@ -460,9 +447,8 @@ indicates if the cell has a pivot table drop down button. -

-The cell protection for this style. -

+
+

The cell protection for this style.

 @@ -487,9 +473,8 @@ The cell protection for this style. -

-indecates if text should be prefixed by a single quote in the cell. -

+
+

indecates if text should be prefixed by a single quote in the cell.

 @@ -514,9 +499,8 @@ indecates if text should be prefixed by a single quote in the cell. -

-index (0 based) of cellStylesXfs item to be used in this style. -

+
+

index (0 based) of cellStylesXfs item to be used in this style.

 @@ -553,9 +537,8 @@ index (0 based) of cellStylesXfs item to be used in this style. -

-Creates a new Xf object. -

+
+

Creates a new Xf object.

 @@ -577,9 +560,8 @@ Creates a new Xf object. -

-Serializes the xf elemen. -

+
+

Serializes the xf elemen.

 @@ -600,9 +582,8 @@ Serializes the xf elemen.

-

-Creates a new Xf object -

+ +

Creates a new Xf object

@@ -623,9 +604,8 @@ Creates a new Xf object — -

-a customizable set of options -

+
+

a customizable set of options

@@ -792,12 +772,11 @@ a customizable set of options 
# File 'lib/axlsx/stylesheet/xf.rb', line 85
 
-def initialize(options={})
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-  end
-end
-
+def initialize(options={}) + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" + end +end @@ -820,9 +799,8 @@ a customizable set of options

-

-The cell alignment for this style -

+ +

The cell alignment for this style

@@ -863,10 +841,9 @@ The cell alignment for this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 10
 
-def alignment
-  @alignment
-end
-
+def alignment + @alignment +end @@ -884,9 +861,8 @@ The cell alignment for this style

-

-Indicates if the alignment options should be applied -

+ +

Indicates if the alignment options should be applied

@@ -920,10 +896,9 @@ Indicates if the alignment options should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 63
 
-def applyAlignment
-  @applyAlignment
-end
-
+def applyAlignment + @applyAlignment +end @@ -941,9 +916,8 @@ Indicates if the alignment options should be applied

-

-indicates if the borderId should be applied -

+ +

indicates if the borderId should be applied

@@ -977,10 +951,9 @@ indicates if the borderId should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 59
 
-def applyBorder
-  @applyBorder
-end
-
+def applyBorder + @applyBorder +end @@ -998,9 +971,8 @@ indicates if the borderId should be applied

-

-indicates if the fillId should be applied -

+ +

indicates if the fillId should be applied

@@ -1034,10 +1006,9 @@ indicates if the fillId should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 55
 
-def applyFill
-  @applyFill
-end
-
+def applyFill + @applyFill +end @@ -1055,9 +1026,8 @@ indicates if the fillId should be applied

-

-indicates if the fontId should be applied -

+ +

indicates if the fontId should be applied

@@ -1091,10 +1061,9 @@ indicates if the fontId should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 51
 
-def applyFont
-  @applyFont
-end
-
+def applyFont + @applyFont +end @@ -1112,9 +1081,8 @@ indicates if the fontId should be applied

-

-indicates if the numFmtId should be applied -

+ +

indicates if the numFmtId should be applied

@@ -1148,10 +1116,9 @@ indicates if the numFmtId should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 47
 
-def applyNumberFormat
-  @applyNumberFormat
-end
-
+def applyNumberFormat + @applyNumberFormat +end @@ -1169,9 +1136,8 @@ indicates if the numFmtId should be applied

-

-Indicates if the protection options should be applied -

+ +

Indicates if the protection options should be applied

@@ -1205,10 +1171,9 @@ Indicates if the protection options should be applied 
# File 'lib/axlsx/stylesheet/xf.rb', line 67
 
-def applyProtection
-  @applyProtection
-end
-
+def applyProtection + @applyProtection +end @@ -1226,9 +1191,8 @@ Indicates if the protection options should be applied

-

-index (0 based) of the border to be used in this style -

+ +

index (0 based) of the border to be used in this style

@@ -1262,10 +1226,9 @@ index (0 based) of the border to be used in this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 31
 
-def borderId
-  @borderId
-end
-
+def borderId + @borderId +end @@ -1283,9 +1246,8 @@ index (0 based) of the border to be used in this style

-

-index (0 based) of the fill to be used in this style -

+ +

index (0 based) of the fill to be used in this style

@@ -1319,10 +1281,9 @@ index (0 based) of the fill to be used in this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 27
 
-def fillId
-  @fillId
-end
-
+def fillId + @fillId +end @@ -1340,9 +1301,8 @@ index (0 based) of the fill to be used in this style

-

-index (0 based) of the font to be used in this style -

+ +

index (0 based) of the font to be used in this style

@@ -1376,10 +1336,9 @@ index (0 based) of the font to be used in this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 23
 
-def fontId
-  @fontId
-end
-
+def fontId + @fontId +end @@ -1397,9 +1356,8 @@ index (0 based) of the font to be used in this style

-

-id of the numFmt to apply to this style -

+ +

id of the numFmt to apply to this style

@@ -1433,10 +1391,9 @@ id of the numFmt to apply to this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 19
 
-def numFmtId
-  @numFmtId
-end
-
+def numFmtId + @numFmtId +end @@ -1454,9 +1411,8 @@ id of the numFmt to apply to this style

-

-indicates if the cell has a pivot table drop down button -

+ +

indicates if the cell has a pivot table drop down button

@@ -1490,10 +1446,9 @@ indicates if the cell has a pivot table drop down button 
# File 'lib/axlsx/stylesheet/xf.rb', line 43
 
-def pivotButton
-  @pivotButton
-end
-
+def pivotButton + @pivotButton +end @@ -1511,9 +1466,8 @@ indicates if the cell has a pivot table drop down button

-

-The cell protection for this style -

+ +

The cell protection for this style

@@ -1554,10 +1508,9 @@ The cell protection for this style 
# File 'lib/axlsx/stylesheet/xf.rb', line 15
 
-def protection
-  @protection
-end
-
+def protection + @protection +end @@ -1575,9 +1528,8 @@ The cell protection for this style

-

-indecates if text should be prefixed by a single quote in the cell -

+ +

indecates if text should be prefixed by a single quote in the cell

@@ -1611,10 +1563,9 @@ indecates if text should be prefixed by a single quote in the cell 
# File 'lib/axlsx/stylesheet/xf.rb', line 39
 
-def quotePrefix
-  @quotePrefix
-end
-
+def quotePrefix + @quotePrefix +end @@ -1632,10 +1583,9 @@ indecates if text should be prefixed by a single quote in the cell

-

-index (0 based) of cellStylesXfs item to be used in this style. Only -applies to cellXfs items -

+ +

index (0 based) of cellStylesXfs item to be used in this style. Only +applies to cellXfs items

@@ -1669,10 +1619,9 @@ applies to cellXfs items 
# File 'lib/axlsx/stylesheet/xf.rb', line 35
 
-def xfId
-  @xfId
-end
-
+def xfId + @xfId +end @@ -1694,9 +1643,8 @@ applies to cellXfs items

-

-Serializes the xf elemen -

+ +

Serializes the xf elemen

@@ -1715,9 +1663,8 @@ Serializes the xf elemen — -

-The document builder instance this objects xml will be added to. -

+
+

The document builder instance this objects xml will be added to.

@@ -1754,13 +1701,12 @@ The document builder instance this objects xml will be added to. 
# File 'lib/axlsx/stylesheet/xf.rb', line 131
 
-def to_xml(xml)
-  xml.xf(self.instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}) {
-    alignment.to_xml(xml) if self.alignment
-    protection.to_xml(xml) if self.protection
-  }
-end
-
+def to_xml(xml) + xml.xf(self.instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}) { + alignment.to_xml(xml) if self.alignment + protection.to_xml(xml) if self.protection + } +end @@ -1771,9 +1717,9 @@ The document builder instance this objects xml will be added to.
-- cgit v1.2.3