From 11303a4d6664d9a7ff7bc408035d2ab70378a375 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sat, 26 Nov 2011 13:20:57 +0900 Subject: adding in support for ruby 1.9.3 release version 1.0.9 --- doc/Axlsx/Xf.html | 637 +++++++++++++++++++++++++++++------------------------- 1 file changed, 341 insertions(+), 296 deletions(-) (limited to 'doc/Axlsx/Xf.html') diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index 8e0d5d8b..b42932ab 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -6,7 +6,7 @@ Class: Axlsx::Xf - — Documentation by YARD 0.7.3 + — AXLSX @@ -94,9 +94,9 @@

Overview

-

-The Xf class defines a formatting record for use in Styles -

+ +

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

@@ -104,6 +104,13 @@ The Xf class defines a formatting record for use in Styles
+

See Also:

+ +

Instance Attribute Summary (collapse)

@@ -128,9 +135,8 @@ The Xf class defines a formatting record for use in Styles -

-The cell alignment for this style. -

+
+

The cell alignment for this style.

 @@ -155,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.

 @@ -182,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.

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

-indicates if the fillId should be applied. -

+
+

indicates if the fillId should be applied.

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

-indicates if the fontId should be applied. -

+
+

indicates if the fontId should be applied.

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

-indicates if the numFmtId should be applied. -

+
+

indicates if the numFmtId should be applied.

 @@ -290,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.

 @@ -317,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.

 @@ -344,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.

 @@ -371,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.

 @@ -398,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.

 @@ -425,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.

 @@ -452,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.

 @@ -479,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.

 @@ -506,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.

 @@ -545,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.

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

-Serializes the xf elemen. -

+
+

Serializes the xf elemen.

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

-

-Creates a new Xf object -

+ +

Creates a new Xf object

@@ -605,68 +594,18 @@ Creates a new Xf object
  • - [Integer] - - - (Hash) - - - - — -

    -a customizable set of options -

    -
    - -
    • - -
  • - - [Boolean] + options (Hash) - - — -

    -a customizable set of options -

    -
    - -
    • - -
  • - - [CellAlignment] - - - (Hash) - - - - — -

    -a customizable set of options -

    -
    - -
    • - -
  • - - [CellProtection] - - - (Hash) - + (defaults to: {}) — -

    -a customizable set of options -

    +
    +

    a customizable set of options

    • @@ -676,6 +615,146 @@ a customizable set of options +

    Options Hash (options):

    +
      + +
    • + numFmtId + (Integer) + + + + +
      • + +
    • + fontId + (Integer) + + + + +
      • + +
    • + fillId + (Integer) + + + + +
      • + +
    • + borderId + (Integer) + + + + +
      • + +
    • + xfId + (Integer) + + + + +
      • + +
    • + quotePrefix + (Boolean) + + + + +
      • + +
    • + pivotButton + (Boolean) + + + + +
      • + +
    • + applyNumberFormat + (Boolean) + + + + +
      • + +
    • + applyFont + (Boolean) + + + + +
      • + +
    • + applyFill + (Boolean) + + + + +
      • + +
    • + applyBorder + (Boolean) + + + + +
      • + +
    • + applyAlignment + (Boolean) + + + + +
      • + +
    • + applyProtection + (Boolean) + + + + +
      • + +
    • + alignment + (CellAlignment) + + + + +
      • + +
    • + protection + (CellProtection) + + + + +
      • + +
    +
    @@ -684,21 +763,20 @@ a customizable set of options 
     
 
-84
 85
 86
 87
-88
    +88 +89
    - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 84
-
-def initialize(options={})
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-  end
-end
-
    + 
    # 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
    @@ -721,9 +799,8 @@ a customizable set of options

    -

    -The cell alignment for this style -

    + +

    The cell alignment for this style

    @@ -757,17 +834,16 @@ The cell alignment for this style 
     
 
-9
 10
-11
    +11 +12 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 9
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 10
 
-def alignment
-  @alignment
-end
-
    
+def alignment
+  @alignment
+end
    @@ -785,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

    @@ -814,17 +889,16 @@ Indicates if the alignment options should be applied 
     
 
-62
 63
-64
    +64 +65 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 62
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 63
 
-def applyAlignment
-  @applyAlignment
-end
-
    
+def applyAlignment
+  @applyAlignment
+end
    @@ -842,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

    @@ -871,17 +944,16 @@ indicates if the borderId should be applied 
     
 
-58
 59
-60
    +60 +61 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 58
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 59
 
-def applyBorder
-  @applyBorder
-end
-
    
