rubyXL 3.3.1 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (363) hide show
  1. checksums.yaml +4 -4
  2. data/VERSION +1 -1
  3. data/lib/rubyXL/objects/content_types.rb +8 -3
  4. data/lib/rubyXL/objects/ooxml_object.rb +0 -1
  5. data/lib/rubyXL/objects/relationships.rb +1 -1
  6. data/lib/rubyXL/objects/storage.rb +28 -5
  7. data/lib/rubyXL/objects/text.rb +8 -1
  8. data/lib/rubyXL/objects/workbook.rb +9 -2
  9. data/rdoc/README_rdoc.html +179 -152
  10. data/rdoc/RubyXL.html +7 -10
  11. data/rdoc/RubyXL/AExtension.html +7 -10
  12. data/rdoc/RubyXL/AExtensionStorageArea.html +7 -10
  13. data/rdoc/RubyXL/AdjustHandleList.html +10 -10
  14. data/rdoc/RubyXL/Alignment.html +7 -10
  15. data/rdoc/RubyXL/AlternateContent.html +7 -10
  16. data/rdoc/RubyXL/Authors.html +10 -10
  17. data/rdoc/RubyXL/AutoFilter.html +10 -10
  18. data/rdoc/RubyXL/AutoFilterColumn.html +10 -10
  19. data/rdoc/RubyXL/BinaryImageFile.html +26 -10
  20. data/rdoc/RubyXL/BodyProperties.html +10 -10
  21. data/rdoc/RubyXL/BooleanNode.html +7 -10
  22. data/rdoc/RubyXL/BooleanValue.html +7 -10
  23. data/rdoc/RubyXL/Border.html +97 -10
  24. data/rdoc/RubyXL/BorderEdge.html +7 -10
  25. data/rdoc/RubyXL/Borders.html +61 -10
  26. data/rdoc/RubyXL/Break.html +10 -10
  27. data/rdoc/RubyXL/BreakList.html +10 -10
  28. data/rdoc/RubyXL/CT_AdjPoint2D.html +10 -10
  29. data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +10 -10
  30. data/rdoc/RubyXL/CT_AlphaModulateEffect.html +10 -10
  31. data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +10 -10
  32. data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +10 -10
  33. data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +10 -10
  34. data/rdoc/RubyXL/CT_Backdrop.html +10 -10
  35. data/rdoc/RubyXL/CT_Bevel.html +10 -10
  36. data/rdoc/RubyXL/CT_BiLevelEffect.html +10 -10
  37. data/rdoc/RubyXL/CT_BlendEffect.html +10 -10
  38. data/rdoc/RubyXL/CT_Blip.html +10 -10
  39. data/rdoc/RubyXL/CT_BlipFillProperties.html +10 -10
  40. data/rdoc/RubyXL/CT_BlurEffect.html +10 -10
  41. data/rdoc/RubyXL/CT_Camera.html +10 -10
  42. data/rdoc/RubyXL/CT_Color.html +10 -10
  43. data/rdoc/RubyXL/CT_ColorChangeEffect.html +10 -10
  44. data/rdoc/RubyXL/CT_ColorMapping.html +10 -10
  45. data/rdoc/RubyXL/CT_ColorScheme.html +10 -10
  46. data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +10 -10
  47. data/rdoc/RubyXL/CT_ConnectionSite.html +10 -10
  48. data/rdoc/RubyXL/CT_ConnectionSiteList.html +10 -10
  49. data/rdoc/RubyXL/CT_DashStop.html +10 -10
  50. data/rdoc/RubyXL/CT_DashStopList.html +10 -10
  51. data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +10 -10
  52. data/rdoc/RubyXL/CT_DuotoneEffect.html +10 -10
  53. data/rdoc/RubyXL/CT_EffectContainer.html +10 -10
  54. data/rdoc/RubyXL/CT_EffectList.html +10 -10
  55. data/rdoc/RubyXL/CT_EffectReference.html +10 -10
  56. data/rdoc/RubyXL/CT_EffectStyleItem.html +10 -10
  57. data/rdoc/RubyXL/CT_EffectStyleList.html +10 -10
  58. data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +10 -10
  59. data/rdoc/RubyXL/CT_FillEffect.html +10 -10
  60. data/rdoc/RubyXL/CT_FillOverlayEffect.html +10 -10
  61. data/rdoc/RubyXL/CT_FillStyleList.html +10 -10
  62. data/rdoc/RubyXL/CT_FlatText.html +10 -10
  63. data/rdoc/RubyXL/CT_FontCollection.html +10 -10
  64. data/rdoc/RubyXL/CT_FontReference.html +10 -10
  65. data/rdoc/RubyXL/CT_GeomGuideList.html +10 -10
  66. data/rdoc/RubyXL/CT_GlowEffect.html +10 -10
  67. data/rdoc/RubyXL/CT_GradientFillProperties.html +10 -10
  68. data/rdoc/RubyXL/CT_GradientStop.html +10 -10
  69. data/rdoc/RubyXL/CT_GradientStopList.html +10 -10
  70. data/rdoc/RubyXL/CT_HSLEffect.html +10 -10
  71. data/rdoc/RubyXL/CT_HslColor.html +10 -10
  72. data/rdoc/RubyXL/CT_Hyperlink.html +10 -10
  73. data/rdoc/RubyXL/CT_InnerShadowEffect.html +10 -10
  74. data/rdoc/RubyXL/CT_LightRig.html +10 -10
  75. data/rdoc/RubyXL/CT_LineEndProperties.html +10 -10
  76. data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +10 -10
  77. data/rdoc/RubyXL/CT_LineProperties.html +10 -10
  78. data/rdoc/RubyXL/CT_LineStyleList.html +10 -10
  79. data/rdoc/RubyXL/CT_LinearShadeProperties.html +10 -10
  80. data/rdoc/RubyXL/CT_LuminanceEffect.html +10 -10
  81. data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +10 -10
  82. data/rdoc/RubyXL/CT_OuterShadowEffect.html +10 -10
  83. data/rdoc/RubyXL/CT_Path2D.html +10 -10
  84. data/rdoc/RubyXL/CT_Path2DArcTo.html +10 -10
  85. data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +10 -10
  86. data/rdoc/RubyXL/CT_Path2DList.html +10 -10
  87. data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +10 -10
  88. data/rdoc/RubyXL/CT_Path2DTo.html +10 -10
  89. data/rdoc/RubyXL/CT_PathShadeProperties.html +10 -10
  90. data/rdoc/RubyXL/CT_PatternFillProperties.html +10 -10
  91. data/rdoc/RubyXL/CT_Point3D.html +10 -10
  92. data/rdoc/RubyXL/CT_PolarAdjustHandle.html +10 -10
  93. data/rdoc/RubyXL/CT_PresetColor.html +10 -10
  94. data/rdoc/RubyXL/CT_PresetLineDashProperties.html +10 -10
  95. data/rdoc/RubyXL/CT_PresetShadowEffect.html +10 -10
  96. data/rdoc/RubyXL/CT_PresetTextShape.html +10 -10
  97. data/rdoc/RubyXL/CT_ReflectionEffect.html +10 -10
  98. data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +10 -10
  99. data/rdoc/RubyXL/CT_RelativeRect.html +10 -10
  100. data/rdoc/RubyXL/CT_SRgbColor.html +10 -10
  101. data/rdoc/RubyXL/CT_ScRgbColor.html +10 -10
  102. data/rdoc/RubyXL/CT_Scene3D.html +10 -10
  103. data/rdoc/RubyXL/CT_SchemeColor.html +10 -10
  104. data/rdoc/RubyXL/CT_Shape3D.html +10 -10
  105. data/rdoc/RubyXL/CT_ShapeStyle.html +10 -10
  106. data/rdoc/RubyXL/CT_SoftEdgesEffect.html +10 -10
  107. data/rdoc/RubyXL/CT_SphereCoords.html +10 -10
  108. data/rdoc/RubyXL/CT_StretchInfoProperties.html +10 -10
  109. data/rdoc/RubyXL/CT_StyleMatrix.html +10 -10
  110. data/rdoc/RubyXL/CT_StyleMatrixReference.html +10 -10
  111. data/rdoc/RubyXL/CT_SupplementalFont.html +10 -10
  112. data/rdoc/RubyXL/CT_SystemColor.html +10 -10
  113. data/rdoc/RubyXL/CT_TextAutonumberBullet.html +10 -10
  114. data/rdoc/RubyXL/CT_TextBlipBullet.html +10 -10
  115. data/rdoc/RubyXL/CT_TextCharBullet.html +10 -10
  116. data/rdoc/RubyXL/CT_TextCharacterProperties.html +10 -10
  117. data/rdoc/RubyXL/CT_TextFont.html +10 -10
  118. data/rdoc/RubyXL/CT_TextListStyle.html +10 -10
  119. data/rdoc/RubyXL/CT_TextNormalAutofit.html +10 -10
  120. data/rdoc/RubyXL/CT_TextParagraphProperties.html +10 -10
  121. data/rdoc/RubyXL/CT_TextSpacing.html +10 -10
  122. data/rdoc/RubyXL/CT_TextTabStop.html +10 -10
  123. data/rdoc/RubyXL/CT_TextTabStopList.html +10 -10
  124. data/rdoc/RubyXL/CT_TileInfoProperties.html +10 -10
  125. data/rdoc/RubyXL/CT_TintEffect.html +10 -10
  126. data/rdoc/RubyXL/CT_Transform2D.html +10 -10
  127. data/rdoc/RubyXL/CT_TransformEffect.html +10 -10
  128. data/rdoc/RubyXL/CT_Vector3D.html +10 -10
  129. data/rdoc/RubyXL/CT_XYAdjustHandle.html +10 -10
  130. data/rdoc/RubyXL/CalculationChain.html +7 -10
  131. data/rdoc/RubyXL/CalculationChainCell.html +7 -10
  132. data/rdoc/RubyXL/CalculationProperties.html +10 -10
  133. data/rdoc/RubyXL/Cell.html +9 -11
  134. data/rdoc/RubyXL/CellConvenienceMethods.html +203 -10
  135. data/rdoc/RubyXL/CellSmartTag.html +10 -10
  136. data/rdoc/RubyXL/CellSmartTagProperty.html +10 -10
  137. data/rdoc/RubyXL/CellSmartTags.html +10 -10
  138. data/rdoc/RubyXL/CellStyle.html +7 -10
  139. data/rdoc/RubyXL/CellStyleXFs.html +61 -10
  140. data/rdoc/RubyXL/CellStyles.html +61 -10
  141. data/rdoc/RubyXL/CellValue.html +7 -10
  142. data/rdoc/RubyXL/CellWatch.html +10 -10
  143. data/rdoc/RubyXL/CellWatches.html +10 -10
  144. data/rdoc/RubyXL/CellXFs.html +65 -10
  145. data/rdoc/RubyXL/ChartColorsFile.html +26 -10
  146. data/rdoc/RubyXL/ChartFile.html +93 -10
  147. data/rdoc/RubyXL/ChartStyleFile.html +26 -10
  148. data/rdoc/RubyXL/ChartUserShapesFile.html +26 -10
  149. data/rdoc/RubyXL/Chartsheet.html +164 -10
  150. data/rdoc/RubyXL/ChartsheetPageSetup.html +10 -10
  151. data/rdoc/RubyXL/ChartsheetProperties.html +7 -10
  152. data/rdoc/RubyXL/ChartsheetProtection.html +7 -10
  153. data/rdoc/RubyXL/ChartsheetView.html +10 -10
  154. data/rdoc/RubyXL/ChartsheetViews.html +10 -10
  155. data/rdoc/RubyXL/Color.html +7 -10
  156. data/rdoc/RubyXL/ColorFilter.html +10 -10
  157. data/rdoc/RubyXL/ColorScale.html +10 -10
  158. data/rdoc/RubyXL/ColorSet.html +10 -10
  159. data/rdoc/RubyXL/Colors.html +10 -10
  160. data/rdoc/RubyXL/ColumnRange.html +7 -10
  161. data/rdoc/RubyXL/ColumnRanges.html +7 -10
  162. data/rdoc/RubyXL/Comment.html +7 -10
  163. data/rdoc/RubyXL/CommentList.html +10 -10
  164. data/rdoc/RubyXL/CommentsFile.html +101 -10
  165. data/rdoc/RubyXL/ConditionalFormatValue.html +10 -10
  166. data/rdoc/RubyXL/ConditionalFormatting.html +10 -10
  167. data/rdoc/RubyXL/ConditionalFormattingRule.html +10 -10
  168. data/rdoc/RubyXL/ContentTypeDefault.html +7 -10
  169. data/rdoc/RubyXL/ContentTypeOverride.html +7 -10
  170. data/rdoc/RubyXL/ContentTypes.html +15 -13
  171. data/rdoc/RubyXL/ControlPropertiesFile.html +21 -10
  172. data/rdoc/RubyXL/CorePropertiesFile.html +378 -10
  173. data/rdoc/RubyXL/CustomColor.html +10 -10
  174. data/rdoc/RubyXL/CustomColorList.html +10 -10
  175. data/rdoc/RubyXL/CustomFilter.html +10 -10
  176. data/rdoc/RubyXL/CustomFilters.html +10 -10
  177. data/rdoc/RubyXL/CustomGeometry.html +10 -10
  178. data/rdoc/RubyXL/CustomProperties.html +10 -10
  179. data/rdoc/RubyXL/CustomPropertiesFile.html +26 -10
  180. data/rdoc/RubyXL/CustomProperty.html +10 -10
  181. data/rdoc/RubyXL/CustomSheetView.html +10 -10
  182. data/rdoc/RubyXL/CustomSheetViews.html +10 -10
  183. data/rdoc/RubyXL/CustomWorkbookView.html +10 -10
  184. data/rdoc/RubyXL/CustomWorkbookViews.html +10 -10
  185. data/rdoc/RubyXL/CustomXMLFile.html +21 -10
  186. data/rdoc/RubyXL/DXF.html +10 -10
  187. data/rdoc/RubyXL/DXFs.html +10 -10
  188. data/rdoc/RubyXL/DataBar.html +10 -10
  189. data/rdoc/RubyXL/DataConsolidate.html +10 -10
  190. data/rdoc/RubyXL/DataConsolidationReference.html +10 -10
  191. data/rdoc/RubyXL/DataConsolidationReferences.html +10 -10
  192. data/rdoc/RubyXL/DataType.html +7 -10
  193. data/rdoc/RubyXL/DataValidation.html +7 -10
  194. data/rdoc/RubyXL/DataValidations.html +10 -10
  195. data/rdoc/RubyXL/DateGroupItem.html +7 -10
  196. data/rdoc/RubyXL/DefinedName.html +10 -10
  197. data/rdoc/RubyXL/DefinedNames.html +10 -10
  198. data/rdoc/RubyXL/DocumentPropertiesFile.html +7 -10
  199. data/rdoc/RubyXL/DrawingFile.html +92 -10
  200. data/rdoc/RubyXL/DynamicFilter.html +10 -10
  201. data/rdoc/RubyXL/EmbeddedControl.html +10 -10
  202. data/rdoc/RubyXL/EmbeddedControls.html +10 -10
  203. data/rdoc/RubyXL/Extension.html +7 -10
  204. data/rdoc/RubyXL/ExtensionStorageArea.html +7 -10
  205. data/rdoc/RubyXL/Extents.html +10 -10
  206. data/rdoc/RubyXL/ExternalLinksFile.html +26 -10
  207. data/rdoc/RubyXL/ExternalReference.html +10 -10
  208. data/rdoc/RubyXL/ExternalReferences.html +10 -10
  209. data/rdoc/RubyXL/ExtraColorSchemeList.html +10 -10
  210. data/rdoc/RubyXL/FieldItem.html +10 -10
  211. data/rdoc/RubyXL/FileRecoveryProperties.html +10 -10
  212. data/rdoc/RubyXL/FileSharing.html +7 -10
  213. data/rdoc/RubyXL/FileVersion.html +7 -10
  214. data/rdoc/RubyXL/Fill.html +61 -10
  215. data/rdoc/RubyXL/Fills.html +61 -10
  216. data/rdoc/RubyXL/FilterContainer.html +10 -10
  217. data/rdoc/RubyXL/FloatNode.html +7 -10
  218. data/rdoc/RubyXL/FloatValue.html +7 -10
  219. data/rdoc/RubyXL/Font.html +7 -10
  220. data/rdoc/RubyXL/FontScheme.html +10 -10
  221. data/rdoc/RubyXL/Fonts.html +61 -10
  222. data/rdoc/RubyXL/Formula.html +7 -10
  223. data/rdoc/RubyXL/FunctionGroup.html +10 -10
  224. data/rdoc/RubyXL/FunctionGroups.html +10 -10
  225. data/rdoc/RubyXL/GenericStorageObject.html +7 -10
  226. data/rdoc/RubyXL/GradientFill.html +10 -10
  227. data/rdoc/RubyXL/HeaderFooterSettings.html +10 -10
  228. data/rdoc/RubyXL/Hyperlink.html +10 -10
  229. data/rdoc/RubyXL/HyperlinkRelFile.html +21 -10
  230. data/rdoc/RubyXL/Hyperlinks.html +10 -10
  231. data/rdoc/RubyXL/IconFilter.html +10 -10
  232. data/rdoc/RubyXL/IconSet.html +10 -10
  233. data/rdoc/RubyXL/IgnoredError.html +10 -10
  234. data/rdoc/RubyXL/IgnoredErrors.html +10 -10
  235. data/rdoc/RubyXL/IndexedColors.html +10 -10
  236. data/rdoc/RubyXL/InputCells.html +10 -10
  237. data/rdoc/RubyXL/IntegerNode.html +7 -10
  238. data/rdoc/RubyXL/IntegerValue.html +7 -10
  239. data/rdoc/RubyXL/LegacyCell.html +7 -10
  240. data/rdoc/RubyXL/LegacyWorksheet.html +7 -10
  241. data/rdoc/RubyXL/MRUColors.html +10 -10
  242. data/rdoc/RubyXL/MacrosFile.html +26 -10
  243. data/rdoc/RubyXL/MergedCell.html +10 -10
  244. data/rdoc/RubyXL/MergedCells.html +10 -10
  245. data/rdoc/RubyXL/NumFmt.html +10 -10
  246. data/rdoc/RubyXL/NumberFormat.html +7 -10
  247. data/rdoc/RubyXL/NumberFormats.html +7 -10
  248. data/rdoc/RubyXL/OLEObject.html +10 -10
  249. data/rdoc/RubyXL/OLEObjectFile.html +26 -10
  250. data/rdoc/RubyXL/OLEObjects.html +10 -10
  251. data/rdoc/RubyXL/OLESize.html +10 -10
  252. data/rdoc/RubyXL/OOXMLContainerObject.html +298 -10
  253. data/rdoc/RubyXL/OOXMLObject.html +23 -11
  254. data/rdoc/RubyXL/OOXMLObjectClassMethods.html +23 -22
  255. data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +447 -10
  256. data/rdoc/RubyXL/OOXMLRelationshipsFile.html +8 -11
  257. data/rdoc/RubyXL/OOXMLTopLevelObject.html +284 -10
  258. data/rdoc/RubyXL/Offset.html +10 -10
  259. data/rdoc/RubyXL/OutlineProperties.html +7 -10
  260. data/rdoc/RubyXL/PageMargins.html +10 -10
  261. data/rdoc/RubyXL/PageSetup.html +10 -10
  262. data/rdoc/RubyXL/PageSetupProperties.html +7 -10
  263. data/rdoc/RubyXL/Pane.html +10 -10
  264. data/rdoc/RubyXL/Parser.html +7 -10
  265. data/rdoc/RubyXL/PatternFill.html +10 -10
  266. data/rdoc/RubyXL/PhoneticProperties.html +10 -10
  267. data/rdoc/RubyXL/PhoneticRun.html +10 -10
  268. data/rdoc/RubyXL/PivotArea.html +10 -10
  269. data/rdoc/RubyXL/PivotCache.html +10 -10
  270. data/rdoc/RubyXL/PivotCacheDefinitionFile.html +38 -11
  271. data/rdoc/RubyXL/PivotCacheRecordsFile.html +121 -0
  272. data/rdoc/RubyXL/PivotCaches.html +10 -10
  273. data/rdoc/RubyXL/PivotReference.html +10 -10
  274. data/rdoc/RubyXL/PivotReferences.html +10 -10
  275. data/rdoc/RubyXL/PivotTableFile.html +38 -11
  276. data/rdoc/RubyXL/PivotTableSelection.html +10 -10
  277. data/rdoc/RubyXL/PresetGeometry.html +10 -10
  278. data/rdoc/RubyXL/PrintOptions.html +10 -10
  279. data/rdoc/RubyXL/PrinterSettingsFile.html +26 -10
  280. data/rdoc/RubyXL/ProtectedRange.html +10 -10
  281. data/rdoc/RubyXL/ProtectedRanges.html +10 -10
  282. data/rdoc/RubyXL/Protection.html +10 -10
  283. data/rdoc/RubyXL/RID.html +7 -10
  284. data/rdoc/RubyXL/RawOOXML.html +7 -10
  285. data/rdoc/RubyXL/Reference.html +7 -10
  286. data/rdoc/RubyXL/Relationship.html +7 -10
  287. data/rdoc/RubyXL/RelationshipSupport.html +324 -10
  288. data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +59 -10
  289. data/rdoc/RubyXL/RichText.html +63 -10
  290. data/rdoc/RubyXL/RichTextRun.html +61 -10
  291. data/rdoc/RubyXL/Row.html +329 -10
  292. data/rdoc/RubyXL/RunProperties.html +7 -10
  293. data/rdoc/RubyXL/Scenario.html +10 -10
  294. data/rdoc/RubyXL/Scenarios.html +10 -10
  295. data/rdoc/RubyXL/Selection.html +69 -10
  296. data/rdoc/RubyXL/ShapeGuide.html +10 -10
  297. data/rdoc/RubyXL/ShapeTextRectangle.html +10 -10
  298. data/rdoc/RubyXL/SharedStringsTable.html +9 -12
  299. data/rdoc/RubyXL/Sheet.html +10 -10
  300. data/rdoc/RubyXL/SheetCalculationProperties.html +10 -10
  301. data/rdoc/RubyXL/SheetData.html +96 -10
  302. data/rdoc/RubyXL/Sheets.html +10 -10
  303. data/rdoc/RubyXL/SlicerCacheFile.html +26 -10
  304. data/rdoc/RubyXL/SlicerFile.html +26 -10
  305. data/rdoc/RubyXL/SmartTagProperties.html +10 -10
  306. data/rdoc/RubyXL/SmartTagType.html +10 -10
  307. data/rdoc/RubyXL/SmartTagTypes.html +10 -10
  308. data/rdoc/RubyXL/SmartTags.html +10 -10
  309. data/rdoc/RubyXL/SortCondition.html +10 -10
  310. data/rdoc/RubyXL/SortState.html +10 -10
  311. data/rdoc/RubyXL/Sqref.html +7 -10
  312. data/rdoc/RubyXL/Stop.html +7 -10
  313. data/rdoc/RubyXL/StringNode.html +7 -10
  314. data/rdoc/RubyXL/StringNodeW3C.html +7 -10
  315. data/rdoc/RubyXL/StringValue.html +7 -10
  316. data/rdoc/RubyXL/Stylesheet.html +211 -10
  317. data/rdoc/RubyXL/TableFile.html +26 -10
  318. data/rdoc/RubyXL/TableParts.html +7 -10
  319. data/rdoc/RubyXL/TableStyle.html +10 -10
  320. data/rdoc/RubyXL/TableStyles.html +10 -10
  321. data/rdoc/RubyXL/Text.html +33 -13
  322. data/rdoc/RubyXL/Theme.html +439 -10
  323. data/rdoc/RubyXL/ThemeElements.html +10 -10
  324. data/rdoc/RubyXL/ThumbnailFile.html +26 -10
  325. data/rdoc/RubyXL/Top10.html +10 -10
  326. data/rdoc/RubyXL/VMLDrawingFile.html +39 -11
  327. data/rdoc/RubyXL/Variant.html +7 -10
  328. data/rdoc/RubyXL/Vector.html +65 -10
  329. data/rdoc/RubyXL/VectorValue.html +7 -10
  330. data/rdoc/RubyXL/VisualProperties.html +10 -10
  331. data/rdoc/RubyXL/WebPublishObject.html +10 -10
  332. data/rdoc/RubyXL/WebPublishObjects.html +10 -10
  333. data/rdoc/RubyXL/WebPublishingItem.html +7 -10
  334. data/rdoc/RubyXL/WebPublishingItems.html +10 -10
  335. data/rdoc/RubyXL/WebPublishingProperties.html +10 -10
  336. data/rdoc/RubyXL/Workbook.html +514 -10
  337. data/rdoc/RubyXL/WorkbookConvenienceMethods.html +7 -10
  338. data/rdoc/RubyXL/WorkbookProperties.html +7 -10
  339. data/rdoc/RubyXL/WorkbookProtection.html +10 -10
  340. data/rdoc/RubyXL/WorkbookRoot.html +7 -10
  341. data/rdoc/RubyXL/WorkbookView.html +10 -10
  342. data/rdoc/RubyXL/WorkbookViews.html +10 -10
  343. data/rdoc/RubyXL/Worksheet.html +337 -10
  344. data/rdoc/RubyXL/WorksheetConvenienceMethods.html +2624 -10
  345. data/rdoc/RubyXL/WorksheetDimensions.html +10 -10
  346. data/rdoc/RubyXL/WorksheetFormatProperties.html +7 -10
  347. data/rdoc/RubyXL/WorksheetProperties.html +7 -10
  348. data/rdoc/RubyXL/WorksheetProtection.html +10 -10
  349. data/rdoc/RubyXL/WorksheetView.html +10 -10
  350. data/rdoc/RubyXL/WorksheetViews.html +10 -10
  351. data/rdoc/RubyXL/XF.html +10 -10
  352. data/rdoc/created.rid +8 -8
  353. data/rdoc/{fonts.css → css/fonts.css} +0 -0
  354. data/rdoc/{rdoc.css → css/rdoc.css} +11 -1
  355. data/rdoc/index.html +570 -11
  356. data/rdoc/js/darkfish.js +32 -11
  357. data/rdoc/js/navigation.js.gz +0 -0
  358. data/rdoc/js/search_index.js +1 -1
  359. data/rdoc/js/search_index.js.gz +0 -0
  360. data/rdoc/js/searcher.js.gz +0 -0
  361. data/rdoc/table_of_contents.html +1920 -295
  362. data/rubyXL.gemspec +9 -5
  363. metadata +8 -4