+def applyBorder
+  @applyBorder
+end
    @@ -899,9 +971,8 @@ indicates if the borderId should be applied

    -

    -indicates if the fillId should be applied -

    + +

    indicates if the fillId should be applied

    @@ -928,17 +999,16 @@ indicates if the fillId should be applied 
     
 
-54
 55
-56
    +56 +57 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 54
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 55
 
-def applyFill
-  @applyFill
-end
-
    
+def applyFill
+  @applyFill
+end
    @@ -956,9 +1026,8 @@ indicates if the fillId should be applied

    -

    -indicates if the fontId should be applied -

    + +

    indicates if the fontId should be applied

    @@ -985,17 +1054,16 @@ indicates if the fontId should be applied 
     
 
-50
 51
-52
    +52 +53 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 50
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 51
 
-def applyFont
-  @applyFont
-end
-
    
+def applyFont
+  @applyFont
+end
    @@ -1013,9 +1081,8 @@ indicates if the fontId should be applied

    -

    -indicates if the numFmtId should be applied -

    + +

    indicates if the numFmtId should be applied

    @@ -1042,17 +1109,16 @@ indicates if the numFmtId should be applied 
     
 
-46
 47
-48
    +48 +49 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 46
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 47
 
-def applyNumberFormat
-  @applyNumberFormat
-end
-
    
+def applyNumberFormat
+  @applyNumberFormat
+end
    @@ -1070,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

    @@ -1099,17 +1164,16 @@ Indicates if the protection options should be applied 
     
 
-66
 67
-68
    +68 +69 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 66
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 67
 
-def applyProtection
-  @applyProtection
-end
-
    
+def applyProtection
+  @applyProtection
+end
    @@ -1127,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

    @@ -1156,17 +1219,16 @@ index (0 based) of the border to be used in this style 
     
 
-30
 31
-32
    +32 +33 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 30
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 31
 
-def borderId
-  @borderId
-end
-
    
+def borderId
+  @borderId
+end
    @@ -1184,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

    @@ -1213,17 +1274,16 @@ index (0 based) of the fill to be used in this style 
     
 
-26
 27
-28
    +28 +29 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 26
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 27
 
-def fillId
-  @fillId
-end
-
    
+def fillId
+  @fillId
+end
    @@ -1241,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

    @@ -1270,17 +1329,16 @@ index (0 based) of the font to be used in this style 
     
 
-22
 23
-24
    +24 +25 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 22
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 23
 
-def fontId
-  @fontId
-end
-
    
+def fontId
+  @fontId
+end
    @@ -1298,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

    @@ -1327,17 +1384,16 @@ id of the numFmt to apply to this style 
     
 
-18
 19
-20
    +20 +21 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 18
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 19
 
-def numFmtId
-  @numFmtId
-end
-
    
+def numFmtId
+  @numFmtId
+end
    @@ -1355,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

    @@ -1384,17 +1439,16 @@ indicates if the cell has a pivot table drop down button 
     
 
-42
 43
-44
    +44 +45 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 42
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 43
 
-def pivotButton
-  @pivotButton
-end
-
    
+def pivotButton
+  @pivotButton
+end
    @@ -1412,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

    @@ -1448,17 +1501,16 @@ The cell protection for this style 
     
 
-14
 15
-16
    +16 +17 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 14
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 15
 
-def protection
-  @protection
-end
-
    
+def protection
+  @protection
+end
    @@ -1476,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

    @@ -1505,17 +1556,16 @@ indecates if text should be prefixed by a single quote in the cell 
     
 
-38
 39
-40
    +40 +41 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 38
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 39
 
-def quotePrefix
-  @quotePrefix
-end
-
    
+def quotePrefix
+  @quotePrefix
+end
    @@ -1533,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

    @@ -1563,17 +1612,16 @@ applies to cellXfs items 
     
 
-34
 35
-36
    +36 +37 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 34
+      
    # File 'lib/axlsx/stylesheet/xf.rb', line 35
 
-def xfId
-  @xfId
-end
-
    
+def xfId
+  @xfId
+end
    @@ -1595,9 +1643,8 @@ applies to cellXfs items

    -

    -Serializes the xf elemen -

    + +

    Serializes the xf elemen

    @@ -1616,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.

    @@ -1645,23 +1691,22 @@ The document builder instance this objects xml will be added to. 
     
 
-110
-111
-112
-113
-114
-115
    +131 +132 +133 +134 +135 +136 - 
    # File 'lib/axlsx/stylesheet/xf.rb', line 110
-
-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
-
    + 
    # 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
    @@ -1672,9 +1717,9 @@ The document builder instance this objects xml will be added to.
    -- cgit v1.2.3