data/rdoc/RubyXL/OOXMLObject.html CHANGED
@@ -4,22 +4,19 @@
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
6
 
7
- <title>class RubyXL::OOXMLObject - rubyXL 3.3.1</title>
8
-
9
- <link href="../fonts.css" rel="stylesheet">
10
- <link href="../rdoc.css" rel="stylesheet">
7
+ <title>class RubyXL::OOXMLObject - rubyXL 3.3.2</title>
11
8
 
12
9
  <script type="text/javascript">
13
10
  var rdoc_rel_prefix = "../";
14
11
  </script>
15
12
 
16
13
  <script src="../js/jquery.js"></script>
17
- <script src="../js/navigation.js"></script>
18
- <script src="../js/search_index.js"></script>
19
- <script src="../js/search.js"></script>
20
- <script src="../js/searcher.js"></script>
21
14
  <script src="../js/darkfish.js"></script>
22
15
 
16
+ <link href="../css/fonts.css" rel="stylesheet">
17
+ <link href="../css/rdoc.css" rel="stylesheet">
18
+
19
+
23
20
 
24
21
  <body id="top" role="document" class="class">
25
22
  <nav role="navigation">
@@ -65,7 +62,18 @@
65
62
 
66
63
  </div>
67
64
 
68
-
65
+ <div id="includes-section" class="nav-section">
66
+ <h3>Included Modules</h3>
67
+
68
+ <ul class="link-list">
69
+
70
+
71
+ <li><a class="include" href="OOXMLObjectInstanceMethods.html">RubyXL::OOXMLObjectInstanceMethods</a>
72
+
73
+
74
+ </ul>
75
+ </div>
76
+
69
77
 
70
78
 
71
79
  </div>
@@ -78,6 +86,10 @@
78
86
 
79
87
  <section class="description">
80
88
 
89
+ <p>Parent class for defining OOXML based objects (not unlike Rails&#39;
90
+ <code>ActiveRecord</code>!) Most importantly, provides functionality of
91
+ parsing such objects from XML, and marshalling them to XML.</p>
92
+
81
93
  </section>
82
94
 
83
95
 
@@ -99,7 +111,7 @@
99
111
 
100
112
  <footer id="validator-badges" role="contentinfo">
101
113
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
102
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
103
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
114
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
115
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
104
116
  </footer>
105
117
 
data/rdoc/RubyXL/OOXMLObjectClassMethods.html CHANGED
@@ -4,22 +4,19 @@
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
6
 
7
- <title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.3.1</title>
8
-
9
- <link href="../fonts.css" rel="stylesheet">
10
- <link href="../rdoc.css" rel="stylesheet">
7
+ <title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.3.2</title>
11
8
 
12
9
  <script type="text/javascript">
13
10
  var rdoc_rel_prefix = "../";
14
11
  </script>
15
12
 
16
13
  <script src="../js/jquery.js"></script>
17
- <script src="../js/navigation.js"></script>
18
- <script src="../js/search_index.js"></script>
19
- <script src="../js/search.js"></script>
20
- <script src="../js/searcher.js"></script>
21
14
  <script src="../js/darkfish.js"></script>
22
15
 
16
+ <link href="../css/fonts.css" rel="stylesheet">
17
+ <link href="../css/rdoc.css" rel="stylesheet">
18
+
19
+
23
20
 
24
21
  <body id="top" role="document" class="module">
25
22
  <nav role="navigation">
@@ -125,7 +122,7 @@
125
122
 
126
123
  <p>Defines an attribute of OOXML object.</p>
127
124
 
128
- <h3 id="method-i-define_attribute-label-Parameters">Parameters<span><a href="#method-i-define_attribute-label-Parameters">&para;</a> <a href="#documentation">&uarr;</a></span></h3>
125
+ <h3 id="method-i-define_attribute-label-Parameters">Parameters<span><a href="#method-i-define_attribute-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
129
126
  <ul><li>
130
127
  <p><code>attribute_name</code> - Name of the element attribute as seen in the
131
128
  source XML. Can be either <code>&quot;String&quot;</code> or
@@ -175,7 +172,7 @@ but do call the object-provided read accessor on <code>write_xml</code>.</p>
175
172
  </li></ul>
176
173
  </li></ul>
177
174
 
178
- <h4 id="method-i-define_attribute-label-Examples">Examples<span><a href="#method-i-define_attribute-label-Examples">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
175
+ <h4 id="method-i-define_attribute-label-Examples">Examples<span><a href="#method-i-define_attribute-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
179
176
 
180
177
  <pre class="ruby"><span class="ruby-identifier">define_attribute</span>(:<span class="ruby-identifier">outline</span>, :<span class="ruby-identifier">bool</span>, :<span class="ruby-identifier">default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">true</span>)
181
178
  </pre>
@@ -183,7 +180,8 @@ but do call the object-provided read accessor on <code>write_xml</code>.</p>
183
180
  <p>A <code>Boolean</code> attribute &#39;outline&#39; with default value
184
181
  <code>true</code> will be accessible by calling <code>obj.outline</code></p>
185
182
 
186
- <pre>define_attribute(:uniqueCount, :int)</pre>
183
+ <pre class="ruby"><span class="ruby-identifier">define_attribute</span>(:<span class="ruby-identifier">uniqueCount</span>, :<span class="ruby-identifier">int</span>)
184
+ </pre>
187
185
 
188
186
  <p>An <code>Integer</code> attribute &#39;uniqueCount&#39; accessible as
189
187
  <code>obj.unique_count</code></p>
@@ -239,11 +237,12 @@ accessible as <code>obj.error_style</code>, valid values are
239
237
 
240
238
  <p>Defines a child node of OOXML object.</p>
241
239
 
242
- <h3 id="method-i-define_child_node-label-Parameters">Parameters<span><a href="#method-i-define_child_node-label-Parameters">&para;</a> <a href="#documentation">&uarr;</a></span></h3>
240
+ <h3 id="method-i-define_child_node-label-Parameters">Parameters<span><a href="#method-i-define_child_node-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
243
241
  <ul><li>
244
- <p><code>klass</code> - Class (descendant of RubyXL::OOXMLObject) of the child
245
- nodes. Child node objects will be produced by calling <code>parse</code>
246
- method of that class.</p>
242
+ <p><code>klass</code> - Class (descendant of <a
243
+ href="OOXMLObject.html">RubyXL::OOXMLObject</a>) of the child nodes. Child
244
+ node objects will be produced by calling <code>parse</code> method of that
245
+ class.</p>
247
246
  </li><li>
248
247
  <p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
249
248
  <ul><li>
@@ -271,9 +270,10 @@ of <code>write_xml</code> call.</p>
271
270
  </li></ul>
272
271
  </li></ul>
273
272
 
274
- <h4 id="method-i-define_child_node-label-Examples">Examples<span><a href="#method-i-define_child_node-label-Examples">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
273
+ <h4 id="method-i-define_child_node-label-Examples">Examples<span><a href="#method-i-define_child_node-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
275
274
 
276
- <pre>define_child_node(RubyXL::Alignment)</pre>
275
+ <pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Alignment</span>)
276
+ </pre>
277
277
 
278
278
  <p>Define a singular child node parsed by the RubyXL::BorderEdge.parse() and
279
279
  accessed by the default <code>obj.alignment</code> accessor</p>
@@ -347,14 +347,15 @@ represented by the same class in different parts of OOXML tree,
347
347
  <code>:node_name</code> extra parameter can be used to override the default
348
348
  element name.</p>
349
349
 
350
- <h3 id="method-i-define_element_name-label-Parameters">Parameters<span><a href="#method-i-define_element_name-label-Parameters">&para;</a> <a href="#documentation">&uarr;</a></span></h3>
350
+ <h3 id="method-i-define_element_name-label-Parameters">Parameters<span><a href="#method-i-define_element_name-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
351
351
  <ul><li>
352
352
  <p><code>element_name</code></p>
353
353
  </li></ul>
354
354
 
355
- <h4 id="method-i-define_element_name-label-Examples">Examples<span><a href="#method-i-define_element_name-label-Examples">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
355
+ <h4 id="method-i-define_element_name-label-Examples">Examples<span><a href="#method-i-define_element_name-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
356
356
 
357
- <pre>define_element_name &#39;externalReference&#39;</pre>
357
+ <pre class="ruby"><span class="ruby-identifier">define_element_name</span> <span class="ruby-string">&#39;externalReference&#39;</span>
358
+ </pre>
358
359
 
359
360
 
360
361
 
@@ -524,7 +525,7 @@ it in the context of descendant class, which is what we need.</p>
524
525
 
525
526
  <footer id="validator-badges" role="contentinfo">
526
527
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
527
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
528
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
528
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
529
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
529
530
  </footer>
530
531
 
data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html CHANGED
@@ -4,22 +4,19 @@
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
6
 
7
- <title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.3.1</title>
8
-
9
- <link href="../fonts.css" rel="stylesheet">
10
- <link href="../rdoc.css" rel="stylesheet">
7
+ <title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.3.2</title>
11
8
 
12
9
  <script type="text/javascript">
13
10
  var rdoc_rel_prefix = "../";
14
11
  </script>
15
12
 
16
13
  <script src="../js/jquery.js"></script>
17
- <script src="../js/navigation.js"></script>
18
- <script src="../js/search_index.js"></script>
19
- <script src="../js/search.js"></script>
20
- <script src="../js/searcher.js"></script>
21
14
  <script src="../js/darkfish.js"></script>
22
15
 
16
+ <link href="../css/fonts.css" rel="stylesheet">
17
+ <link href="../css/rdoc.css" rel="stylesheet">
18
+
19
+
23
20
 
24
21
  <body id="top" role="document" class="module">
25
22
  <nav role="navigation">
@@ -59,8 +56,43 @@
59
56
 
60
57
 
61
58
 
59
+ <div id="extends-section" class="nav-section">
60
+ <h3>Extended With Modules</h3>
61
+
62
+ <ul class="link-list">
63
+
64
+
65
+ <li><a class="extend" href="OOXMLObjectClassMethods.html">RubyXL::OOXMLObjectClassMethods</a>
66
+
67
+
68
+ </ul>
69
+ </div>
70
+
71
+ <!-- Method Quickref -->
72
+ <div id="method-list-section" class="nav-section">
73
+ <h3>Methods</h3>
74
+
75
+ <ul class="link-list" role="directory">
76
+
77
+ <li ><a href="#method-c-included">::included</a>
78
+
79
+ <li ><a href="#method-c-new">::new</a>
62
80
 
81
+ <li ><a href="#method-i-3D-3D">#==</a>
63
82
 
83
+ <li ><a href="#method-i-before_write_xml">#before_write_xml</a>
84
+
85
+ <li ><a href="#method-i-get_node_object">#get_node_object</a>
86
+
87
+ <li ><a href="#method-i-index_in_collection">#index_in_collection</a>
88
+
89
+ <li ><a href="#method-i-init_child_nodes">#init_child_nodes</a>
90
+
91
+ <li ><a href="#method-i-write_xml">#write_xml</a>
92
+
93
+ </ul>
94
+ </div>
95
+
64
96
  </div>
65
97
  </nav>
66
98
 
@@ -86,13 +118,418 @@
86
118
 
87
119
 
88
120
 
121
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
122
+ <header>
123
+ <h3>Public Class Methods</h3>
124
+ </header>
125
+
126
+
127
+ <div id="method-c-included" class="method-detail ">
128
+
129
+ <div class="method-heading">
130
+ <span class="method-name">included</span><span
131
+ class="method-args">(klass)</span>
132
+
133
+ <span class="method-click-advice">click to toggle source</span>
134
+
135
+ </div>
136
+
137
+
138
+ <div class="method-description">
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <div class="method-source-code" id="included-source">
146
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 209</span>
147
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">klass</span>)
148
+ <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLObjectClassMethods</span>
149
+ <span class="ruby-keyword">end</span></pre>
150
+ </div>
151
+
152
+ </div>
153
+
154
+
155
+
156
+
157
+ </div>
158
+
159
+
160
+ <div id="method-c-new" class="method-detail ">
161
+
162
+ <div class="method-heading">
163
+ <span class="method-name">new</span><span
164
+ class="method-args">(params = {})</span>
165
+
166
+ <span class="method-click-advice">click to toggle source</span>
167
+
168
+ </div>
169
+
170
+
171
+ <div class="method-description">
172
+
173
+
174
+
175
+
176
+
177
+
178
+ <div class="method-source-code" id="new-source">
179
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 218</span>
180
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">params</span> = {})
181
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
182
+ <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{v[:accessor]}&quot;</span>, <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:computed</span>]
183
+ }
184
+
185
+ <span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
186
+ <span class="ruby-keyword">end</span></pre>
187
+ </div>
188
+
189
+ </div>
190
+
191
+
192
+
193
+
194
+ </div>
195
+
196
+
197
+ </section>
198
+
199
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
200
+ <header>
201
+ <h3>Public Instance Methods</h3>
202
+ </header>
203
+
204
+
205
+ <div id="method-i-3D-3D" class="method-detail ">
206
+
207
+ <div class="method-heading">
208
+ <span class="method-name">==</span><span
209
+ class="method-args">(other)</span>
210
+
211
+ <span class="method-click-advice">click to toggle source</span>
212
+
213
+ </div>
214
+
215
+
216
+ <div class="method-description">
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <div class="method-source-code" id="3D-3D-source">
224
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 240</span>
225
+ <span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>)
226
+ <span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&amp;&amp;</span>
227
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) } <span class="ruby-operator">&amp;&amp;</span>
228
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) }
229
+ <span class="ruby-keyword">end</span></pre>
230
+ </div>
231
+
232
+ </div>
233
+
234
+
235
+
236
+
237
+ </div>
238
+
239
+
240
+ <div id="method-i-before_write_xml" class="method-detail ">
241
+
242
+ <div class="method-heading">
243
+ <span class="method-name">before_write_xml</span><span
244
+ class="method-args">()</span>
245
+
246
+ <span class="method-click-advice">click to toggle source</span>
247
+
248
+ </div>
249
+
250
+
251
+ <div class="method-description">
252
+
253
+ <p>Subclass provided filter to perform last-minute operations (cleanup, count,
254
+ etc.) immediately prior to write, along with option to terminate the actual
255
+ write if <code>false</code> is returned (for example, to avoid writing the
256
+ collection&#39;s root node if the collection is empty).</p>
257
+
258
+
259
+
260
+
261
+ <div class="method-source-code" id="before_write_xml-source">
262
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 330</span>
263
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">before_write_xml</span>
264
+ <span class="ruby-comment">#TODO# This will go away once containers are fully implemented.</span>
265
+ <span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
266
+ <span class="ruby-identifier">child_nodes</span>.<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node_name</span>, <span class="ruby-identifier">child_node_params</span><span class="ruby-operator">|</span>
267
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">count</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:accessor</span>]).<span class="ruby-identifier">size</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:is_array</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:with_count</span>
268
+ }
269
+ <span class="ruby-keyword">true</span>
270
+ <span class="ruby-keyword">end</span></pre>
271
+ </div>
272
+
273
+ </div>
274
+
275
+
276
+
277
+
278
+ </div>
279
+
280
+
281
+ <div id="method-i-index_in_collection" class="method-detail ">
282
+
283
+ <div class="method-heading">
284
+ <span class="method-name">index_in_collection</span><span
285
+ class="method-args">()</span>
286
+
287
+ <span class="method-click-advice">click to toggle source</span>
288
+
289
+ </div>
290
+
291
+
292
+ <div class="method-description">
293
+
294
+ <p>Prototype method. For sparse collections (<code>Rows</code>,
295
+ <code>Cells</code>, etc.) must return index at which this object is
296
+ expected to reside in the collection. If <code>nil</code> is returned, then
297
+ object is simply added to the end of the collection.</p>
298
+
299
+
300
+
301
+
302
+ <div class="method-source-code" id="index_in_collection-source">
303
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 318</span>
304
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">index_in_collection</span>
305
+ <span class="ruby-keyword">nil</span>
306
+ <span class="ruby-keyword">end</span></pre>
307
+ </div>
308
+
309
+ </div>
310
+
311
+
312
+
313
+
314
+ </div>
315
+
316
+
317
+ <div id="method-i-write_xml" class="method-detail ">
318
+
319
+ <div class="method-heading">
320
+ <span class="method-name">write_xml</span><span
321
+ class="method-args">(xml = nil, node_name_override = nil)</span>
322
+
323
+ <span class="method-click-advice">click to toggle source</span>
324
+
325
+ </div>
326
+
327
+
328
+ <div class="method-description">
329
+
330
+ <p>Recursively write the OOXML object and all its children out as
331
+ Nokogiri::XML. Immediately before the actual generation,
332
+ +before_write_xml()+ is called to perform last-minute cleanup and
333
+ validation operations; if it returns <code>false</code>, an empty string is
334
+ returned (rather than <code>nil</code>, so Nokogiri::XML&#39;s
335
+ <code>&amp;lt;&amp;lt;</code> operator can be used without additional
336
+ <code>nil</code> checking)</p>
337
+
338
+ <h3 id="method-i-write_xml-label-Parameters">Parameters<span><a href="#method-i-write_xml-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
339
+ <ul><li>
340
+ <p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted,
341
+ a blank document will be generated.</p>
342
+ </li><li>
343
+ <p><code>node_name_override</code> - if present, is used instead of the
344
+ default element name for this object provided by
345
+ <code>define_element_name</code></p>
346
+ </li></ul>
347
+
348
+ <h4 id="method-i-write_xml-label-Examples">Examples<span><a href="#method-i-write_xml-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
349
+
350
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>()
351
+ </pre>
352
+
353
+ <p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML
354
+ structure as described in the respective definition, and returns the
355
+ resulting <code>Nokogiri::XML</code> object.</p>
356
+
357
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
358
+ </pre>
359
+
360
+ <p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates
361
+ a new element corresponding to <code>obj</code> according to its
362
+ definition, along with all its properties and children, and returns the
363
+ newly created element.</p>
364
+
365
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>, <span class="ruby-string">&#39;overriden_element_name&#39;</span>)
366
+ </pre>
367
+
368
+ <p>Same as above, but uses the passed-in <code>node_name_override</code> as
369
+ the new element name, instead of its default name set by
370
+ <code>define_element_name</code>.</p>
371
+
372
+
373
+
374
+
375
+ <div class="method-source-code" id="write_xml-source">
376
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 260</span>
377
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">xml</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">node_name_override</span> = <span class="ruby-keyword">nil</span>)
378
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
379
+ <span class="ruby-identifier">seed_xml</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>(<span class="ruby-string">&#39;&lt;?xml version = &quot;1.0&quot; standalone =&quot;yes&quot;?&gt;&#39;</span>)
380
+ <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">encoding</span> = <span class="ruby-string">&#39;UTF-8&#39;</span>
381
+ <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
382
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;&#39;</span>
383
+ <span class="ruby-identifier">seed_xml</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">result</span>
384
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_xml</span>({ <span class="ruby-value">:indent</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>, <span class="ruby-value">:save_with</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Node</span><span class="ruby-operator">::</span><span class="ruby-constant">SaveOptions</span><span class="ruby-operator">::</span><span class="ruby-constant">AS_XML</span> })
385
+ <span class="ruby-keyword">end</span>
386
+
387
+ <span class="ruby-keyword">return</span> <span class="ruby-string">&#39;&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">before_write_xml</span>
388
+
389
+ <span class="ruby-comment"># Populate namespaces, if any</span>
390
+ <span class="ruby-identifier">attrs</span> = {}
391
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_namespaces</span>).<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">v</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">?</span> <span class="ruby-string">&#39;xmlns&#39;</span> <span class="ruby-operator">:</span> <span class="ruby-node">&quot;xmlns:#{v}&quot;</span>] = <span class="ruby-identifier">k</span> }
392
+
393
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
394
+ <span class="ruby-identifier">val</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>])
395
+
396
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
397
+ <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:required</span>]
398
+ <span class="ruby-identifier">val</span> = <span class="ruby-identifier">v</span>[<span class="ruby-value">:default</span>]
399
+ <span class="ruby-keyword">end</span>
400
+
401
+ <span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span> <span class="ruby-operator">&amp;&amp;</span>
402
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:attr_type</span>]
403
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:bool</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">?</span> <span class="ruby-string">&#39;1&#39;</span> <span class="ruby-operator">:</span> <span class="ruby-string">&#39;0&#39;</span>
404
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:double</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\.0*\Z/</span>, <span class="ruby-string">&#39;&#39;</span>) <span class="ruby-comment"># Trim trailing zeroes</span>
405
+ <span class="ruby-keyword">else</span> <span class="ruby-identifier">val</span>
406
+ <span class="ruby-keyword">end</span>
407
+
408
+ <span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">val</span>
409
+ }
410
+
411
+ <span class="ruby-identifier">element_text</span> = <span class="ruby-identifier">attrs</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">&#39;_&#39;</span>)
412
+ <span class="ruby-identifier">elem</span> = <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">create_element</span>(<span class="ruby-identifier">node_name_override</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_tag_name</span>), <span class="ruby-identifier">attrs</span>, <span class="ruby-identifier">element_text</span>)
413
+
414
+ <span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
415
+ <span class="ruby-identifier">child_nodes</span>.<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node_name</span>, <span class="ruby-identifier">child_node_params</span><span class="ruby-operator">|</span>
416
+ <span class="ruby-identifier">node_obj</span> = <span class="ruby-identifier">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
417
+ <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">node_obj</span>.<span class="ruby-identifier">nil?</span>
418
+
419
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">node_obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:write_xml</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">node_obj</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">then</span>
420
+ <span class="ruby-comment"># If child node is either +OOXMLObject+, or +OOXMLContainerObject+ on its first (envelope) pass,</span>
421
+ <span class="ruby-comment"># serialize that object.</span>
422
+ <span class="ruby-identifier">elem</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">node_obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">xml</span>, <span class="ruby-identifier">child_node_name</span>)
423
+ <span class="ruby-keyword">else</span>
424
+ <span class="ruby-comment"># If child node is either vanilla +Array+, or +OOXMLContainerObject+ on its seconds (content) pass,</span>
425
+ <span class="ruby-comment"># serialize write its members.</span>
426
+ <span class="ruby-identifier">node_obj</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-identifier">elem</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">item</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">xml</span>, <span class="ruby-identifier">child_node_name</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">item</span>.<span class="ruby-identifier">nil?</span> }
427
+ <span class="ruby-keyword">end</span>
428
+ }
429
+ <span class="ruby-identifier">elem</span>
430
+ <span class="ruby-keyword">end</span></pre>
431
+ </div>
432
+
433
+ </div>
434
+
435
+
436
+
437
+
438
+ </div>
439
+
440
+
441
+ </section>
442
+
443
+ <section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
444
+ <header>
445
+ <h3>Protected Instance Methods</h3>
446
+ </header>
447
+
448
+
449
+ <div id="method-i-get_node_object" class="method-detail ">
450
+
451
+ <div class="method-heading">
452
+ <span class="method-name">get_node_object</span><span
453
+ class="method-args">(child_node_params)</span>
454
+
455
+ <span class="method-click-advice">click to toggle source</span>
456
+
457
+ </div>
458
+
459
+
460
+ <div class="method-description">
461
+
462
+
463
+
464
+
465
+
466
+
467
+ <div class="method-source-code" id="get_node_object-source">
468
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 322</span>
469
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
470
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:accessor</span>])
471
+ <span class="ruby-keyword">end</span></pre>
472
+ </div>
473
+
474
+ </div>
475
+
476
+
477
+
478
+
479
+ </div>
480
+
481
+
482
+ <div id="method-i-init_child_nodes" class="method-detail ">
483
+
484
+ <div class="method-heading">
485
+ <span class="method-name">init_child_nodes</span><span
486
+ class="method-args">(params)</span>
487
+
488
+ <span class="method-click-advice">click to toggle source</span>
489
+
490
+ </div>
491
+
492
+
493
+ <div class="method-description">
494
+
495
+
496
+
497
+
498
+
499
+
500
+ <div class="method-source-code" id="init_child_nodes-source">
501
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 226</span>
502
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
503
+ <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
504
+
505
+ <span class="ruby-identifier">initial_value</span> =
506
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">then</span> <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]
507
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:is_array</span>] <span class="ruby-keyword">then</span> []
508
+ <span class="ruby-keyword">else</span> <span class="ruby-keyword">nil</span>
509
+ <span class="ruby-keyword">end</span>
510
+
511
+ <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{v[:accessor]}&quot;</span>, <span class="ruby-identifier">initial_value</span>)
512
+ }
513
+ <span class="ruby-keyword">end</span></pre>
514
+ </div>
515
+
516
+ </div>
517
+
518
+
519
+
520
+
521
+ </div>
522
+
523
+
524
+ </section>
525
+
89
526
  </section>
90
527
  </main>
91
528
 
92
529
 
93
530
  <footer id="validator-badges" role="contentinfo">
94
531
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
95
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
96
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
532
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
533
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
97
534
  </footer>
98
535