From 29eccdf72dac8d916042a79402fdc7b769ef698a Mon Sep 17 00:00:00 2001 From: Thorsten Kummerow Date: Mon, 6 Jun 2016 09:39:50 +0200 Subject: [PATCH 01/13] Initial github pages branch commit. --- String.html | 257 ++ TXTextControl.html | 141 ++ TXTextControl/ReportingCloud.html | 188 ++ .../ReportingCloud/AccountSettings.html | 1054 ++++++++ TXTextControl/ReportingCloud/MergeBody.html | 673 +++++ .../ReportingCloud/MergeSettings.html | 1350 ++++++++++ .../ReportingCloud/ReportingCloud.html | 2179 +++++++++++++++++ TXTextControl/ReportingCloud/Template.html | 519 ++++ .../ReportingCloud/TemplateDataValidator.html | 277 +++ .../ReportingCloud/TemplateNameValidator.html | 277 +++ _index.html | 203 ++ class_list.html | 58 + css/common.css | 1 + css/full_list.css | 57 + css/style.css | 339 +++ file.README.html | 128 + file_list.html | 60 + frames.html | 26 + index.html | 128 + js/app.js | 219 ++ js/full_list.js | 181 ++ js/jquery.js | 4 + method_list.html | 357 +++ top-level-namespace.html | 114 + 24 files changed, 8790 insertions(+) create mode 100644 String.html create mode 100644 TXTextControl.html create mode 100644 TXTextControl/ReportingCloud.html create mode 100644 TXTextControl/ReportingCloud/AccountSettings.html create mode 100644 TXTextControl/ReportingCloud/MergeBody.html create mode 100644 TXTextControl/ReportingCloud/MergeSettings.html create mode 100644 TXTextControl/ReportingCloud/ReportingCloud.html create mode 100644 TXTextControl/ReportingCloud/Template.html create mode 100644 TXTextControl/ReportingCloud/TemplateDataValidator.html create mode 100644 TXTextControl/ReportingCloud/TemplateNameValidator.html create mode 100644 _index.html create mode 100644 class_list.html create mode 100644 css/common.css create mode 100644 css/full_list.css create mode 100644 css/style.css create mode 100644 file.README.html create mode 100644 file_list.html create mode 100644 frames.html create mode 100644 index.html create mode 100644 js/app.js create mode 100644 js/full_list.js create mode 100644 js/jquery.js create mode 100644 method_list.html create mode 100644 top-level-namespace.html diff --git a/String.html b/String.html new file mode 100644 index 0000000..de83dfc --- /dev/null +++ b/String.html @@ -0,0 +1,257 @@ + + + + + + Class: String + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: String + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/core_ext/string.rb
+ +
+
+ +

Overview

+
+ +

Extensions to class String.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) remove_first_and_last + + + + + +

+
+ +

Removes the first and last characters from a string and returns the +manipulated string.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    The string without its first and last characters.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+21
+22
+23
+24
+25
+26
+27
+ 		+ 
# File 'lib/core_ext/string.rb', line 21
+
+def remove_first_and_last 
+  if self.length == 0 then return '' end
+  result = self.dup
+  result[0] = ''
+  if result.length > 0 then result[result.length - 1] = '' end
+  return result
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl.html b/TXTextControl.html new file mode 100644 index 0000000..bd09d2e --- /dev/null +++ b/TXTextControl.html @@ -0,0 +1,141 @@ + + + + + + Module: TXTextControl + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Module: TXTextControl + + + +

+ +
+ + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud.rb,
+ lib/txtextcontrol/reportingcloud/version.rb,
lib/txtextcontrol/reportingcloud/template.rb,
lib/txtextcontrol/reportingcloud/merge_body.rb,
lib/txtextcontrol/reportingcloud/merge_settings.rb,
lib/txtextcontrol/reportingcloud/reportingcloud.rb,
lib/txtextcontrol/reportingcloud/account_settings.rb,
lib/txtextcontrol/reportingcloud/template_name_validator.rb,
lib/txtextcontrol/reportingcloud/template_data_validator.rb +
+ +
+
+ +

Overview

+
+ +

ReportingCloud Ruby Wrapper

+ +

Official wrapper (authored by Text Control GmbH, publisher of +ReportingCloud) to access ReportingCloud in Ruby.

+ +

Go to www.reporting.cloud to learn +more about ReportingCloud Go to github.com/TextControl/txtextcontrol-reportingcloud-ruby +for the canonical source repository.

+ +

License: raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-ruby/master/LICENSE.md

+ +

Copyright: © 2016 Text Control GmbH

+ + +
+
+
+ + +

Defined Under Namespace

+

+ + + Modules: ReportingCloud + + + + +

+ + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud.html b/TXTextControl/ReportingCloud.html new file mode 100644 index 0000000..40b4ce9 --- /dev/null +++ b/TXTextControl/ReportingCloud.html @@ -0,0 +1,188 @@ + + + + + + Module: TXTextControl::ReportingCloud + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Module: TXTextControl::ReportingCloud + + + +

+ +
+ + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud.rb,
+ lib/txtextcontrol/reportingcloud/version.rb,
lib/txtextcontrol/reportingcloud/template.rb,
lib/txtextcontrol/reportingcloud/merge_body.rb,
lib/txtextcontrol/reportingcloud/merge_settings.rb,
lib/txtextcontrol/reportingcloud/reportingcloud.rb,
lib/txtextcontrol/reportingcloud/account_settings.rb,
lib/txtextcontrol/reportingcloud/template_name_validator.rb,
lib/txtextcontrol/reportingcloud/template_data_validator.rb +
+ +
+
+ +

Overview

+
+ +

The ReportingCloud module.

+ + +
+
+
+ + +

Defined Under Namespace

+

+ + + + + Classes: AccountSettings, MergeBody, MergeSettings, ReportingCloud, Template, TemplateDataValidator, TemplateNameValidator + + +

+ +

Constant Summary

+ +
+ +
DEFAULT_BASE_URI = +
+
+ +

Default API base url.

+ + +
+
+
+ + +
+
+ 
"http://api.reporting.cloud"
+ +
DEFAULT_VERSION = +
+
+ +

Default API version.

+ + +
+
+
+ + +
+
+ 
"v1"
+ +
DEFAULT_TIMEOUT = +
+
+ +

Default http request timeout in seconds.

+ + +
+
+
+ + +
+
+ 
10
+ +
VERSION = + +
+ 
"1.0.0"
+ +
+ + + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/AccountSettings.html b/TXTextControl/ReportingCloud/AccountSettings.html new file mode 100644 index 0000000..a855507 --- /dev/null +++ b/TXTextControl/ReportingCloud/AccountSettings.html @@ -0,0 +1,1054 @@ + + + + + + Class: TXTextControl::ReportingCloud::AccountSettings + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::AccountSettings + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/account_settings.rb
+ +
+
+ +

Overview

+
+ +

Represents ReportingCloud account settings.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Class Method Summary + (collapse) +

+ + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (AccountSettings) initialize(serial_number, created_documents, uploaded_templates, max_documents, max_templates, valid_until = nil) + + + + + +

+
+ +

Returns a new instance of AccountSettings

+ + +
+
+
+

Parameters:

+
    + +
  • + + serial_number + + + (String, Symbol) + + + + — +
    +

    The serial number that is attached to the account. Possible values are +:free, :trial and a 13 character long serial number.

    +
    + +
    • + +
  • + + created_documents + + + (Integer) + + + + — +
    +

    The number of created documents in the current month.

    +
    + +
    • + +
  • + + uploaded_templates + + + (Integer) + + + + — +
    +

    The number of uploaded templates to the template storage.

    +
    + +
    • + +
  • + + max_documents + + + (Integer) + + + + — +
    +

    The maximum number of documents that can be created per month.

    +
    + +
    • + +
  • + + max_templates + + + (Integer) + + + + — +
    +

    The maximum number of templates that can be uploaded to the template +storage.

    +
    + +
    • + +
  • + + valid_until + + + (DateTime) + + + (defaults to: nil) + + + — +
    +

    The date until the current subscription is valid. Can be nil.

    +
    + +
    • + +
+ + +
+ + + + +
+ 
+
+
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 51
+
+def initialize(serial_number, created_documents, uploaded_templates, max_documents, max_templates, valid_until = nil)
+  case serial_number.downcase
+    when "trial"
+      @serial_number = :trial
+    when "free"
+      @serial_number = :free
+    else 
+      @serial_number = serial_number
+  end                
+  @created_documents = Integer(created_documents)
+  @uploaded_templates = Integer(uploaded_templates)
+  @max_documents = Integer(max_documents)
+  @max_templates = Integer(max_templates)
+  case valid_until
+    when DateTime
+      @valid_until = valid_until
+    when String
+      @valid_until = DateTime.iso8601(valid_until)
+    else
+      @valid_until = nil      
+  end
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (Integer) created_documents (readonly) + + + + + +

+
+ +

The number of created documents in the current month.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of created_documents

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def created_documents
+  @created_documents
+end
+
+
+ + + +
+

+ + - (Integer) max_documents (readonly) + + + + + +

+
+ +

The maximum number of documents that can be created per month.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of max_documents

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def max_documents
+  @max_documents
+end
+
+
+ + + +
+

+ + - (Integer) max_templates (readonly) + + + + + +

+
+ +

The maximum number of templates that can be uploaded to the template +storage.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of max_templates

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def max_templates
+  @max_templates
+end
+
+
+ + + +
+

+ + - (String, Symbol) serial_number (readonly) + + + + + +

+
+ +

The serial number that is attached to the account. Possible values are +:free, :trial and a 13 character long serial number.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String, Symbol) + + + + — +
    +

    the current value of serial_number

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def serial_number
+  @serial_number
+end
+
+
+ + + +
+

+ + - (Integer) uploaded_templates (readonly) + + + + + +

+
+ +

The number of uploaded templates to the template storage.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of uploaded_templates

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def uploaded_templates
+  @uploaded_templates
+end
+
+
+ + + +
+

+ + - (DateTime) valid_until (readonly) + + + + + +

+
+ +

The date until the current subscription is valid. Can be nil.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (DateTime) + + + + — +
    +

    the current value of valid_until

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+31
+32
+33
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 31
+
+def valid_until
+  @valid_until
+end
+
+
+ +
+ + +
+

Class Method Details

+ + +
+

+ + + (AccountSettings) from_camelized_hash(hash) + + + + + +

+
+ +

Creates an AccountSettings instance from a hash.

+ + +
+
+
+

Parameters:

+
    + +
  • + + hash + + + (Hash) + + + + — +
    +

    The hash to try and create an AccountSettings instance from.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (AccountSettings) + + + + — +
    +

    A newly created AccountSettings instance.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+77
+78
+79
+80
+81
+82
+83
+84
+85
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 77
+
+def self.from_camelized_hash(hash)
+  sn = hash["serialNumber"]
+  cd = hash["createdDocuments"]
+  ut = hash["uploadedTemplates"]
+  md = hash["maxDocuments"]
+  mt = hash["maxTemplates"]
+  vu = hash["validUntil"]
+  return AccountSettings.new(sn, cd, ut, md, mt, vu)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html new file mode 100644 index 0000000..ab6bf15 --- /dev/null +++ b/TXTextControl/ReportingCloud/MergeBody.html @@ -0,0 +1,673 @@ + + + + + + Class: TXTextControl::ReportingCloud::MergeBody + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::MergeBody + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/merge_body.rb
+ +
+
+ +

Overview

+
+ +

Used to pass data to the merge method.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (MergeBody) initialize(merge_data, merge_settings = nil, template = nil) + + + + + +

+
+ +

The constructor.

+ + +
+
+
+

Parameters:

+
    + +
  • + + merge_data + + + (Array<Hash>) + + + + — +
    +

    The merge data. Must be an array of hashes.

    +
    + +
    • + +
  • + + template + + + (String) + + + (defaults to: nil) + + + — +
    +

    Base64 encoded template document. Supported formats are RTF, DOC, DOCX and +TX.

    +
    + +
    • + +
  • + + merge_settings + + + (MergeSettings) + + + (defaults to: nil) + + + — +
    +

    Merge settings to specify merge properties and document properties such as +title and author.

    +
    + +
    • + +
+ + +
+ + + + +
+ 
+
+
+39
+40
+41
+42
+43
+44
+45
+46
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 39
+
+def initialize(merge_data, merge_settings = nil, template = nil)
+  unless merge_data.kind_of?(Array) && !merge_data.empty? && merge_data[0].kind_of?(Hash)
+    raise ArgumentError, "Merge data must be a non empty array of hashes."
+  end
+  @merge_data = merge_data
+  @template = template
+  @merge_settings = merge_settings
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (Array<Hash>) merge_data + + + + + +

+
+ +

The merge data. Must be an array of hashes.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array<Hash>) + + + + — +
    +

    the current value of merge_data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 27
+
+def merge_data
+  @merge_data
+end
+
+
+ + + +
+

+ + - (MergeSettings) merge_settings + + + + + +

+
+ +

Merge settings to specify merge properties and document properties such as +title and author.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (MergeSettings) + + + + — +
    +

    the current value of merge_settings

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 27
+
+def merge_settings
+  @merge_settings
+end
+
+
+ + + +
+

+ + - (String) template + + + + + +

+
+ +

Base64 encoded template document. Supported formats are RTF, DOC, DOCX and +TX.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of template

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 27
+
+def template
+  @template
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Hash) to_camelized_hash + + + + + +

+
+ +

Converts a MergeBody instance to a hash while converting the attribute +names from snake case to camel case.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Hash) + + + + — +
    +

    A hash representing the MergeBody instance.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+51
+52
+53
+54
+55
+56
+57
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 51
+
+def to_camelized_hash
+  return {
+    "mergeData" => @merge_data,
+    "template" => @template,
+    "mergeSettings" => @merge_settings.nil? ? nil : merge_settings.to_camelized_hash
+  }
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/MergeSettings.html b/TXTextControl/ReportingCloud/MergeSettings.html new file mode 100644 index 0000000..cc844de --- /dev/null +++ b/TXTextControl/ReportingCloud/MergeSettings.html @@ -0,0 +1,1350 @@ + + + + + + Class: TXTextControl::ReportingCloud::MergeSettings + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::MergeSettings + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/merge_settings.rb
+ +
+
+ +

Overview

+
+ +

Holds the merge settings needed by the merge method.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (MergeSettings) initialize + + + + + +

+
+ +

Returns a new instance of MergeSettings

+ + +
+
+
+ + +
+ + + + +
+ 
+
+
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 45
+
+def initialize
+  @remove_empty_fields = true
+  @remove_empty_blocks = true
+  @remove_empty_images = true
+  @remove_trailing_whitespace = true
+  
+  @author = nil
+  @creation_date = nil
+  @creator_application = nil
+  @document_subject = nil
+  @document_title = nil
+  @last_modification_date = nil
+  @user_password = nil
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (String) author + + + + + +

+
+ +

The document's author.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of author

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def author
+  @author
+end
+
+
+ + + +
+

+ + - (DateTime) creation_date + + + + + +

+
+ +

The document's creation date.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (DateTime) + + + + — +
    +

    the current value of creation_date

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def creation_date
+  @creation_date
+end
+
+
+ + + +
+

+ + - (String) creator_application + + + + + +

+
+ +

The application which created the document.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of creator_application

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def creator_application
+  @creator_application
+end
+
+
+ + + +
+

+ + - (String) document_subject + + + + + +

+
+ +

The document's subject.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of document_subject

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def document_subject
+  @document_subject
+end
+
+
+ + + +
+

+ + - (String) document_title + + + + + +

+
+ +

The document's title.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of document_title

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def document_title
+  @document_title
+end
+
+
+ + + +
+

+ + - (DateTime) last_modification_date + + + + + +

+
+ +

The document's last modification date.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (DateTime) + + + + — +
    +

    the current value of last_modification_date

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def last_modification_date
+  @last_modification_date
+end
+
+
+ + + +
+

+ + - (Boolean) remove_empty_blocks + + + + + +

+
+ +

Specifies whether the content of empty merge blocks should be removed from +the template or not.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + + — +
    +

    the current value of remove_empty_blocks

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def remove_empty_blocks
+  @remove_empty_blocks
+end
+
+
+ + + +
+

+ + - (Boolean) remove_empty_fields + + + + + +

+
+ +

Specifies whether empty fields should be removed from the template or not.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + + — +
    +

    the current value of remove_empty_fields

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def remove_empty_fields
+  @remove_empty_fields
+end
+
+
+ + + +
+

+ + - (Boolean) remove_empty_images + + + + + +

+
+ +

Specifies whether images which don't have merge data should be removed +from the template or not.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + + — +
    +

    the current value of remove_empty_images

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def remove_empty_images
+  @remove_empty_images
+end
+
+
+ + + +
+

+ + - (Boolean) remove_trailing_whitespace + + + + + +

+
+ +

Specifies whether trailing whitespace should be removed before saving a +document.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + + — +
    +

    the current value of remove_trailing_whitespace

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def remove_trailing_whitespace
+  @remove_trailing_whitespace
+end
+
+
+ + + +
+

+ + - (String) user_password + + + + + +

+
+ +

The password needed to open the document.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of user_password

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 34
+
+def user_password
+  @user_password
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Hash) to_camelized_hash + + + + + +

+
+ +

Converts a MergeSettings instance to a hash while converting the attribute +names from snake case to camel case.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Hash) + + + + — +
    +

    A hash representing the MergeSettings instance.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_settings.rb', line 95
+
+def to_camelized_hash
+  return {
+    "removeEmptyFields" => @remove_empty_fields,
+    "removeEmptyBlocks" => @remove_empty_blocks,
+    "removeEmptyImages" => @remove_empty_images,
+    "removeTrailingWhitespace" => @remove_trailing_whitespace,
+    "author" => @author,
+    "creationDate" => @creation_date.nil? ? nil : creation_date.iso8601,
+    "creatorApplication" => @creator_application,
+    "documentSubject" => @document_subject,
+    "documentTitle" => @document_title,
+    "lastModificationDate" => @last_modification_date.nil? ? nil : last_modification_date.iso8601,
+    "userPassword" => @user_password
+  }
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/ReportingCloud.html b/TXTextControl/ReportingCloud/ReportingCloud.html new file mode 100644 index 0000000..e776f5c --- /dev/null +++ b/TXTextControl/ReportingCloud/ReportingCloud.html @@ -0,0 +1,2179 @@ + + + + + + Class: TXTextControl::ReportingCloud::ReportingCloud + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::ReportingCloud + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/reportingcloud.rb
+ +
+
+ +

Overview

+
+ +

The main wrapper class.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (ReportingCloud) initialize(username, password, base_url = nil) + + + + + +

+
+ +

Returns a new instance of ReportingCloud

+ + +
+
+
+

Parameters:

+
    + +
  • + + username + + + (String) + + + + — +
    +

    The user name.

    +
    + +
    • + +
  • + + password + + + (String) + + + + — +
    +

    The password.

    +
    + +
    • + +
  • + + base_url + + + (String) + + + (defaults to: nil) + + + — +
    +

    The API base url. Is set to “api.reporting.cloud” by default.

    +
    + +
    • + +
+ + +
+ + + + +
+ 
+
+
+48
+49
+50
+51
+52
+53
+54
+55
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 48
+
+def initialize(username, password, base_url = nil)
+  base_url ||= DEFAULT_BASE_URI
+  @username = username
+  @password = password
+  @api_version = DEFAULT_VERSION
+  @read_timeout = DEFAULT_TIMEOUT   
+  @base_uri = URI.parse(base_url)
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (String) api_version + + + + + +

+
+ +

The API version. Is set to “v1” by default.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of api_version

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 37
+
+def api_version
+  @api_version
+end
+
+
+ + + +
+

+ + - (String) base_uri + + + + + +

+
+ +

The API base url. Is set to “api.reporting.cloud” by default.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of base_uri

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 37
+
+def base_uri
+  @base_uri
+end
+
+
+ + + +
+

+ + - (String) password + + + + + +

+
+ +

The password.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of password

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 37
+
+def password
+  @password
+end
+
+
+ + + +
+

+ + - (Integer) read_timeout + + + + + +

+
+ +

The timeout for HTTP requests in seconds. Is set to 10 by default.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of read_timeout

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 37
+
+def read_timeout
+  @read_timeout
+end
+
+
+ + + +
+

+ + - (String) username + + + + + +

+
+ +

The user name.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of username

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 37
+
+def username
+  @username
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (String) convert_document(template_data, return_format = :pdf) + + + + + +

+
+ +

Converts a document to another format.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_data + + + (String) + + + + — +
    +

    The source document encoded as a Base64 string. The supported document +formats are .rtf, .doc, .docx, .html, .pdf and .tx.

    +
    + +
    • + +
  • + + return_format + + + (Symbol) + + + (defaults to: :pdf) + + + — +
    +

    The format of the created document. Possible values are: :pdf, :rtf, :doc, +:docx, :html and :tx.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    The created document encoded as a Base64 string.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 253
+
+def convert_document(template_data, return_format = :pdf)
+  # Parameter validation
+  TemplateDataValidator.validate(template_data)
+  
+  res = request("/document/convert", :post, { :returnFormat => return_format }, template_data)
+  if res.kind_of? Net::HTTPSuccess
+    # Remove leading and trailing quote from string 
+    # (inexplicably JSON.parse chokes on simple strings)
+    return res.body.remove_first_and_last
+  else
+    raise res.body 
+  end                
+end
+
+
+ +
+

+ + - (void) delete_template(template_name) + + + + + +

+
+

This method returns an undefined value.

+

Deletes a template from the template storage.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template to be deleted from the template storage.

    +
    + +
    • + +
+ + +
+ + + + +
+ 
+
+
+166
+167
+168
+169
+170
+171
+172
+173
+174
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 166
+
+def delete_template(template_name)
+  # Parameter validation
+  TemplateNameValidator.validate(template_name)
+  
+  res = request("/templates/delete", :delete, { :templateName => template_name })
+  unless res.kind_of? Net::HTTPSuccess
+    raise res.body 
+  end
+end
+
+
+ +
+

+ + - (String) download_template(template_name) + + + + + +

+
+ +

Returns the selected template from the storage.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template in the template storage.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    The template document data as a Base64 encoded string.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 196
+
+def download_template(template_name)
+  # Parameter validation
+  TemplateNameValidator.validate(template_name)
+
+  res = request("/templates/download", :get, { :templateName => template_name })        
+  if res.kind_of? Net::HTTPSuccess
+    return res.body.remove_first_and_last
+  else
+    raise res.body
+  end
+end
+
+
+ +
+

+ + - (AccountSettings) get_account_settings + + + + + +

+
+ +

Returns the account settings.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (AccountSettings) + + + + — +
    +

    The account settings.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+123
+124
+125
+126
+127
+128
+129
+130
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 123
+
+def 
+  res = request("/account/settings", :get)
+  if res.kind_of? Net::HTTPSuccess
+    return AccountSettings.from_camelized_hash(JSON.parse(res.body))
+  else
+    raise res.body 
+  end
+end
+
+
+ +
+

+ + - (Integer) get_template_count + + + + + +

+
+ +

Returns the number of templates in the template storage.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    The number of templates in the template storage.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+75
+76
+77
+78
+79
+80
+81
+82
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 75
+
+def get_template_count
+  res = request("/templates/count", :get)
+  if res.kind_of? Net::HTTPSuccess
+    return Integer(res.body)
+  else
+    raise res.body
+  end
+end
+
+
+ +
+

+ + - (Integer) get_template_page_count(template_name) + + + + + +

+
+ +

Returns the number of pages of a template in the template storage.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template in the template storage to retrieve the number +of pages for.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    The number of pages in the template.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 235
+
+def get_template_page_count(template_name)
+  # Parameter validation
+  TemplateNameValidator.validate(template_name)
+  
+  res = request("/templates/pagecount", :get, { :templateName => template_name })
+  if res.kind_of? Net::HTTPSuccess
+    return Integer(res.body)
+  else
+    raise res.body
+  end        
+end
+
+
+ +
+

+ + - (Array<String>) get_template_thumbnails(template_name, zoom_factor, from_page = 1, to_page = 0, image_format = :png) + + + + + +

+
+ +

Returns a list of thumbnails of a specific template.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template in the template storage.

    +
    + +
    • + +
  • + + zoom_factor + + + (Integer) + + + + — +
    +

    An Integer value between 1 and 400 to set the percentage zoom factor of the +created thumbnail images.

    +
    + +
    • + +
  • + + from_page + + + (Integer) + + + (defaults to: 1) + + + — +
    +

    An Integer value that specifies the first page.

    +
    + +
    • + +
  • + + to_page + + + (Integer) + + + (defaults to: 0) + + + — +
    +

    An Integer value that specifies the last page.

    +
    + +
    • + +
  • + + image_format + + + (Symbol) + + + (defaults to: :png) + + + — +
    +

    Defines the image format of the returned thumbnails. Possible values are +:png, :jpg, :gif and :bmp.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Array<String>) + + + + — +
    +

    An array of Base64 encoded images.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 141
+
+def get_template_thumbnails(template_name, zoom_factor, from_page = 1, to_page = 0, image_format = :png)
+  # Prepare query parameters
+  params = {
+    :templateName => template_name,
+    :zoomFactor => zoom_factor,
+    :fromPage => from_page,
+    :toPage => to_page,
+  }
+  if image_format != :png
+    params[:imageFormat] = image_format 
+  end
+  
+  # Send request
+  res = request("/templates/thumbnails", :get, params)
+  if res.kind_of? Net::HTTPSuccess
+    return JSON.parse(res.body)
+  else
+    raise res.body
+  end        
+end
+
+
+ +
+

+ + - (Array<Template>) list_templates + + + + + +

+
+ +

Lists all templates from the template storage.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array<Template>) + + + + — +
    +

    An array of Template objects.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 59
+
+def list_templates
+  res = request("/templates/list", :get)
+  if res.kind_of? Net::HTTPSuccess
+    templates = Array.new
+    data = JSON.parse(res.body, object_class: OpenStruct)
+    data.each do |elem|
+      templates.push(Template.new(elem.templateName, elem.modified, elem.size))
+    end
+    return templates
+  else
+    raise res.body
+  end
+end
+
+
+ +
+

+ + - (Array<String>) merge_document(merge_body, template_name = nil, return_format = :pdf, append = false) + + + + + +

+
+ +

Merges and returns a template from the template storage or an uploaded +template with JSON data.

+ + +
+
+
+

Parameters:

+
    + +
  • + + return_format + + + (Symbol) + + + (defaults to: :pdf) + + + — +
    +

    The format of the created document. Possible values are :pdf, :rtf, :doc, +:docx, :html and :tx.

    +
    + +
    • + +
  • + + merge_body + + + (MergeBody) + + + + — +
    +

    The MergeBody object contains the datasource as a JSON data object and +optionally, a template encoded as a Base64 string.

    +
    + +
    • + +
  • + + template_name + + + (String) + + + (defaults to: nil) + + + — +
    +

    The name of the template in the template storage. If no template name is +specified, the template must be uploaded in the MergeBody object of this +request.

    +
    + +
    • + +
  • + + append + + + (Boolean) + + + (defaults to: false) + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Array<String>) + + + + — +
    +

    An array of the created documents as Base64 encoded strings.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 96
+
+def merge_document(merge_body, template_name = nil, return_format = :pdf, append = false)
+  if !template_name.to_s.empty? && !merge_body.template.nil?   # .to_s.empty: check for nil or ''
+    raise ArgumentError, "Template name and template data must not be present at the same time."
+  elsif template_name.to_s.empty? && merge_body.template.nil?
+    raise ArgumentError, "Either a template name or template data have to be present."
+  end
+  
+  # Create query parameters
+  params = {
+    :returnFormat => return_format,
+    :append => append
+  }
+  unless template_name.to_s.empty? 
+    params[:templateName] = template_name
+  end
+  
+  # Send request
+  res = request("/document/merge", :post, params, merge_body)
+  if res.kind_of? Net::HTTPSuccess
+    return JSON.parse(res.body)
+  else
+    raise res.body 
+  end        
+end
+
+
+ +
+

+ + - (Boolean) template_exists?(template_name) + + + + + +

+
+ +

Checks whether a template exists in the template storage.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template to be checked for availability in the +template storage.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + + — +
    +

    Returns if the template with the given name exists in the template storage.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 213
+
+def template_exists?(template_name)
+  # Parameter validation
+  TemplateNameValidator.validate(template_name)
+
+  res = request("/templates/exists", :get, { :templateName => template_name })                       
+  if res.kind_of? Net::HTTPSuccess
+    case res.body
+      when "true"
+        return true
+      when "false"
+        return false
+      else raise "Unknown response value received." 
+    end
+  else
+    raise res.body
+  end
+end
+
+
+ +
+

+ + - (void) upload_template(template_name, template_data) + + + + + +

+
+

This method returns an undefined value.

+

Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf +and *.tx)

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The filename of the template in the template storage. Existing files with +the same filename will be overwritten.

    +
    + +
    • + +
  • + + template_data + + + (String) + + + + — +
    +

    A document encoded as a Base64 string. The supported formats are DOC, +DOCX, RTF and TX.

    +
    + +
    • + +
+ + +
+ + + + +
+ 
+
+
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 182
+
+def upload_template(template_name, template_data)
+  # Parameter validation
+  TemplateNameValidator.validate(template_name)
+  TemplateDataValidator.validate(template_data)
+  
+  res = request("/templates/upload", :post, { :templateName => template_name }, template_data)
+  unless res.kind_of? Net::HTTPSuccess
+    raise res.body 
+  end        
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/Template.html b/TXTextControl/ReportingCloud/Template.html new file mode 100644 index 0000000..358fa09 --- /dev/null +++ b/TXTextControl/ReportingCloud/Template.html @@ -0,0 +1,519 @@ + + + + + + Class: TXTextControl::ReportingCloud::Template + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::Template + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/template.rb
+ +
+
+ +

Overview

+
+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (Template) initialize(template_name, modified, size) + + + + + +

+
+ +

Returns a new instance of Template

+ + +
+
+
+ + +
+ + + + +
+ 
+
+
+29
+30
+31
+32
+33
+34
+35
+36
+37
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 29
+
+def initialize(template_name, modified, size)
+  @template_name = template_name
+  if modified.is_a?(DateTime)
+    @modified = modified
+  else
+    @modified = DateTime.iso8601(modified) 
+  end
+  @size = size
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (DateTime) modified (readonly) + + + + + +

+
+ +

The date and time the template file was last modified.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (DateTime) + + + + — +
    +

    the current value of modified

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+24
+25
+26
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+
+def modified
+  @modified
+end
+
+
+ + + +
+

+ + - (Integer) size (readonly) + + + + + +

+
+ +

The size of the template file in bytes.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    the current value of size

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+24
+25
+26
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+
+def size
+  @size
+end
+
+
+ + + +
+

+ + - (String) template_name (readonly) + + + + + +

+
+ +

The template file name.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of template_name

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+24
+25
+26
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+
+def template_name
+  @template_name
+end
+
+
+ +
+ + +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/TemplateDataValidator.html b/TXTextControl/ReportingCloud/TemplateDataValidator.html new file mode 100644 index 0000000..ce70502 --- /dev/null +++ b/TXTextControl/ReportingCloud/TemplateDataValidator.html @@ -0,0 +1,277 @@ + + + + + + Class: TXTextControl::ReportingCloud::TemplateDataValidator + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::TemplateDataValidator + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/template_data_validator.rb
+ +
+
+ +

Overview

+
+ +

Internal method parameter validator class.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + + + + + +

+ Class Method Summary + (collapse) +

+ + + + + + +
+

Class Method Details

+ + +
+

+ + + (Boolean) validate(template_data) + + + + + +

+
+ +

Checks if a given value is a String, is not nil and not empty.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_data + + + (String) + + + + — +
    +

    The string to validate.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+

Raises:

+
    + +
  • + + + (ArgumentError) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+24
+25
+26
+27
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template_data_validator.rb', line 24
+
+def self.validate(template_data)
+  raise ArgumentError, "Template data must be a Base64 encoded string." if !template_data.kind_of? String
+  raise ArgumentError, "No template data given." if template_data.to_s.empty?
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/TemplateNameValidator.html b/TXTextControl/ReportingCloud/TemplateNameValidator.html new file mode 100644 index 0000000..aa83b14 --- /dev/null +++ b/TXTextControl/ReportingCloud/TemplateNameValidator.html @@ -0,0 +1,277 @@ + + + + + + Class: TXTextControl::ReportingCloud::TemplateNameValidator + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Class: TXTextControl::ReportingCloud::TemplateNameValidator + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/txtextcontrol/reportingcloud/template_name_validator.rb
+ +
+
+ +

Overview

+
+ +

Internal method parameter validator class.

+ + +
+
+
+ +

Author:

+
    + +
  • + + + + + +
    +

    Thorsten Kummerow (@thomerow)

    +
    + +
    • + +
+ +
+ + + + + + + +

+ Class Method Summary + (collapse) +

+ + + + + + +
+

Class Method Details

+ + +
+

+ + + (Boolean) validate(template_name) + + + + + +

+
+ +

Checks if a given value is a String, is not nil and not empty.

+ + +
+
+
+

Parameters:

+
    + +
  • + + template_name + + + (String) + + + + — +
    +

    The string to validate.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+

Raises:

+
    + +
  • + + + (ArgumentError) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+24
+25
+26
+27
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/template_name_validator.rb', line 24
+
+def self.validate(template_name)
+  raise ArgumentError, "Template name must be a String." if !template_name.kind_of? String 
+  raise ArgumentError, "No template name given." if template_name.to_s.empty?
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/_index.html b/_index.html new file mode 100644 index 0000000..744c16f --- /dev/null +++ b/_index.html @@ -0,0 +1,203 @@ + + + + + + Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Documentation by YARD 0.8.7.6

+
+

Alphabetic Index

+ +

File Listing

+ + +
+

Namespace Listing A-Z

+ + + + + + + + +
+ + +
    +
  • A
    • + +
+ + +
    +
  • M
    • +
      + +
    • + MergeBody + + (TXTextControl::ReportingCloud) + +
      • + +
    • + MergeSettings + + (TXTextControl::ReportingCloud) + +
      • + +
    +
+ + + + + +
    +
  • S
    • + +
+ + + + +
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/class_list.html b/class_list.html new file mode 100644 index 0000000..3dc39bd --- /dev/null +++ b/class_list.html @@ -0,0 +1,58 @@ + + + + + + + + + + + + + + + + + Class List + + + + +
+

Class List

+ + + + +
+ + diff --git a/css/common.css b/css/common.css new file mode 100644 index 0000000..cf25c45 --- /dev/null +++ b/css/common.css @@ -0,0 +1 @@ +/* Override this file with custom rules */ \ No newline at end of file diff --git a/css/full_list.css b/css/full_list.css new file mode 100644 index 0000000..c918cf1 --- /dev/null +++ b/css/full_list.css @@ -0,0 +1,57 @@ +body { + margin: 0; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; + height: 101%; + overflow-x: hidden; +} + +h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; } +.clear { clear: both; } +#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; } +#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; } +#full_list { padding: 0; list-style: none; margin-left: 0; } +#full_list ul { padding: 0; } +#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; } +#noresults { padding: 7px 12px; } +#content.insearch #noresults { margin-left: 7px; } +ul.collapsed ul, ul.collapsed li { display: none; } +ul.collapsed.search_uncollapsed { display: block; } +ul.collapsed.search_uncollapsed li { display: list-item; } +li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; } +li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; } +li { color: #888; cursor: pointer; } +li.deprecated { text-decoration: line-through; font-style: italic; } +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } +li:hover { background: #ddd; } +li small:before { content: "("; } +li small:after { content: ")"; } +li small.search_info { display: none; } +a:link, a:visited { text-decoration: none; color: #05a; } +li.clicked { background: #05a; color: #ccc; } +li.clicked a:link, li.clicked a:visited { color: #eee; } +li.clicked a.toggle { opacity: 0.5; background-position: bottom right; } +li.collapsed.clicked a.toggle { background-position: top right; } +#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; } +#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; } +#nav a:link, #nav a:visited { color: #358; } +#nav a:hover { background: transparent; color: #5af; } +.frames #nav span:after { content: ' | '; } +.frames #nav span:last-child:after { content: ''; } + +.frames #content h1 { margin-top: 0; } +.frames li { white-space: nowrap; cursor: normal; } +.frames li small { display: block; font-size: 0.8em; } +.frames li small:before { content: ""; } +.frames li small:after { content: ""; } +.frames li small.search_info { display: none; } +.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; } +.frames #content.insearch #search { background-position: center right; } +.frames #search input { width: 110px; } +.frames #nav { display: block; } + +#full_list.insearch li { display: none; } +#full_list.insearch li.found { display: list-item; padding-left: 10px; } +#full_list.insearch li a.toggle { display: none; } +#full_list.insearch li small.search_info { display: block; } diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..96307c5 --- /dev/null +++ b/css/style.css @@ -0,0 +1,339 @@ +body { + padding: 0 20px; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; +} +body.frames { padding: 0 5px; } +h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; } +h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; } +h1.title { margin-bottom: 10px; } +h1.alphaindex { margin-top: 0; font-size: 22px; } +h2 { + padding: 0; + padding-bottom: 3px; + border-bottom: 1px #aaa solid; + font-size: 1.4em; + margin: 1.8em 0 0.5em; +} +h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; } +.clear { clear: both; } +.inline { display: inline; } +.inline p:first-child { display: inline; } +.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; } +.docstring h1 { font-size: 1.2em; } +.docstring h2 { font-size: 1.1em; } +.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; } +.summary_desc .object_link, .docstring .object_link { font-family: monospace; } +.rdoc-term { padding-right: 25px; font-weight: bold; } +.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; } + +/* style for */ +#filecontents table, .docstring table { border-collapse: collapse; } +#filecontents table th, #filecontents table td, +.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; } +#filecontents table tr:nth-child(odd), +.docstring table tr:nth-child(odd) { background: #eee; } +#filecontents table tr:nth-child(even), +.docstring table tr:nth-child(even) { background: #fff; } +#filecontents table th, .docstring table th { background: #fff; } + +/* style for
a",d=q.getElementsByTagName("*"),e=q.getElementsByTagName("a")[0];if(!d||!d.length||!e)return{};g=c.createElement("select"),h=g.appendChild(c.createElement("option")),i=q.getElementsByTagName("input")[0],b={leadingWhitespace:q.firstChild.nodeType===3,tbody:!q.getElementsByTagName("tbody").length,htmlSerialize:!!q.getElementsByTagName("link").length,style:/top/.test(e.getAttribute("style")),hrefNormalized:e.getAttribute("href")==="/a",opacity:/^0.55/.test(e.style.opacity),cssFloat:!!e.style.cssFloat,checkOn:i.value==="on",optSelected:h.selected,getSetAttribute:q.className!=="t",enctype:!!c.createElement("form").enctype,html5Clone:c.createElement("nav").cloneNode(!0).outerHTML!=="<:nav>",submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0},i.checked=!0,b.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,b.optDisabled=!h.disabled;try{delete q.test}catch(s){b.deleteExpando=!1}!q.addEventListener&&q.attachEvent&&q.fireEvent&&(q.attachEvent("onclick",function(){b.noCloneEvent=!1}),q.cloneNode(!0).fireEvent("onclick")),i=c.createElement("input"),i.value="t",i.setAttribute("type","radio"),b.radioValue=i.value==="t",i.setAttribute("checked","checked"),q.appendChild(i),k=c.createDocumentFragment(),k.appendChild(q.lastChild),b.checkClone=k.cloneNode(!0).cloneNode(!0).lastChild.checked,b.appendChecked=i.checked,k.removeChild(i),k.appendChild(q),q.innerHTML="",a.getComputedStyle&&(j=c.createElement("div"),j.style.width="0",j.style.marginRight="0",q.style.width="2px",q.appendChild(j),b.reliableMarginRight=(parseInt((a.getComputedStyle(j,null)||{marginRight:0}).marginRight,10)||0)===0);if(q.attachEvent)for(o in{submit:1,change:1,focusin:1})n="on"+o,p=n in q,p||(q.setAttribute(n,"return;"),p=typeof q[n]=="function"),b[o+"Bubbles"]=p;k.removeChild(q),k=g=h=j=q=i=null,f(function(){var a,d,e,g,h,i,j,k,m,n,o,r=c.getElementsByTagName("body")[0];!r||(j=1,k="position:absolute;top:0;left:0;width:1px;height:1px;margin:0;",m="visibility:hidden;border:0;",n="style='"+k+"border:5px solid #000;padding:0;'",o="
"+""+"
",a=c.createElement("div"),a.style.cssText=m+"width:0;height:0;position:static;top:0;margin-top:"+j+"px",r.insertBefore(a,r.firstChild),q=c.createElement("div"),a.appendChild(q),q.innerHTML="
t
",l=q.getElementsByTagName("td"),p=l[0].offsetHeight===0,l[0].style.display="",l[1].style.display="none",b.reliableHiddenOffsets=p&&l[0].offsetHeight===0,q.innerHTML="",q.style.width=q.style.paddingLeft="1px",f.boxModel=b.boxModel=q.offsetWidth===2,typeof q.style.zoom!="undefined"&&(q.style.display="inline",q.style.zoom=1,b.inlineBlockNeedsLayout=q.offsetWidth===2,q.style.display="",q.innerHTML="
",b.shrinkWrapBlocks=q.offsetWidth!==2),q.style.cssText=k+m,q.innerHTML=o,d=q.firstChild,e=d.firstChild,h=d.nextSibling.firstChild.firstChild,i={doesNotAddBorder:e.offsetTop!==5,doesAddBorderForTableAndCells:h.offsetTop===5},e.style.position="fixed",e.style.top="20px",i.fixedPosition=e.offsetTop===20||e.offsetTop===15,e.style.position=e.style.top="",d.style.overflow="hidden",d.style.position="relative",i.subtractsBorderForOverflowNotVisible=e.offsetTop===-5,i.doesNotIncludeMarginInBodyOffset=r.offsetTop!==j,r.removeChild(a),q=a=null,f.extend(b,i))});return b}();var j=/^(?:\{.*\}|\[.*\])$/,k=/([A-Z])/g;f.extend({cache:{},uuid:0,expando:"jQuery"+(f.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){a=a.nodeType?f.cache[a[f.expando]]:a[f.expando];return!!a&&!m(a)},data:function(a,c,d,e){if(!!f.acceptData(a)){var g,h,i,j=f.expando,k=typeof c=="string",l=a.nodeType,m=l?f.cache:a,n=l?a[j]:a[j]&&j,o=c==="events";if((!n||!m[n]||!o&&!e&&!m[n].data)&&k&&d===b)return;n||(l?a[j]=n=++f.uuid:n=j),m[n]||(m[n]={},l||(m[n].toJSON=f.noop));if(typeof c=="object"||typeof c=="function")e?m[n]=f.extend(m[n],c):m[n].data=f.extend(m[n].data,c);g=h=m[n],e||(h.data||(h.data={}),h=h.data),d!==b&&(h[f.camelCase(c)]=d);if(o&&!h[c])return g.events;k?(i=h[c],i==null&&(i=h[f.camelCase(c)])):i=h;return i}},removeData:function(a,b,c){if(!!f.acceptData(a)){var d,e,g,h=f.expando,i=a.nodeType,j=i?f.cache:a,k=i?a[h]:h;if(!j[k])return;if(b){d=c?j[k]:j[k].data;if(d){f.isArray(b)||(b in d?b=[b]:(b=f.camelCase(b),b in d?b=[b]:b=b.split(" ")));for(e=0,g=b.length;e-1)return!0;return!1},val:function(a){var c,d,e,g=this[0];{if(!!arguments.length){e=f.isFunction(a);return this.each(function(d){var g=f(this),h;if(this.nodeType===1){e?h=a.call(this,d,g.val()):h=a,h==null?h="":typeof h=="number"?h+="":f.isArray(h)&&(h=f.map(h,function(a){return a==null?"":a+""})),c=f.valHooks[this.nodeName.toLowerCase()]||f.valHooks[this.type];if(!c||!("set"in c)||c.set(this,h,"value")===b)this.value=h}})}if(g){c=f.valHooks[g.nodeName.toLowerCase()]||f.valHooks[g.type];if(c&&"get"in c&&(d=c.get(g,"value"))!==b)return d;d=g.value;return typeof d=="string"?d.replace(q,""):d==null?"":d}}}}),f.extend({valHooks:{option:{get:function(a){var b=a.attributes.value;return!b||b.specified?a.value:a.text}},select:{get:function(a){var b,c,d,e,g=a.selectedIndex,h=[],i=a.options,j=a.type==="select-one";if(g<0)return null;c=j?g:0,d=j?g+1:i.length;for(;c=0}),c.length||(a.selectedIndex=-1);return c}}},attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attr:function(a,c,d,e){var g,h,i,j=a.nodeType;if(!!a&&j!==3&&j!==8&&j!==2){if(e&&c in f.attrFn)return f(a)[c](d);if(typeof a.getAttribute=="undefined")return f.prop(a,c,d);i=j!==1||!f.isXMLDoc(a),i&&(c=c.toLowerCase(),h=f.attrHooks[c]||(u.test(c)?x:w));if(d!==b){if(d===null){f.removeAttr(a,c);return}if(h&&"set"in h&&i&&(g=h.set(a,d,c))!==b)return g;a.setAttribute(c,""+d);return d}if(h&&"get"in h&&i&&(g=h.get(a,c))!==null)return g;g=a.getAttribute(c);return g===null?b:g}},removeAttr:function(a,b){var c,d,e,g,h=0;if(b&&a.nodeType===1){d=b.toLowerCase().split(p),g=d.length;for(;h=0}})});var z=/^(?:textarea|input|select)$/i,A=/^([^\.]*)?(?:\.(.+))?$/,B=/\bhover(\.\S+)?\b/,C=/^key/,D=/^(?:mouse|contextmenu)|click/,E=/^(?:focusinfocus|focusoutblur)$/,F=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,G=function(a){var b=F.exec(a);b&&(b[1]=(b[1]||"").toLowerCase(),b[3]=b[3]&&new RegExp("(?:^|\\s)"+b[3]+"(?:\\s|$)"));return b},H=function(a,b){var c=a.attributes||{};return(!b[1]||a.nodeName.toLowerCase()===b[1])&&(!b[2]||(c.id||{}).value===b[2])&&(!b[3]||b[3].test((c["class"]||{}).value))},I=function(a){return f.event.special.hover?a:a.replace(B,"mouseenter$1 mouseleave$1")}; +f.event={add:function(a,c,d,e,g){var h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3||a.nodeType===8||!c||!d||!(h=f._data(a)))){d.handler&&(p=d,d=p.handler),d.guid||(d.guid=f.guid++),j=h.events,j||(h.events=j={}),i=h.handle,i||(h.handle=i=function(a){return typeof f!="undefined"&&(!a||f.event.triggered!==a.type)?f.event.dispatch.apply(i.elem,arguments):b},i.elem=a),c=f.trim(I(c)).split(" ");for(k=0;k=0&&(h=h.slice(0,-1),k=!0),h.indexOf(".")>=0&&(i=h.split("."),h=i.shift(),i.sort());if((!e||f.event.customEvent[h])&&!f.event.global[h])return;c=typeof c=="object"?c[f.expando]?c:new f.Event(h,c):new f.Event(h),c.type=h,c.isTrigger=!0,c.exclusive=k,c.namespace=i.join("."),c.namespace_re=c.namespace?new RegExp("(^|\\.)"+i.join("\\.(?:.*\\.)?")+"(\\.|$)"):null,o=h.indexOf(":")<0?"on"+h:"";if(!e){j=f.cache;for(l in j)j[l].events&&j[l].events[h]&&f.event.trigger(c,d,j[l].handle.elem,!0);return}c.result=b,c.target||(c.target=e),d=d!=null?f.makeArray(d):[],d.unshift(c),p=f.event.special[h]||{};if(p.trigger&&p.trigger.apply(e,d)===!1)return;r=[[e,p.bindType||h]];if(!g&&!p.noBubble&&!f.isWindow(e)){s=p.delegateType||h,m=E.test(s+h)?e:e.parentNode,n=null;for(;m;m=m.parentNode)r.push([m,s]),n=m;n&&n===e.ownerDocument&&r.push([n.defaultView||n.parentWindow||a,s])}for(l=0;le&&i.push({elem:this,matches:d.slice(e)});for(j=0;j0?this.on(b,null,a,c):this.trigger(b)},f.attrFn&&(f.attrFn[b]=!0),C.test(b)&&(f.event.fixHooks[b]=f.event.keyHooks),D.test(b)&&(f.event.fixHooks[b]=f.event.mouseHooks)}),function(){function x(a,b,c,e,f,g){for(var h=0,i=e.length;h0){k=j;break}}j=j[a]}e[h]=k}}}function w(a,b,c,e,f,g){for(var h=0,i=e.length;h+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,d="sizcache"+(Math.random()+"").replace(".",""),e=0,g=Object.prototype.toString,h=!1,i=!0,j=/\\/g,k=/\r\n/g,l=/\W/;[0,0].sort(function(){i=!1;return 0});var m=function(b,d,e,f){e=e||[],d=d||c;var h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof b!="string")return e;var i,j,k,l,n,q,r,t,u=!0,v=m.isXML(d),w=[],x=b;do{a.exec(""),i=a.exec(x);if(i){x=i[3],w.push(i[1]);if(i[2]){l=i[3];break}}}while(i);if(w.length>1&&p.exec(b))if(w.length===2&&o.relative[w[0]])j=y(w[0]+w[1],d,f);else{j=o.relative[w[0]]?[d]:m(w.shift(),d);while(w.length)b=w.shift(),o.relative[b]&&(b+=w.shift()),j=y(b,j,f)}else{!f&&w.length>1&&d.nodeType===9&&!v&&o.match.ID.test(w[0])&&!o.match.ID.test(w[w.length-1])&&(n=m.find(w.shift(),d,v),d=n.expr?m.filter(n.expr,n.set)[0]:n.set[0]);if(d){n=f?{expr:w.pop(),set:s(f)}:m.find(w.pop(),w.length===1&&(w[0]==="~"||w[0]==="+")&&d.parentNode?d.parentNode:d,v),j=n.expr?m.filter(n.expr,n.set):n.set,w.length>0?k=s(j):u=!1;while(w.length)q=w.pop(),r=q,o.relative[q]?r=w.pop():q="",r==null&&(r=d),o.relative[q](k,r,v)}else k=w=[]}k||(k=j),k||m.error(q||b);if(g.call(k)==="[object Array]")if(!u)e.push.apply(e,k);else if(d&&d.nodeType===1)for(t=0;k[t]!=null;t++)k[t]&&(k[t]===!0||k[t].nodeType===1&&m.contains(d,k[t]))&&e.push(j[t]);else for(t=0;k[t]!=null;t++)k[t]&&k[t].nodeType===1&&e.push(j[t]);else s(k,e);l&&(m(l,h,e,f),m.uniqueSort(e));return e};m.uniqueSort=function(a){if(u){h=i,a.sort(u);if(h)for(var b=1;b0},m.find=function(a,b,c){var d,e,f,g,h,i;if(!a)return[];for(e=0,f=o.order.length;e":function(a,b){var c,d=typeof b=="string",e=0,f=a.length;if(d&&!l.test(b)){b=b.toLowerCase();for(;e=0)?c||d.push(h):c&&(b[g]=!1));return!1},ID:function(a){return a[1].replace(j,"")},TAG:function(a,b){return a[1].replace(j,"").toLowerCase()},CHILD:function(a){if(a[1]==="nth"){a[2]||m.error(a[0]),a[2]=a[2].replace(/^\+|\s*/g,"");var b=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(a[2]==="even"&&"2n"||a[2]==="odd"&&"2n+1"||!/\D/.test(a[2])&&"0n+"+a[2]||a[2]);a[2]=b[1]+(b[2]||1)-0,a[3]=b[3]-0}else a[2]&&m.error(a[0]);a[0]=e++;return a},ATTR:function(a,b,c,d,e,f){var g=a[1]=a[1].replace(j,"");!f&&o.attrMap[g]&&(a[1]=o.attrMap[g]),a[4]=(a[4]||a[5]||"").replace(j,""),a[2]==="~="&&(a[4]=" "+a[4]+" ");return a},PSEUDO:function(b,c,d,e,f){if(b[1]==="not")if((a.exec(b[3])||"").length>1||/^\w/.test(b[3]))b[3]=m(b[3],null,null,c);else{var g=m.filter(b[3],c,d,!0^f);d||e.push.apply(e,g);return!1}else if(o.match.POS.test(b[0])||o.match.CHILD.test(b[0]))return!0;return b},POS:function(a){a.unshift(!0);return a}},filters:{enabled:function(a){return a.disabled===!1&&a.type!=="hidden"},disabled:function(a){return a.disabled===!0},checked:function(a){return a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!m(c[3],a).length},header:function(a){return/h\d/i.test(a.nodeName)},text:function(a){var b=a.getAttribute("type"),c=a.type;return a.nodeName.toLowerCase()==="input"&&"text"===c&&(b===c||b===null)},radio:function(a){return a.nodeName.toLowerCase()==="input"&&"radio"===a.type},checkbox:function(a){return a.nodeName.toLowerCase()==="input"&&"checkbox"===a.type},file:function(a){return a.nodeName.toLowerCase()==="input"&&"file"===a.type},password:function(a){return a.nodeName.toLowerCase()==="input"&&"password"===a.type},submit:function(a){var b=a.nodeName.toLowerCase();return(b==="input"||b==="button")&&"submit"===a.type},image:function(a){return a.nodeName.toLowerCase()==="input"&&"image"===a.type},reset:function(a){var b=a.nodeName.toLowerCase();return(b==="input"||b==="button")&&"reset"===a.type},button:function(a){var b=a.nodeName.toLowerCase();return b==="input"&&"button"===a.type||b==="button"},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)},focus:function(a){return a===a.ownerDocument.activeElement}},setFilters:{first:function(a,b){return b===0},last:function(a,b,c,d){return b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return b%2===1},lt:function(a,b,c){return bc[3]-0},nth:function(a,b,c){return c[3]-0===b},eq:function(a,b,c){return c[3]-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b[1],f=o.filters[e];if(f)return f(a,c,b,d);if(e==="contains")return(a.textContent||a.innerText||n([a])||"").indexOf(b[3])>=0;if(e==="not"){var g=b[3];for(var h=0,i=g.length;h=0}},ID:function(a,b){return a.nodeType===1&&a.getAttribute("id")===b},TAG:function(a,b){return b==="*"&&a.nodeType===1||!!a.nodeName&&a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(" "+(a.className||a.getAttribute("class"))+" ").indexOf(b)>-1},ATTR:function(a,b){var c=b[1],d=m.attr?m.attr(a,c):o.attrHandle[c]?o.attrHandle[c](a):a[c]!=null?a[c]:a.getAttribute(c),e=d+"",f=b[2],g=b[4];return d==null?f==="!=":!f&&m.attr?d!=null:f==="="?e===g:f==="*="?e.indexOf(g)>=0:f==="~="?(" "+e+" ").indexOf(g)>=0:g?f==="!="?e!==g:f==="^="?e.indexOf(g)===0:f==="$="?e.substr(e.length-g.length)===g:f==="|="?e===g||e.substr(0,g.length+1)===g+"-":!1:e&&d!==!1},POS:function(a,b,c,d){var e=b[2],f=o.setFilters[e];if(f)return f(a,c,b,d)}}},p=o.match.POS,q=function(a,b){return"\\"+(b-0+1)};for(var r in o.match)o.match[r]=new RegExp(o.match[r].source+/(?![^\[]*\])(?![^\(]*\))/.source),o.leftMatch[r]=new RegExp(/(^(?:.|\r|\n)*?)/.source+o.match[r].source.replace(/\\(\d+)/g,q));var s=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0)[0].nodeType}catch(t){s=function(a,b){var c=0,d=b||[];if(g.call(a)==="[object Array]")Array.prototype.push.apply(d,a);else if(typeof a.length=="number")for(var e=a.length;c",e.insertBefore(a,e.firstChild),c.getElementById(d)&&(o.find.ID=function(a,c,d){if(typeof c.getElementById!="undefined"&&!d){var e=c.getElementById(a[1]);return e?e.id===a[1]||typeof e.getAttributeNode!="undefined"&&e.getAttributeNode("id").nodeValue===a[1]?[e]:b:[]}},o.filter.ID=function(a,b){var c=typeof a.getAttributeNode!="undefined"&&a.getAttributeNode("id");return a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var a=c.createElement("div");a.appendChild(c.createComment("")),a.getElementsByTagName("*").length>0&&(o.find.TAG=function(a,b){var c=b.getElementsByTagName(a[1]);if(a[1]==="*"){var d=[];for(var e=0;c[e];e++)c[e].nodeType===1&&d.push(c[e]);c=d}return c}),a.innerHTML="",a.firstChild&&typeof a.firstChild.getAttribute!="undefined"&&a.firstChild.getAttribute("href")!=="#"&&(o.attrHandle.href=function(a){return a.getAttribute("href",2)}),a=null}(),c.querySelectorAll&&function(){var a=m,b=c.createElement("div"),d="__sizzle__";b.innerHTML="

";if(!b.querySelectorAll||b.querySelectorAll(".TEST").length!==0){m=function(b,e,f,g){e=e||c;if(!g&&!m.isXML(e)){var h=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h[1])return s(e.getElementsByTagName(b),f);if(h[2]&&o.find.CLASS&&e.getElementsByClassName)return s(e.getElementsByClassName(h[2]),f)}if(e.nodeType===9){if(b==="body"&&e.body)return s([e.body],f);if(h&&h[3]){var i=e.getElementById(h[3]);if(!i||!i.parentNode)return s([],f);if(i.id===h[3])return s([i],f)}try{return s(e.querySelectorAll(b),f)}catch(j){}}else if(e.nodeType===1&&e.nodeName.toLowerCase()!=="object"){var k=e,l=e.getAttribute("id"),n=l||d,p=e.parentNode,q=/^\s*[+~]/.test(b);l?n=n.replace(/'/g,"\\$&"):e.setAttribute("id",n),q&&p&&(e=e.parentNode);try{if(!q||p)return s(e.querySelectorAll("[id='"+n+"'] "+b),f)}catch(r){}finally{l||k.removeAttribute("id")}}}return a(b,e,f,g)};for(var e in a)m[e]=a[e];b=null}}(),function(){var a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector;if(b){var d=!b.call(c.createElement("div"),"div"),e=!1;try{b.call(c.documentElement,"[test!='']:sizzle")}catch(f){e=!0}m.matchesSelector=function(a,c){c=c.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!m.isXML(a))try{if(e||!o.match.PSEUDO.test(c)&&!/!=/.test(c)){var f=b.call(a,c);if(f||!d||a.document&&a.document.nodeType!==11)return f}}catch(g){}return m(c,null,null,[a]).length>0}}}(),function(){var a=c.createElement("div");a.innerHTML="
";if(!!a.getElementsByClassName&&a.getElementsByClassName("e").length!==0){a.lastChild.className="e";if(a.getElementsByClassName("e").length===1)return;o.order.splice(1,0,"CLASS"),o.find.CLASS=function(a,b,c){if(typeof b.getElementsByClassName!="undefined"&&!c)return b.getElementsByClassName(a[1])},a=null}}(),c.documentElement.contains?m.contains=function(a,b){return a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?m.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:m.contains=function(){return!1},m.isXML=function(a){var b=(a?a.ownerDocument||a:0).documentElement;return b?b.nodeName!=="HTML":!1};var y=function(a,b,c){var d,e=[],f="",g=b.nodeType?[b]:b;while(d=o.match.PSEUDO.exec(a))f+=d[0],a=a.replace(o.match.PSEUDO,"");a=o.relative[a]?a+"*":a;for(var h=0,i=g.length;h0)for(h=g;h=0:f.filter(a,this).length>0:this.filter(a).length>0)},closest:function(a,b){var c=[],d,e,g=this[0];if(f.isArray(a)){var h=1;while(g&&g.ownerDocument&&g!==b){for(d=0;d-1:f.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b||g.nodeType===11)break}}c=c.length>1?f.unique(c):c;return this.pushStack(c,"closest",a)},index:function(a){if(!a)return this[0]&&this[0].parentNode?this.prevAll().length:-1;if(typeof a=="string")return f.inArray(this[0],f(a));return f.inArray(a.jquery?a[0]:a,this)},add:function(a,b){var c=typeof a=="string"?f(a,b):f.makeArray(a&&a.nodeType?[a]:a),d=f.merge(this.get(),c);return this.pushStack(S(c[0])||S(d[0])?d:f.unique(d))},andSelf:function(){return this.add(this.prevObject)}}),f.each({parent:function(a){var b=a.parentNode;return b&&b.nodeType!==11?b:null},parents:function(a){return f.dir(a,"parentNode")},parentsUntil:function(a,b,c){return f.dir(a,"parentNode",c)},next:function(a){return f.nth(a,2,"nextSibling")},prev:function(a){return f.nth(a,2,"previousSibling")},nextAll:function(a){return f.dir(a,"nextSibling")},prevAll:function(a){return f.dir(a,"previousSibling")},nextUntil:function(a,b,c){return f.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return f.dir(a,"previousSibling",c)},siblings:function(a){return f.sibling(a.parentNode.firstChild,a)},children:function(a){return f.sibling(a.firstChild)},contents:function(a){return f.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:f.makeArray(a.childNodes)}},function(a,b){f.fn[a]=function(c,d){var e=f.map(this,b,c);L.test(a)||(d=c),d&&typeof d=="string"&&(e=f.filter(d,e)),e=this.length>1&&!R[a]?f.unique(e):e,(this.length>1||N.test(d))&&M.test(a)&&(e=e.reverse());return this.pushStack(e,a,P.call(arguments).join(","))}}),f.extend({filter:function(a,b,c){c&&(a=":not("+a+")");return b.length===1?f.find.matchesSelector(b[0],a)?[b[0]]:[]:f.find.matches(a,b)},dir:function(a,c,d){var e=[],g=a[c];while(g&&g.nodeType!==9&&(d===b||g.nodeType!==1||!f(g).is(d)))g.nodeType===1&&e.push(g),g=g[c];return e},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a[c])if(a.nodeType===1&&++e===b)break;return a},sibling:function(a,b){var c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return c}});var V="abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",W=/ jQuery\d+="(?:\d+|null)"/g,X=/^\s+/,Y=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,Z=/<([\w:]+)/,$=/",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},bh=U(c);bg.optgroup=bg.option,bg.tbody=bg.tfoot=bg.colgroup=bg.caption=bg.thead,bg.th=bg.td,f.support.htmlSerialize||(bg._default=[1,"div
","
"]),f.fn.extend({text:function(a){if(f.isFunction(a))return this.each(function(b){var c=f(this);c.text(a.call(this,b,c.text()))});if(typeof a!="object"&&a!==b)return this.empty().append((this[0]&&this[0].ownerDocument||c).createTextNode(a));return f.text(this)},wrapAll:function(a){if(f.isFunction(a))return this.each(function(b){f(this).wrapAll(a.call(this,b))});if(this[0]){var b=f(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){if(f.isFunction(a))return this.each(function(b){f(this).wrapInner(a.call(this,b))});return this.each(function(){var b=f(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=f.isFunction(a);return this.each(function(c){f(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){f.nodeName(this,"body")||f(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=f.clean(arguments);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,f.clean(arguments));return a}},remove:function(a,b){for(var c=0,d;(d=this[c])!=null;c++)if(!a||f.filter(a,[d]).length)!b&&d.nodeType===1&&(f.cleanData(d.getElementsByTagName("*")),f.cleanData([d])),d.parentNode&&d.parentNode.removeChild(d);return this},empty:function() +{for(var a=0,b;(b=this[a])!=null;a++){b.nodeType===1&&f.cleanData(b.getElementsByTagName("*"));while(b.firstChild)b.removeChild(b.firstChild)}return this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return this.map(function(){return f.clone(this,a,b)})},html:function(a){if(a===b)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(W,""):null;if(typeof a=="string"&&!ba.test(a)&&(f.support.leadingWhitespace||!X.test(a))&&!bg[(Z.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Y,"<$1>");try{for(var c=0,d=this.length;c1&&l0?this.clone(!0):this).get();f(e[h])[b](j),d=d.concat(j)}return this.pushStack(d,a,e.selector)}}),f.extend({clone:function(a,b,c){var d,e,g,h=f.support.html5Clone||!bc.test("<"+a.nodeName)?a.cloneNode(!0):bo(a);if((!f.support.noCloneEvent||!f.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!f.isXMLDoc(a)){bk(a,h),d=bl(a),e=bl(h);for(g=0;d[g];++g)e[g]&&bk(d[g],e[g])}if(b){bj(a,h);if(c){d=bl(a),e=bl(h);for(g=0;d[g];++g)bj(d[g],e[g])}}d=e=null;return h},clean:function(a,b,d,e){var g;b=b||c,typeof b.createElement=="undefined"&&(b=b.ownerDocument||b[0]&&b[0].ownerDocument||c);var h=[],i;for(var j=0,k;(k=a[j])!=null;j++){typeof k=="number"&&(k+="");if(!k)continue;if(typeof k=="string")if(!_.test(k))k=b.createTextNode(k);else{k=k.replace(Y,"<$1>");var l=(Z.exec(k)||["",""])[1].toLowerCase(),m=bg[l]||bg._default,n=m[0],o=b.createElement("div");b===c?bh.appendChild(o):U(b).appendChild(o),o.innerHTML=m[1]+k+m[2];while(n--)o=o.lastChild;if(!f.support.tbody){var p=$.test(k),q=l==="table"&&!p?o.firstChild&&o.firstChild.childNodes:m[1]===""&&!p?o.childNodes:[];for(i=q.length-1;i>=0;--i)f.nodeName(q[i],"tbody")&&!q[i].childNodes.length&&q[i].parentNode.removeChild(q[i])}!f.support.leadingWhitespace&&X.test(k)&&o.insertBefore(b.createTextNode(X.exec(k)[0]),o.firstChild),k=o.childNodes}var r;if(!f.support.appendChecked)if(k[0]&&typeof (r=k.length)=="number")for(i=0;i=0)return b+"px"}}}),f.support.opacity||(f.cssHooks.opacity={get:function(a,b){return br.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?parseFloat(RegExp.$1)/100+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle,e=f.isNumeric(b)?"alpha(opacity="+b*100+")":"",g=d&&d.filter||c.filter||"";c.zoom=1;if(b>=1&&f.trim(g.replace(bq,""))===""){c.removeAttribute("filter");if(d&&!d.filter)return}c.filter=bq.test(g)?g.replace(bq,e):g+" "+e}}),f(function(){f.support.reliableMarginRight||(f.cssHooks.marginRight={get:function(a,b){var c;f.swap(a,{display:"inline-block"},function(){b?c=bz(a,"margin-right","marginRight"):c=a.style.marginRight});return c}})}),c.defaultView&&c.defaultView.getComputedStyle&&(bA=function(a,b){var c,d,e;b=b.replace(bs,"-$1").toLowerCase(),(d=a.ownerDocument.defaultView)&&(e=d.getComputedStyle(a,null))&&(c=e.getPropertyValue(b),c===""&&!f.contains(a.ownerDocument.documentElement,a)&&(c=f.style(a,b)));return c}),c.documentElement.currentStyle&&(bB=function(a,b){var c,d,e,f=a.currentStyle&&a.currentStyle[b],g=a.style;f===null&&g&&(e=g[b])&&(f=e),!bt.test(f)&&bu.test(f)&&(c=g.left,d=a.runtimeStyle&&a.runtimeStyle.left,d&&(a.runtimeStyle.left=a.currentStyle.left),g.left=b==="fontSize"?"1em":f||0,f=g.pixelLeft+"px",g.left=c,d&&(a.runtimeStyle.left=d));return f===""?"auto":f}),bz=bA||bB,f.expr&&f.expr.filters&&(f.expr.filters.hidden=function(a){var b=a.offsetWidth,c=a.offsetHeight;return b===0&&c===0||!f.support.reliableHiddenOffsets&&(a.style&&a.style.display||f.css(a,"display"))==="none"},f.expr.filters.visible=function(a){return!f.expr.filters.hidden(a)});var bD=/%20/g,bE=/\[\]$/,bF=/\r?\n/g,bG=/#.*$/,bH=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,bI=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bJ=/^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,bK=/^(?:GET|HEAD)$/,bL=/^\/\//,bM=/\?/,bN=/)<[^<]*)*<\/script>/gi,bO=/^(?:select|textarea)/i,bP=/\s+/,bQ=/([?&])_=[^&]*/,bR=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,bS=f.fn.load,bT={},bU={},bV,bW,bX=["*/"]+["*"];try{bV=e.href}catch(bY){bV=c.createElement("a"),bV.href="",bV=bV.href}bW=bR.exec(bV.toLowerCase())||[],f.fn.extend({load:function(a,c,d){if(typeof a!="string"&&bS)return bS.apply(this,arguments);if(!this.length)return this;var e=a.indexOf(" ");if(e>=0){var g=a.slice(e,a.length);a=a.slice(0,e)}var h="GET";c&&(f.isFunction(c)?(d=c,c=b):typeof c=="object"&&(c=f.param(c,f.ajaxSettings.traditional),h="POST"));var i=this;f.ajax({url:a,type:h,dataType:"html",data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?f("
").append(c.replace(bN,"")).find(g):c)),d&&i.each(d,[c,b,a])}});return this},serialize:function(){return f.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?f.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||bO.test(this.nodeName)||bI.test(this.type))}).map(function(a,b){var c=f(this).val();return c==null?null:f.isArray(c)?f.map(c,function(a,c){return{name:b.name,value:a.replace(bF,"\r\n")}}):{name:b.name,value:c.replace(bF,"\r\n")}}).get()}}),f.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){f.fn[b]=function(a){return this.on(b,a)}}),f.each(["get","post"],function(a,c){f[c]=function(a,d,e,g){f.isFunction(d)&&(g=g||e,e=d,d=b);return f.ajax({type:c,url:a,data:d,success:e,dataType:g})}}),f.extend({getScript:function(a,c){return f.get(a,b,c,"script")},getJSON:function(a,b,c){return f.get(a,b,c,"json")},ajaxSetup:function(a,b){b?b_(a,f.ajaxSettings):(b=a,a=f.ajaxSettings),b_(a,b);return a},ajaxSettings:{url:bV,isLocal:bJ.test(bW[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":bX},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":f.parseJSON,"text xml":f.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:bZ(bT),ajaxTransport:bZ(bU),ajax:function(a,c){function w(a,c,l,m){if(s!==2){s=2,q&&clearTimeout(q),p=b,n=m||"",v.readyState=a>0?4:0;var o,r,u,w=c,x=l?cb(d,v,l):b,y,z;if(a>=200&&a<300||a===304){if(d.ifModified){if(y=v.getResponseHeader("Last-Modified"))f.lastModified[k]=y;if(z=v.getResponseHeader("Etag"))f.etag[k]=z}if(a===304)w="notmodified",o=!0;else try{r=cc(d,x),w="success",o=!0}catch(A){w="parsererror",u=A}}else{u=w;if(!w||a)w="error",a<0&&(a=0)}v.status=a,v.statusText=""+(c||w),o?h.resolveWith(e,[r,w,v]):h.rejectWith(e,[v,w,u]),v.statusCode(j),j=b,t&&g.trigger("ajax"+(o?"Success":"Error"),[v,d,o?r:u]),i.fireWith(e,[v,w]),t&&(g.trigger("ajaxComplete",[v,d]),--f.active||f.event.trigger("ajaxStop"))}}typeof a=="object"&&(c=a,a=b),c=c||{};var d=f.ajaxSetup({},c),e=d.context||d,g=e!==d&&(e.nodeType||e instanceof f)?f(e):f.event,h=f.Deferred(),i=f.Callbacks("once memory"),j=d.statusCode||{},k,l={},m={},n,o,p,q,r,s=0,t,u,v={readyState:0,setRequestHeader:function(a,b){if(!s){var c=a.toLowerCase();a=m[c]=m[c]||a,l[a]=b}return this},getAllResponseHeaders:function(){return s===2?n:null},getResponseHeader:function(a){var c;if(s===2){if(!o){o={};while(c=bH.exec(n))o[c[1].toLowerCase()]=c[2]}c=o[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){s||(d.mimeType=a);return this},abort:function(a){a=a||"abort",p&&p.abort(a),w(0,a);return this}};h.promise(v),v.success=v.done,v.error=v.fail,v.complete=i.add,v.statusCode=function(a){if(a){var b;if(s<2)for(b in a)j[b]=[j[b],a[b]];else b=a[v.status],v.then(b,b)}return this},d.url=((a||d.url)+"").replace(bG,"").replace(bL,bW[1]+"//"),d.dataTypes=f.trim(d.dataType||"*").toLowerCase().split(bP),d.crossDomain==null&&(r=bR.exec(d.url.toLowerCase()),d.crossDomain=!(!r||r[1]==bW[1]&&r[2]==bW[2]&&(r[3]||(r[1]==="http:"?80:443))==(bW[3]||(bW[1]==="http:"?80:443)))),d.data&&d.processData&&typeof d.data!="string"&&(d.data=f.param(d.data,d.traditional)),b$(bT,d,c,v);if(s===2)return!1;t=d.global,d.type=d.type.toUpperCase(),d.hasContent=!bK.test(d.type),t&&f.active++===0&&f.event.trigger("ajaxStart");if(!d.hasContent){d.data&&(d.url+=(bM.test(d.url)?"&":"?")+d.data,delete d.data),k=d.url;if(d.cache===!1){var x=f.now(),y=d.url.replace(bQ,"$1_="+x);d.url=y+(y===d.url?(bM.test(d.url)?"&":"?")+"_="+x:"")}}(d.data&&d.hasContent&&d.contentType!==!1||c.contentType)&&v.setRequestHeader("Content-Type",d.contentType),d.ifModified&&(k=k||d.url,f.lastModified[k]&&v.setRequestHeader("If-Modified-Since",f.lastModified[k]),f.etag[k]&&v.setRequestHeader("If-None-Match",f.etag[k])),v.setRequestHeader("Accept",d.dataTypes[0]&&d.accepts[d.dataTypes[0]]?d.accepts[d.dataTypes[0]]+(d.dataTypes[0]!=="*"?", "+bX+"; q=0.01":""):d.accepts["*"]);for(u in d.headers)v.setRequestHeader(u,d.headers[u]);if(d.beforeSend&&(d.beforeSend.call(e,v,d)===!1||s===2)){v.abort();return!1}for(u in{success:1,error:1,complete:1})v[u](d[u]);p=b$(bU,d,c,v);if(!p)w(-1,"No Transport");else{v.readyState=1,t&&g.trigger("ajaxSend",[v,d]),d.async&&d.timeout>0&&(q=setTimeout(function(){v.abort("timeout")},d.timeout));try{s=1,p.send(l,w)}catch(z){if(s<2)w(-1,z);else throw z}}return v},param:function(a,c){var d=[],e=function(a,b){b=f.isFunction(b)?b():b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=f.ajaxSettings.traditional);if(f.isArray(a)||a.jquery&&!f.isPlainObject(a))f.each(a,function(){e(this.name,this.value)});else for(var g in a)ca(g,a[g],c,e);return d.join("&").replace(bD,"+")}}),f.extend({active:0,lastModified:{},etag:{}});var cd=f.now(),ce=/(\=)\?(&|$)|\?\?/i;f.ajaxSetup({jsonp:"callback",jsonpCallback:function(){return f.expando+"_"+cd++}}),f.ajaxPrefilter("json jsonp",function(b,c,d){var e=b.contentType==="application/x-www-form-urlencoded"&&typeof b.data=="string";if(b.dataTypes[0]==="jsonp"||b.jsonp!==!1&&(ce.test(b.url)||e&&ce.test(b.data))){var g,h=b.jsonpCallback=f.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a[h],j=b.url,k=b.data,l="$1"+h+"$2";b.jsonp!==!1&&(j=j.replace(ce,l),b.url===j&&(e&&(k=k.replace(ce,l)),b.data===k&&(j+=(/\?/.test(j)?"&":"?")+b.jsonp+"="+h))),b.url=j,b.data=k,a[h]=function(a){g=[a]},d.always(function(){a[h]=i,g&&f.isFunction(i)&&a[h](g[0])}),b.converters["script json"]=function(){g||f.error(h+" was not called");return g[0]},b.dataTypes[0]="json";return"script"}}),f.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){f.globalEval(a);return a}}}),f.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),f.ajaxTransport("script",function(a){if(a.crossDomain){var d,e=c.head||c.getElementsByTagName("head")[0]||c.documentElement;return{send:function(f,g){d=c.createElement("script"),d.async="async",a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(c||!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,"success")},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var cf=a.ActiveXObject?function(){for(var a in ch)ch[a](0,1)}:!1,cg=0,ch;f.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&ci()||cj()}:ci,function(a){f.extend(f.support,{ajax:!!a,cors:!!a&&"withCredentials"in a})}(f.ajaxSettings.xhr()),f.support.ajax&&f.ajaxTransport(function(c){if(!c.crossDomain||f.support.cors){var d;return{send:function(e,g){var h=c.xhr(),i,j;c.username?h.open(c.type,c.url,c.async,c.username,c.password):h.open(c.type,c.url,c.async);if(c.xhrFields)for(j in c.xhrFields)h[j]=c.xhrFields[j];c.mimeType&&h.overrideMimeType&&h.overrideMimeType(c.mimeType),!c.crossDomain&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(j in e)h.setRequestHeader(j,e[j])}catch(k){}h.send(c.hasContent&&c.data||null),d=function(a,e){var j,k,l,m,n;try{if(d&&(e||h.readyState===4)){d=b,i&&(h.onreadystatechange=f.noop,cf&&delete ch[i]);if(e)h.readyState!==4&&h.abort();else{j=h.status,l=h.getAllResponseHeaders(),m={},n=h.responseXML,n&&n.documentElement&&(m.xml=n),m.text=h.responseText;try{k=h.statusText}catch(o){k=""}!j&&c.isLocal&&!c.crossDomain?j=m.text?200:404:j===1223&&(j=204)}}}catch(p){e||g(-1,p)}m&&g(j,k,m,l)},!c.async||h.readyState===4?d():(i=++cg,cf&&(ch||(ch={},f(a).unload(cf)),ch[i]=d),h.onreadystatechange=d)},abort:function(){d&&d(0,1)}}}});var ck={},cl,cm,cn=/^(?:toggle|show|hide)$/,co=/^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,cp,cq=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]],cr;f.fn.extend({show:function(a,b,c){var d,e;if(a||a===0)return this.animate(cu("show",3),a,b,c);for(var g=0,h=this.length;g=i.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),i.animatedProperties[this.prop]=!0;for(b in i.animatedProperties)i.animatedProperties[b]!==!0&&(g=!1);if(g){i.overflow!=null&&!f.support.shrinkWrapBlocks&&f.each(["","X","Y"],function(a,b){h.style["overflow"+b]=i.overflow[a]}),i.hide&&f(h).hide();if(i.hide||i.show)for(b in i.animatedProperties)f.style(h,b,i.orig[b]),f.removeData(h,"fxshow"+b,!0),f.removeData(h,"toggle"+b,!0);d=i.complete,d&&(i.complete=!1,d.call(h))}return!1}i.duration==Infinity?this.now=e:(c=e-this.startTime,this.state=c/i.duration,this.pos=f.easing[i.animatedProperties[this.prop]](this.state,c,0,1,i.duration),this.now=this.start+(this.end-this.start)*this.pos),this.update();return!0}},f.extend(f.fx,{tick:function(){var a,b=f.timers,c=0;for(;c-1,k={},l={},m,n;j?(l=e.position(),m=l.top,n=l.left):(m=parseFloat(h)||0,n=parseFloat(i)||0),f.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):e.css(k)}},f.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),d=cx.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(f.css(a,"marginTop"))||0,c.left-=parseFloat(f.css(a,"marginLeft"))||0,d.top+=parseFloat(f.css(b[0],"borderTopWidth"))||0,d.left+=parseFloat(f.css(b[0],"borderLeftWidth"))||0;return{top:c.top-d.top,left:c.left-d.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&!cx.test(a.nodeName)&&f.css(a,"position")==="static")a=a.offsetParent;return a})}}),f.each(["Left","Top"],function(a,c){var d="scroll"+c;f.fn[d]=function(c){var e,g;if(c===b){e=this[0];if(!e)return null;g=cy(e);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:f.support.boxModel&&g.document.documentElement[d]||g.document.body[d]:e[d]}return this.each(function(){g=cy(this),g?g.scrollTo(a?f(g).scrollLeft():c,a?c:f(g).scrollTop()):this[d]=c})}}),f.each(["Height","Width"],function(a,c){var d=c.toLowerCase();f.fn["inner"+c]=function(){var a=this[0];return a?a.style?parseFloat(f.css(a,d,"padding")):this[d]():null},f.fn["outer"+c]=function(a){var b=this[0];return b?b.style?parseFloat(f.css(b,d,a?"margin":"border")):this[d]():null},f.fn[d]=function(a){var e=this[0];if(!e)return a==null?null:this;if(f.isFunction(a))return this.each(function(b){var c=f(this);c[d](a.call(this,b,c[d]()))});if(f.isWindow(e)){var g=e.document.documentElement["client"+c],h=e.document.body;return e.document.compatMode==="CSS1Compat"&&g||h&&h["client"+c]||g}if(e.nodeType===9)return Math.max(e.documentElement["client"+c],e.body["scroll"+c],e.documentElement["scroll"+c],e.body["offset"+c],e.documentElement["offset"+c]);if(a===b){var i=f.css(e,d),j=parseFloat(i);return f.isNumeric(j)?j:i}return this.css(d,typeof a=="string"?a:a+"px")}}),a.jQuery=a.$=f,typeof define=="function"&&define.amd&&define.amd.jQuery&&define("jquery",[],function(){return f})})(window); \ No newline at end of file diff --git a/method_list.html b/method_list.html new file mode 100644 index 0000000..3ba44b9 --- /dev/null +++ b/method_list.html @@ -0,0 +1,357 @@ + + + + + + + + + + + + + + + + + Method List + + + + +
+

Method List

+ + + + +
+ + diff --git a/top-level-namespace.html b/top-level-namespace.html new file mode 100644 index 0000000..969a897 --- /dev/null +++ b/top-level-namespace.html @@ -0,0 +1,114 @@ + + + + + + Top Level Namespace + + — Documentation by YARD 0.8.7.6 + + + + + + + + + + + + + + + + + + + + + +

Top Level Namespace + + + +

+ +
+ + + + + + + + +
+
+ +

Defined Under Namespace

+

+ + + Modules: TXTextControl + + + + Classes: String + + +

+ + + + + + + + + +
+ + + + + \ No newline at end of file From 5b0ca2d73c87632dd495d894f12d56424c888985 Mon Sep 17 00:00:00 2001 From: Thorsten Kummerow Date: Mon, 6 Jun 2016 16:02:18 +0200 Subject: [PATCH 02/13] Minor change in README. --- String.html | 2 +- TXTextControl.html | 2 +- TXTextControl/ReportingCloud.html | 2 +- .../ReportingCloud/AccountSettings.html | 2 +- TXTextControl/ReportingCloud/MergeBody.html | 32 ++++++++----------- .../ReportingCloud/MergeSettings.html | 6 ++-- .../ReportingCloud/ReportingCloud.html | 2 +- TXTextControl/ReportingCloud/Template.html | 2 +- .../ReportingCloud/TemplateDataValidator.html | 2 +- .../ReportingCloud/TemplateNameValidator.html | 2 +- _index.html | 2 +- file.README.html | 4 +-- index.html | 4 +-- top-level-namespace.html | 2 +- 14 files changed, 30 insertions(+), 36 deletions(-) diff --git a/String.html b/String.html index de83dfc..070942b 100644 --- a/String.html +++ b/String.html @@ -248,7 +248,7 @@

diff --git a/TXTextControl.html b/TXTextControl.html index bd09d2e..d102da3 100644 --- a/TXTextControl.html +++ b/TXTextControl.html @@ -132,7 +132,7 @@

Overview

diff --git a/TXTextControl/ReportingCloud.html b/TXTextControl/ReportingCloud.html index 40b4ce9..530e63e 100644 --- a/TXTextControl/ReportingCloud.html +++ b/TXTextControl/ReportingCloud.html @@ -179,7 +179,7 @@

Constant Summary

diff --git a/TXTextControl/ReportingCloud/AccountSettings.html b/TXTextControl/ReportingCloud/AccountSettings.html index a855507..92e18c7 100644 --- a/TXTextControl/ReportingCloud/AccountSettings.html +++ b/TXTextControl/ReportingCloud/AccountSettings.html @@ -1045,7 +1045,7 @@

diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html index ab6bf15..0fa9081 100644 --- a/TXTextControl/ReportingCloud/MergeBody.html +++ b/TXTextControl/ReportingCloud/MergeBody.html @@ -369,23 +369,17 @@ 

 
 
+38
 39
 40
 41
-42
-43
-44
-45
-46
+42

@@ -247,11 +247,12 @@

- \ No newline at end of file diff --git a/TXTextControl.html b/TXTextControl.html index 53683ac..dcd2904 100644 --- a/TXTextControl.html +++ b/TXTextControl.html @@ -1,12 +1,12 @@ - - + + - + + Module: TXTextControl - — Documentation by YARD 0.8.7.6 + — Documentation by YARD 0.9.8 @@ -15,9 +15,8 @@ @@ -28,63 +27,63 @@ -

@@ -580,7 +580,7 @@

Instance Attribute Details

- - (Integer) created_documents (readonly) + #created_documents ⇒ Integer (readonly) @@ -641,7 +641,7 @@

- - (Integer) max_documents (readonly) + #max_documents ⇒ Integer (readonly) @@ -702,7 +702,7 @@

- - (Integer) max_templates (readonly) + #max_templates ⇒ Integer (readonly) @@ -764,7 +764,7 @@

- - (String, Symbol) serial_number (readonly) + #serial_number ⇒ String, Symbol (readonly) @@ -827,7 +827,7 @@

- - (Integer) uploaded_templates (readonly) + #uploaded_templates ⇒ Integer (readonly) @@ -888,7 +888,7 @@

- - (DateTime) valid_until (readonly) + #valid_until ⇒ DateTime (readonly) @@ -954,7 +954,7 @@

Class Method Details

- + (AccountSettings) from_camelized_hash(hash) + .from_camelized_hash(hash) ⇒ AccountSettings @@ -1028,14 +1028,14 @@

@@ -1046,11 +1046,12 @@

- \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/FindAndReplaceBody.html b/TXTextControl/ReportingCloud/FindAndReplaceBody.html new file mode 100644 index 0000000..cd124a6 --- /dev/null +++ b/TXTextControl/ReportingCloud/FindAndReplaceBody.html @@ -0,0 +1,654 @@ + + + + + + + Class: TXTextControl::ReportingCloud::FindAndReplaceBody + + — Documentation by YARD 0.9.8 + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + +

Class: TXTextControl::ReportingCloud::FindAndReplaceBody + + + +

+
+ +
+
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+
+ + + + + + + + + + + +
+
Defined in:
+
lib/txtextcontrol/reportingcloud/find_and_replace_body.rb
+
+ +
+ +

Overview

+
+ +

The request body of requests to the endpoint “/document/findandreplace”. +Contains an array of string arrays, a template encoded as a Base64 string +and a ReportingCloud MergeSettings object.

+ + +
+
+
+ + +
+ + + +

Instance Attribute Summary collapse

+ + + + + + +

+ Instance Method Summary + collapse +

+ + + + +
+

Constructor Details

+ +
+

+ + #initialize(find_and_replace_data, template = nil, merge_settings = nil) ⇒ FindAndReplaceBody + + + + + +

+
+ +

Executes a find and replace on a template.

+ + +
+
+
+

Parameters:

+
    + +
  • + + find_and_replace_data + + + (Array<Array<String>>) + + + + — +
    +

    The find and replace pair values as an array of string arrays.

    +
    + +
    • + +
  • + + template + + + (String) + + + (defaults to: nil) + + + — +
    +

    The source document encoded as a Base64 string. The supported document +formats are .rtf, .doc, .docx, and +.tx.

    +
    + +
    • + +
  • + + merge_settings + + + (MergeSettings) + + + (defaults to: nil) + + + — +
    +

    Merge settings to specify merge properties and document properties such as +title and author.

    +
    + +
    • + +
+ + +

- 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 39
+      
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 38
 
 def initialize(merge_data, merge_settings = nil, template = nil)
-  unless merge_data.kind_of?(Array) && !merge_data.empty? && merge_data[0].kind_of?(Hash)
-    raise ArgumentError, "Merge data must be a non empty array of hashes."
-  end
-  @merge_data = merge_data
+  self.merge_data = merge_data
   @template = template
   @merge_settings = merge_settings
 end

@@ -636,16 +630,16 @@ 

       
 
 
-51
-52
-53
-54
-55
-56
-57

+58
+59
+60
+61
+62
+63
+64
 - 
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 51
+      
# File 'lib/txtextcontrol/reportingcloud/merge_body.rb', line 58
 
 def to_camelized_hash
   return {
@@ -664,7 +658,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeSettings.html b/TXTextControl/ReportingCloud/MergeSettings.html
index cc844de..f0e6260 100644
--- a/TXTextControl/ReportingCloud/MergeSettings.html
+++ b/TXTextControl/ReportingCloud/MergeSettings.html
@@ -1323,11 +1323,11 @@ 

     "removeEmptyImages" => @remove_empty_images,
     "removeTrailingWhitespace" => @remove_trailing_whitespace,
     "author" => @author,
-    "creationDate" => @creation_date.nil? ? nil : creation_date.iso8601,
+    "creationDate" => @creation_date.nil? ? nil : @creation_date.iso8601,
     "creatorApplication" => @creator_application,
     "documentSubject" => @document_subject,
     "documentTitle" => @document_title,
-    "lastModificationDate" => @last_modification_date.nil? ? nil : last_modification_date.iso8601,
+    "lastModificationDate" => @last_modification_date.nil? ? nil : @last_modification_date.iso8601,
     "userPassword" => @user_password
   }
 end

@@ -1341,7 +1341,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/ReportingCloud.html b/TXTextControl/ReportingCloud/ReportingCloud.html
index e776f5c..fe35efb 100644
--- a/TXTextControl/ReportingCloud/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud/ReportingCloud.html
@@ -2170,7 +2170,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/Template.html b/TXTextControl/ReportingCloud/Template.html
index 358fa09..82d4dcf 100644
--- a/TXTextControl/ReportingCloud/Template.html
+++ b/TXTextControl/ReportingCloud/Template.html
@@ -510,7 +510,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/TemplateDataValidator.html b/TXTextControl/ReportingCloud/TemplateDataValidator.html
index ce70502..aa45919 100644
--- a/TXTextControl/ReportingCloud/TemplateDataValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateDataValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/TemplateNameValidator.html b/TXTextControl/ReportingCloud/TemplateNameValidator.html
index aa83b14..22d3f9e 100644
--- a/TXTextControl/ReportingCloud/TemplateNameValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateNameValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/_index.html b/_index.html
index 744c16f..0530bf3 100644
--- a/_index.html
+++ b/_index.html
@@ -194,7 +194,7 @@ 
Namespace Listing A-Z

 
 
     
diff --git a/file.README.html b/file.README.html
index 07bc548..97fba18 100644
--- a/file.README.html
+++ b/file.README.html
@@ -105,7 +105,7 @@ 
API documentation (YARD)

 
$ yard doc

 
 
The resultant set of HTML files will be written to
-~/txtextcontrol-reportingcloud/doc.

+~/txtextcontrol-reportingcloud-ruby/doc.

 
 
If you don't have YARD already installed, you can install it with
 RubyGems with the following command:

@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/index.html b/index.html
index 07bc548..97fba18 100644
--- a/index.html
+++ b/index.html
@@ -105,7 +105,7 @@ 
API documentation (YARD)

 
$ yard doc

 
 
The resultant set of HTML files will be written to
-~/txtextcontrol-reportingcloud/doc.

+~/txtextcontrol-reportingcloud-ruby/doc.

 
 
If you don't have YARD already installed, you can install it with
 RubyGems with the following command:

@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/top-level-namespace.html b/top-level-namespace.html
index 969a897..362899e 100644
--- a/top-level-namespace.html
+++ b/top-level-namespace.html
@@ -105,7 +105,7 @@ 
Defined Under Namespace

 
 
     

From 8c3b66eb07f6d136d3edd12d624818ffce227382 Mon Sep 17 00:00:00 2001
From: Thorsten Kummerow 
Date: Mon, 6 Jun 2016 16:22:31 +0200
Subject: [PATCH 03/13] Adding inline formatting in some places.

---
 String.html                                   |  2 +-
 TXTextControl.html                            |  2 +-
 TXTextControl/ReportingCloud.html             |  2 +-
 .../ReportingCloud/AccountSettings.html       |  8 ++--
 TXTextControl/ReportingCloud/MergeBody.html   |  2 +-
 .../ReportingCloud/MergeSettings.html         |  2 +-
 .../ReportingCloud/ReportingCloud.html        | 43 +++++++++++--------
 TXTextControl/ReportingCloud/Template.html    |  2 +-
 .../ReportingCloud/TemplateDataValidator.html |  2 +-
 .../ReportingCloud/TemplateNameValidator.html |  2 +-
 _index.html                                   |  2 +-
 file.README.html                              |  2 +-
 index.html                                    |  2 +-
 top-level-namespace.html                      |  2 +-
 14 files changed, 41 insertions(+), 34 deletions(-)

diff --git a/String.html b/String.html
index 070942b..63d7b68 100644
--- a/String.html
+++ b/String.html
@@ -248,7 +248,7 @@ 

 
 
     
diff --git a/TXTextControl.html b/TXTextControl.html
index d102da3..574b2d2 100644
--- a/TXTextControl.html
+++ b/TXTextControl.html
@@ -132,7 +132,7 @@ 
Overview

 

 
     
diff --git a/TXTextControl/ReportingCloud.html b/TXTextControl/ReportingCloud.html
index 530e63e..809d7bf 100644
--- a/TXTextControl/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud.html
@@ -179,7 +179,7 @@ 
Constant Summary

 
 
     
diff --git a/TXTextControl/ReportingCloud/AccountSettings.html b/TXTextControl/ReportingCloud/AccountSettings.html
index 92e18c7..7e410fc 100644
--- a/TXTextControl/ReportingCloud/AccountSettings.html
+++ b/TXTextControl/ReportingCloud/AccountSettings.html
@@ -419,7 +419,8 @@ 

         —
         

 
The serial number that is attached to the  account. Possible values are
-:free, :trial and a 13 character long serial number.

+:free, :trial and a 13 character long serial
+number.

 

       
     
@@ -773,7 +774,8 @@ 

   

     
 
The serial number that is attached to the  account. Possible values are
-:free, :trial and a 13 character long serial number.

+:free, :trial and a 13 character long serial
+number.

 
 
   

@@ -1045,7 +1047,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html
index 0fa9081..928cb88 100644
--- a/TXTextControl/ReportingCloud/MergeBody.html
+++ b/TXTextControl/ReportingCloud/MergeBody.html
@@ -658,7 +658,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeSettings.html b/TXTextControl/ReportingCloud/MergeSettings.html
index f0e6260..696ebc7 100644
--- a/TXTextControl/ReportingCloud/MergeSettings.html
+++ b/TXTextControl/ReportingCloud/MergeSettings.html
@@ -1341,7 +1341,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/ReportingCloud.html b/TXTextControl/ReportingCloud/ReportingCloud.html
index fe35efb..e096a8c 100644
--- a/TXTextControl/ReportingCloud/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud/ReportingCloud.html
@@ -566,8 +566,8 @@ 

 
   
     

-
Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf
-and *.tx).

+
Stores an uploaded template in the template storage ( *.doc, *.docx,
+*.rtf and *.tx).

 

   
 
@@ -645,8 +645,8 @@ 

       
         —
         

-
The API base url. Is set to “api.reporting.cloud”  by default.

+
The API base url. Is set to “http://api.reporting.cloud”  by
+default.

 

       
     
@@ -704,7 +704,7 @@ 

 

   

     
-
The API version. Is set to “v1” by default.

+
The API version. Is set to “v1” by default.

 
 
   

@@ -765,8 +765,8 @@ 

 

   

     
-
The API base url. Is set to “api.reporting.cloud”  by default.

+
The API base url. Is set to “http://api.reporting.cloud”  by
+default.

 
 
   

@@ -888,7 +888,8 @@ 

 

   

     
-
The timeout for HTTP requests in seconds. Is set to 10 by default.

+
The timeout for HTTP requests in seconds. Is set to 10 by
+default.

 
 
   

@@ -1036,7 +1037,8 @@ 

         —
         

 
The source document encoded as a Base64 string.  The supported document
-formats are .rtf, .doc, .docx, .html, .pdf and .tx.

+formats are .rtf, .doc, .docx,
+.html, .pdf and .tx.

 

       
     
@@ -1054,8 +1056,9 @@ 

       
         —
         

-
The format of the created document. Possible values are: :pdf, :rtf, :doc,
-:docx, :html and :tx.

+
The format of the created document. Possible values are: :pdf,
+:rtf, :doc, :docx,
+:html and :tx.

 

       
     
@@ -1572,8 +1575,8 @@ 

       
         —
         

-
An Integer value between 1 and 400 to set the percentage zoom factor of the
-created thumbnail images.

+
An Integer value between 1 and 400 to set the
+percentage zoom factor of the created thumbnail images.

 

       
     
@@ -1628,7 +1631,8 @@ 

         —
         

 
Defines the image format of the returned thumbnails. Possible values are
-:png, :jpg, :gif and :bmp.

+:png, :jpg, :gif and
+:bmp.

 

       
     
@@ -1823,8 +1827,9 @@ 

       
         —
         

-
The format of the created document. Possible  values are :pdf, :rtf, :doc,
-:docx, :html and :tx.

+
The format of the created document. Possible  values are :pdf,
+:rtf, :doc, :docx,
+:html and :tx.

 

       
     
@@ -2083,8 +2088,8 @@ 

 

   

     
This method returns an undefined value.

-
Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf
-and *.tx)

+
Stores an uploaded template in the template storage ( *.doc, *.docx,
+*.rtf and *.tx)

 
 
   

@@ -2170,7 +2175,7 @@ 

 

 
     
diff --git a/TXTextControl/ReportingCloud/Template.html b/TXTextControl/ReportingCloud/Template.html
index 82d4dcf..039faac 100644
--- a/TXTextControl/ReportingCloud/Template.html
+++ b/TXTextControl/ReportingCloud/Template.html
@@ -510,7 +510,7 @@ 

 

 
     
diff --git a/TXTextControl/ReportingCloud/TemplateDataValidator.html b/TXTextControl/ReportingCloud/TemplateDataValidator.html
index aa45919..f5a644a 100644
--- a/TXTextControl/ReportingCloud/TemplateDataValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateDataValidator.html
@@ -268,7 +268,7 @@ 

 

 
     
diff --git a/TXTextControl/ReportingCloud/TemplateNameValidator.html b/TXTextControl/ReportingCloud/TemplateNameValidator.html
index 22d3f9e..ac1188f 100644
--- a/TXTextControl/ReportingCloud/TemplateNameValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateNameValidator.html
@@ -268,7 +268,7 @@ 

 

 
     
diff --git a/_index.html b/_index.html
index 0530bf3..88a9de5 100644
--- a/_index.html
+++ b/_index.html
@@ -194,7 +194,7 @@ 
Namespace Listing A-Z

 
 
     
diff --git a/file.README.html b/file.README.html
index 97fba18..a8669ee 100644
--- a/file.README.html
+++ b/file.README.html
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/index.html b/index.html
index 97fba18..a8669ee 100644
--- a/index.html
+++ b/index.html
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/top-level-namespace.html b/top-level-namespace.html
index 362899e..336c549 100644
--- a/top-level-namespace.html
+++ b/top-level-namespace.html
@@ -105,7 +105,7 @@ 
Defined Under Namespace

 
 
     

From abfba27d10fd504e06f3ce32050dbe377a9b0f9c Mon Sep 17 00:00:00 2001
From: Thorsten Kummerow 
Date: Fri, 10 Jun 2016 17:35:55 +0200
Subject: [PATCH 04/13] Updating API documentation.

---
 String.html                                   |  2 +-
 TXTextControl.html                            |  2 +-
 TXTextControl/ReportingCloud.html             |  2 +-
 .../ReportingCloud/AccountSettings.html       |  2 +-
 TXTextControl/ReportingCloud/MergeBody.html   |  2 +-
 .../ReportingCloud/MergeSettings.html         |  2 +-
 .../ReportingCloud/ReportingCloud.html        | 62 ++++++++++---------
 TXTextControl/ReportingCloud/Template.html    | 28 +++++----
 .../ReportingCloud/TemplateDataValidator.html |  2 +-
 .../ReportingCloud/TemplateNameValidator.html |  2 +-
 _index.html                                   |  2 +-
 file.README.html                              |  2 +-
 index.html                                    |  2 +-
 top-level-namespace.html                      |  2 +-
 14 files changed, 61 insertions(+), 53 deletions(-)

diff --git a/String.html b/String.html
index 63d7b68..acc1cbb 100644
--- a/String.html
+++ b/String.html
@@ -248,7 +248,7 @@ 

 
 
     
diff --git a/TXTextControl.html b/TXTextControl.html
index 574b2d2..3038585 100644
--- a/TXTextControl.html
+++ b/TXTextControl.html
@@ -132,7 +132,7 @@ 
Overview

 

 
     
diff --git a/TXTextControl/ReportingCloud.html b/TXTextControl/ReportingCloud.html
index 809d7bf..b0775cf 100644
--- a/TXTextControl/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud.html
@@ -179,7 +179,7 @@ 
Constant Summary

 
 
     
diff --git a/TXTextControl/ReportingCloud/AccountSettings.html b/TXTextControl/ReportingCloud/AccountSettings.html
index 7e410fc..5ee2993 100644
--- a/TXTextControl/ReportingCloud/AccountSettings.html
+++ b/TXTextControl/ReportingCloud/AccountSettings.html
@@ -1047,7 +1047,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html
index 928cb88..f648938 100644
--- a/TXTextControl/ReportingCloud/MergeBody.html
+++ b/TXTextControl/ReportingCloud/MergeBody.html
@@ -658,7 +658,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeSettings.html b/TXTextControl/ReportingCloud/MergeSettings.html
index 696ebc7..d0456da 100644
--- a/TXTextControl/ReportingCloud/MergeSettings.html
+++ b/TXTextControl/ReportingCloud/MergeSettings.html
@@ -1341,7 +1341,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/ReportingCloud.html b/TXTextControl/ReportingCloud/ReportingCloud.html
index e096a8c..6729ce4 100644
--- a/TXTextControl/ReportingCloud/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud/ReportingCloud.html
@@ -1090,7 +1090,6 @@ 

       
 
 
-253
 254
 255
 256
@@ -1102,10 +1101,11 @@ 

 262
 263
 264
-265

+265
+266
 - 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 253
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 254
 
 def convert_document(template_data, return_format = :pdf)
   # Parameter validation
@@ -1171,7 +1171,6 @@ 

       
 
 
-166
 167
 168
 169
@@ -1179,10 +1178,11 @@ 

 171
 172
 173
-174

+174
+175
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 166
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 167
 
 def delete_template(template_name)
   # Parameter validation
@@ -1262,7 +1262,6 @@ 

       
 
 
-196
 197
 198
 199
@@ -1272,10 +1271,11 @@ 

 203
 204
 205
-206

+206
+207
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 196
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 197
 
 def download_template(template_name)
   # Parameter validation
@@ -1337,17 +1337,17 @@ 

       
 
 
-123
 124
 125
 126
 127
 128
 129
-130

+130
+131
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 123
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 124
 
 def 
   res = request("/account/settings", :get)
@@ -1496,7 +1496,6 @@ 

       
 
 
-235
 236
 237
 238
@@ -1506,10 +1505,11 @@ 

 242
 243
 244
-245

+245
+246
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 235
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 236
 
 def get_template_page_count(template_name)
   # Parameter validation
@@ -1664,7 +1664,6 @@ 

       
 
 
-141
 142
 143
 144
@@ -1683,10 +1682,11 @@ 

 157
 158
 159
-160

+160
+161
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 141
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 142
 
 def get_template_thumbnails(template_name, zoom_factor, from_page = 1, to_page = 0, image_format = :png)
   # Prepare query parameters
@@ -1882,6 +1882,12 @@ 

         (defaults to: false)
       
       
+        —
+        

+
Specifies whether the documents should be appened  to one resulting
+document when more than 1 data row is passed.

+

+      
     
   
 
@@ -1911,7 +1917,6 @@ 

       
 
 
-96
 97
 98
 99
@@ -1934,10 +1939,11 @@ 

 116
 117
 118
-119

+119
+120
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 96
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 97
 
 def merge_document(merge_body, template_name = nil, return_format = :pdf, append = false)
   if !template_name.to_s.empty? && !merge_body.template.nil?   # .to_s.empty: check for nil or ''
@@ -2033,7 +2039,6 @@ 

       
 
 
-213
 214
 215
 216
@@ -2049,10 +2054,11 @@ 

 226
 227
 228
-229

+229
+230
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 213
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 214
 
 def template_exists?(template_name)
   # Parameter validation
@@ -2141,7 +2147,6 @@ 

       
 
 
-182
 183
 184
 185
@@ -2150,10 +2155,11 @@ 

 188
 189
 190
-191

+191
+192
- 
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 182
+      
# File 'lib/txtextcontrol/reportingcloud/reportingcloud.rb', line 183
 
 def upload_template(template_name, template_data)
   # Parameter validation
@@ -2175,7 +2181,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/Template.html b/TXTextControl/ReportingCloud/Template.html
index 039faac..3155d04 100644
--- a/TXTextControl/ReportingCloud/Template.html
+++ b/TXTextControl/ReportingCloud/Template.html
@@ -102,6 +102,8 @@
 
Overview

   

     
+
Holds information about a template in the template storage.

+
 
   

 

@@ -289,7 +291,6 @@ 

       
 
 
-29
 30
 31
 32
@@ -297,10 +298,11 @@ 

 34
 35
 36
-37

+37
+38
- 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 29
+      
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 30
 
 def initialize(template_name, modified, size)
   @template_name = template_name
@@ -367,12 +369,12 @@ 

       
 
 
-24
 25
-26

+26
+27
- 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+      
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 25
 
 def modified
   @modified
@@ -428,12 +430,12 @@ 

       
 
 
-24
 25
-26

+26
+27
- 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+      
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 25
 
 def size
   @size
@@ -489,12 +491,12 @@ 

       
 
 
-24
 25
-26

+26
+27
- 
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 24
+      
# File 'lib/txtextcontrol/reportingcloud/template.rb', line 25
 
 def template_name
   @template_name
@@ -510,7 +512,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/TemplateDataValidator.html b/TXTextControl/ReportingCloud/TemplateDataValidator.html
index f5a644a..c78cf6f 100644
--- a/TXTextControl/ReportingCloud/TemplateDataValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateDataValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/TemplateNameValidator.html b/TXTextControl/ReportingCloud/TemplateNameValidator.html
index ac1188f..11212f7 100644
--- a/TXTextControl/ReportingCloud/TemplateNameValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateNameValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/_index.html b/_index.html
index 88a9de5..4455f34 100644
--- a/_index.html
+++ b/_index.html
@@ -194,7 +194,7 @@ 
Namespace Listing A-Z

 
 
     
diff --git a/file.README.html b/file.README.html
index a8669ee..c3ead7f 100644
--- a/file.README.html
+++ b/file.README.html
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/index.html b/index.html
index a8669ee..c3ead7f 100644
--- a/index.html
+++ b/index.html
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/top-level-namespace.html b/top-level-namespace.html
index 336c549..3d532c7 100644
--- a/top-level-namespace.html
+++ b/top-level-namespace.html
@@ -105,7 +105,7 @@ 
Defined Under Namespace

 
 
     

From 85a9d069d5600283aa259fd8e1c901a9b2665165 Mon Sep 17 00:00:00 2001
From: Thorsten Kummerow 
Date: Tue, 21 Jun 2016 11:58:41 +0200
Subject: [PATCH 05/13] http --> https

---
 String.html                                             | 2 +-
 TXTextControl.html                                      | 2 +-
 TXTextControl/ReportingCloud.html                       | 6 +++---
 TXTextControl/ReportingCloud/AccountSettings.html       | 2 +-
 TXTextControl/ReportingCloud/MergeBody.html             | 2 +-
 TXTextControl/ReportingCloud/MergeSettings.html         | 2 +-
 TXTextControl/ReportingCloud/ReportingCloud.html        | 6 +++---
 TXTextControl/ReportingCloud/Template.html              | 2 +-
 TXTextControl/ReportingCloud/TemplateDataValidator.html | 2 +-
 TXTextControl/ReportingCloud/TemplateNameValidator.html | 2 +-
 _index.html                                             | 2 +-
 file.README.html                                        | 4 ++--
 index.html                                              | 4 ++--
 top-level-namespace.html                                | 2 +-
 14 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/String.html b/String.html
index acc1cbb..541189e 100644
--- a/String.html
+++ b/String.html
@@ -248,7 +248,7 @@ 

 
 
     
diff --git a/TXTextControl.html b/TXTextControl.html
index 3038585..53683ac 100644
--- a/TXTextControl.html
+++ b/TXTextControl.html
@@ -132,7 +132,7 @@ 
Overview

 

 
     
diff --git a/TXTextControl/ReportingCloud.html b/TXTextControl/ReportingCloud.html
index b0775cf..873bee5 100644
--- a/TXTextControl/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud.html
@@ -126,7 +126,7 @@ 
Constant Summary

 
 
         
-        
"http://api.reporting.cloud"

+        
"https://api.reporting.cloud"

       
         
DEFAULT_VERSION =
           

@@ -163,7 +163,7 @@ 
Constant Summary

         
VERSION =
           
         

-        
"1.0.0"

+        
"1.0.1"

       
     
   
@@ -179,7 +179,7 @@ 
Constant Summary

 
 
     
diff --git a/TXTextControl/ReportingCloud/AccountSettings.html b/TXTextControl/ReportingCloud/AccountSettings.html
index 5ee2993..036c754 100644
--- a/TXTextControl/ReportingCloud/AccountSettings.html
+++ b/TXTextControl/ReportingCloud/AccountSettings.html
@@ -1047,7 +1047,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html
index f648938..c0e38c2 100644
--- a/TXTextControl/ReportingCloud/MergeBody.html
+++ b/TXTextControl/ReportingCloud/MergeBody.html
@@ -658,7 +658,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/MergeSettings.html b/TXTextControl/ReportingCloud/MergeSettings.html
index d0456da..409b180 100644
--- a/TXTextControl/ReportingCloud/MergeSettings.html
+++ b/TXTextControl/ReportingCloud/MergeSettings.html
@@ -1341,7 +1341,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/ReportingCloud.html b/TXTextControl/ReportingCloud/ReportingCloud.html
index 6729ce4..25785b1 100644
--- a/TXTextControl/ReportingCloud/ReportingCloud.html
+++ b/TXTextControl/ReportingCloud/ReportingCloud.html
@@ -645,7 +645,7 @@ 

       
         —
         

-
The API base url. Is set to “http://api.reporting.cloud”  by
+
The API base url. Is set to “https://api.reporting.cloud”  by
 default.

 

       
@@ -765,7 +765,7 @@ 

 

   

     
-
The API base url. Is set to “http://api.reporting.cloud”  by
+
The API base url. Is set to “https://api.reporting.cloud”  by
 default.

 
 
@@ -2181,7 +2181,7 @@ 

 

 
     
diff --git a/TXTextControl/ReportingCloud/Template.html b/TXTextControl/ReportingCloud/Template.html
index 3155d04..1b91805 100644
--- a/TXTextControl/ReportingCloud/Template.html
+++ b/TXTextControl/ReportingCloud/Template.html
@@ -512,7 +512,7 @@ 

 

 
     
diff --git a/TXTextControl/ReportingCloud/TemplateDataValidator.html b/TXTextControl/ReportingCloud/TemplateDataValidator.html
index c78cf6f..cb91660 100644
--- a/TXTextControl/ReportingCloud/TemplateDataValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateDataValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/TXTextControl/ReportingCloud/TemplateNameValidator.html b/TXTextControl/ReportingCloud/TemplateNameValidator.html
index 11212f7..6efdb9c 100644
--- a/TXTextControl/ReportingCloud/TemplateNameValidator.html
+++ b/TXTextControl/ReportingCloud/TemplateNameValidator.html
@@ -268,7 +268,7 @@ 

 
 
     
diff --git a/_index.html b/_index.html
index 4455f34..d118426 100644
--- a/_index.html
+++ b/_index.html
@@ -194,7 +194,7 @@ 
Namespace Listing A-Z

 
 
     
diff --git a/file.README.html b/file.README.html
index c3ead7f..b4daa55 100644
--- a/file.README.html
+++ b/file.README.html
@@ -75,7 +75,7 @@ 
ReportingCloud Ruby Wrapper

 
 
Before using ReportingCloud, please sign up to the service:

 
-
api.reporting.cloud

+
portal.reporting.cloud

 
 
Installation

 
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/index.html b/index.html
index c3ead7f..b4daa55 100644
--- a/index.html
+++ b/index.html
@@ -75,7 +75,7 @@ 
ReportingCloud Ruby Wrapper

 
 
Before using ReportingCloud, please sign up to the service:

 
-
api.reporting.cloud

+
portal.reporting.cloud

 
 
Installation

 
@@ -119,7 +119,7 @@ 
Contributing

 
 
     
diff --git a/top-level-namespace.html b/top-level-namespace.html
index 3d532c7..87a8f00 100644
--- a/top-level-namespace.html
+++ b/top-level-namespace.html
@@ -105,7 +105,7 @@ 
Defined Under Namespace

 
 
     

From bca11a6769dc74c1053bc08baccb67c9b455c898 Mon Sep 17 00:00:00 2001
From: Thorsten 
Date: Thu, 30 Mar 2017 14:24:59 +0200
Subject: [PATCH 06/13] Updating documentation after adding new endpoints

---
 String.html                                   |  105 +-
 TXTextControl.html                            |   80 +-
 TXTextControl/ReportingCloud.html             |  128 +-
 .../ReportingCloud/AccountSettings.html       |  183 +--
 .../ReportingCloud/FindAndReplaceBody.html    |  654 ++++++++++
 TXTextControl/ReportingCloud/MergeBlock.html  |  676 ++++++++++
 TXTextControl/ReportingCloud/MergeBody.html   |  131 +-
 TXTextControl/ReportingCloud/MergeField.html  | 1056 +++++++++++++++
 .../ReportingCloud/MergeSettings.html         |  197 +--
 .../ReportingCloud/ReportingCloud.html        | 1128 ++++++++++++-----
 TXTextControl/ReportingCloud/Template.html    |  123 +-
 .../ReportingCloud/TemplateDataValidator.html |   99 +-
 .../ReportingCloud/TemplateInfo.html          |  746 +++++++++++
 .../ReportingCloud/TemplateNameValidator.html |   99 +-
 _index.html                                   |  103 +-
 class_list.html                               |   55 +-
 css/full_list.css                             |   63 +-
 css/style.css                                 |  335 +++--
 file.README.html                              |   59 +-
 file_list.html                                |   56 +-
 frames.html                                   |   23 +-
 index.html                                    |   59 +-
 js/app.js                                     |  178 +--
 js/full_list.js                               |  305 +++--
 method_list.html                              |  668 +++++++---
 top-level-namespace.html                      |   70 +-
 26 files changed, 5759 insertions(+), 1620 deletions(-)
 create mode 100644 TXTextControl/ReportingCloud/FindAndReplaceBody.html
 create mode 100644 TXTextControl/ReportingCloud/MergeBlock.html
 create mode 100644 TXTextControl/ReportingCloud/MergeField.html
 create mode 100644 TXTextControl/ReportingCloud/TemplateInfo.html

diff --git a/String.html b/String.html
index 541189e..4b89cdc 100644
--- a/String.html
+++ b/String.html
@@ -1,12 +1,12 @@
-
-
+
+
   
-    
+    
+
 
   Class: String
   
-    — Documentation by YARD 0.8.7.6
+    — Documentation by YARD 0.9.8
   
 
 
@@ -15,9 +15,8 @@
   
 
 
 
 
@@ -28,51 +27,48 @@
 
   
   
-    
# File 'lib/core_ext/string.rb', line 21
 
-def remove_first_and_last 
-  if self.length == 0 then return '' end
-  result = self.dup
-  result[0] = ''
-  if result.length > 0 then result[result.length - 1] = '' end
-  return result
+def remove_first_and_last 
+  if self.length == 0 then return '' end
+  result = self.dup
+  result[0] = ''
+  if result.length > 0 then result[result.length - 1] = '' end
+  return result
 end
 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 51
 
-def initialize(serial_number, created_documents, uploaded_templates, max_documents, max_templates, valid_until = nil)
-  case serial_number.downcase
-    when "trial"
-      @serial_number = :trial
-    when "free"
-      @serial_number = :free
-    else 
-      @serial_number = serial_number
-  end                
-  @created_documents = Integer(created_documents)
-  @uploaded_templates = Integer(uploaded_templates)
-  @max_documents = Integer(max_documents)
-  @max_templates = Integer(max_templates)
-  case valid_until
-    when DateTime
-      @valid_until = valid_until
-    when String
-      @valid_until = DateTime.iso8601(valid_until)
-    else
-      @valid_until = nil      
-  end
+def initialize(serial_number, created_documents, uploaded_templates, max_documents, max_templates, valid_until = nil)
+  case serial_number.downcase
+    when "trial"
+      @serial_number = :trial
+    when "free"
+      @serial_number = :free
+    else 
+      @serial_number = serial_number
+  end                
+  @created_documents = Integer(created_documents)
+  @uploaded_templates = Integer(uploaded_templates)
+  @max_documents = Integer(max_documents)
+  @max_templates = Integer(max_templates)
+  case valid_until
+    when DateTime
+      @valid_until = valid_until
+    when String
+      @valid_until = DateTime.iso8601(valid_until)
+    else
+      @valid_until = nil      
+  end
 end
 
# File 'lib/txtextcontrol/reportingcloud/account_settings.rb', line 77
 
-def self.from_camelized_hash(hash)
-  sn = hash["serialNumber"]
-  cd = hash["createdDocuments"]
-  ut = hash["uploadedTemplates"]
-  md = hash["maxDocuments"]
-  mt = hash["maxTemplates"]
-  vu = hash["validUntil"]
-  return AccountSettings.new(sn, cd, ut, md, mt, vu)
+def self.from_camelized_hash(hash)
+  sn = hash["serialNumber"]
+  cd = hash["createdDocuments"]
+  ut = hash["uploadedTemplates"]
+  md = hash["maxDocuments"]
+  mt = hash["maxTemplates"]
+  vu = hash["validUntil"]
+  return AccountSettings.new(sn, cd, ut, md, mt, vu)
 end
+ + + + +
+ 
+
+
+39
+40
+41
+42
+43
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/find_and_replace_body.rb', line 39
+
+def initialize(find_and_replace_data, template = nil, merge_settings = nil)
+  self.find_and_replace_data = find_and_replace_data
+  self.template = template
+  self.merge_settings = merge_settings
+end
+
+ + + + +
+

Instance Attribute Details

+ + + +
+

+ + #find_and_replace_data ⇒ Array<Array<String>> + + + + + +

+
+ +

The find and replace pair values as an array of string arrays.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array<Array<String>>) + + + + — +
    +

    the current value of find_and_replace_data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/find_and_replace_body.rb', line 27
+
+def find_and_replace_data
+  @find_and_replace_data
+end
+
+
+ + + +
+

+ + #merge_settings ⇒ MergeSettings + + + + + +

+
+ +

Merge settings to specify merge properties and document properties such as +title and author.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (MergeSettings) + + + + — +
    +

    the current value of merge_settings

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/find_and_replace_body.rb', line 27
+
+def merge_settings
+  @merge_settings
+end
+
+
+ + + +
+

+ + #template ⇒ String + + + + + +

+
+ +

The source document encoded as a Base64 string.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of template

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+27
+28
+29
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/find_and_replace_body.rb', line 27
+
+def template
+  @template
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + #to_camelized_hash ⇒ Hash + + + + + +

+
+ +

Converts a FindAndReplaceBody instance to a hash while converting the +attribute names from snake case to camel case.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Hash) + + + + — +
    +

    A hash representing the FindAndReplaceBody instance.

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+82
+83
+84
+85
+86
+87
+88
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/find_and_replace_body.rb', line 82
+
+def to_camelized_hash
+  return {
+    "findAndReplaceData" => @find_and_replace_data,
+    "template" => @template,
+    "mergeSettings" => @merge_settings
+  }
+end
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/MergeBlock.html b/TXTextControl/ReportingCloud/MergeBlock.html new file mode 100644 index 0000000..cc62b12 --- /dev/null +++ b/TXTextControl/ReportingCloud/MergeBlock.html @@ -0,0 +1,676 @@ + + + + + + + Class: TXTextControl::ReportingCloud::MergeBlock + + — Documentation by YARD 0.9.8 + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + +

Class: TXTextControl::ReportingCloud::MergeBlock + + + +

+
+ +
+
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+
+ + + + + + + + + + + +
+
Defined in:
+
lib/txtextcontrol/reportingcloud/merge_block.rb
+
+ +
+ +

Overview

+
+ +

Represents a merge block in a document template.

+ + +
+
+
+ + +
+ + + +

Instance Attribute Summary collapse

+ + + + + + +

+ Class Method Summary + collapse +

+ + + +

+ Instance Method Summary + collapse +

+ + + + +
+

Constructor Details

+ +
+

+ + #initialize(name, merge_blocks, merge_fields) ⇒ MergeBlock + + + + + +

+
+ +

Returns a new instance of MergeBlock

+ + +
+
+
+ +

Raises:

+
    + +
  • + + + (ArgumentError) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_block.rb', line 30
+
+def initialize(name, merge_blocks, merge_fields)
+  # Parameter validation
+  raise ArgumentError, "Block name must be a string." if !name.kind_of? String
+  raise ArgumentError, "Parameter merge_blocks must be an array." if !merge_blocks.kind_of? Array
+  raise ArgumentError, "Parameter merge_fields must be an array." if !merge_fields.kind_of? Array
+
+  @name = name
+  @merge_blocks = merge_blocks
+  @merge_fields = merge_fields
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + #merge_blocks ⇒ Array<MergeBlock> (readonly) + + + + + +

+
+ +

The merge blocks nested inside of the merge block.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array<MergeBlock>) + + + + — +
    +

    the current value of merge_blocks

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+25
+26
+27
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_block.rb', line 25
+
+def merge_blocks
+  @merge_blocks
+end
+
+
+ + + +
+

+ + #merge_fields ⇒ Array<MergeField> (readonly) + + + + + +

+
+ +

The merge fields inside of the merge block.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array<MergeField>) + + + + — +
    +

    the current value of merge_fields

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+25
+26
+27
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_block.rb', line 25
+
+def merge_fields
+  @merge_fields
+end
+
+
+ + + +
+

+ + #name ⇒ String (readonly) + + + + + +

+
+ +

The merge block's' name.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    the current value of name

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+25
+26
+27
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_block.rb', line 25
+
+def name
+  @name
+end
+
+
+ +
+ + +
+

Class Method Details

+ + +
+

+ + .from_camelized_hash(hash) ⇒ MergeBlock + + + + + +

+
+ +

Creates an MergeBlock instance from a hash.

+ + +
+
+
+

Parameters:

+
    + +
  • + + hash + + + (Hash) + + + + — +
    +

    The hash to try and create an MergeBlock instance from.

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (MergeBlock) + + + + — +
    +

    A newly created MergeBlock instance.

    +
    + +
    • + +
+

Raises:

+
    + +
  • + + + (ArgumentError) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+ 		+ 
# File 'lib/txtextcontrol/reportingcloud/merge_block.rb', line 44
+
+def self.from_camelized_hash(hash) 
+  # Parameter validation
+  raise ArgumentError, "Parameter must be a Hash." if !hash.kind_of? Hash
+
+  name = hash["name"]
+  blocks = Array.new
+  hash["mergeBlocks"].each do |elem|
+    blocks.push(MergeBlock.from_camelized_hash(elem))
+  end
+  fields = Array.new 
+  hash["mergeFields"].each do |elem|
+    fields.push(MergeField.from_camelized_hash(elem))
+  end
+  return MergeBlock.new(name, blocks, fields)
+end
+
+
+ +
+ +
+ + + +
+ + \ No newline at end of file diff --git a/TXTextControl/ReportingCloud/MergeBody.html b/TXTextControl/ReportingCloud/MergeBody.html index c0e38c2..b8c95d0 100644 --- a/TXTextControl/ReportingCloud/MergeBody.html +++ b/TXTextControl/ReportingCloud/MergeBody.html @@ -1,12 +1,12 @@ - - + + - + + Class: TXTextControl::ReportingCloud::MergeBody - — Documentation by YARD 0.8.7.6 + — Documentation by YARD 0.9.8 @@ -15,9 +15,8 @@ @@ -28,51 +27,48 @@ - diff --git a/_index.html b/_index.html index f9a538f..8bd0ef4 100644 --- a/_index.html +++ b/_index.html @@ -106,6 +106,21 @@

Namespace Listing A-Z

+
    +
  • I
    • +
      + +
    • + IncorrectWord + + (TXTextControl::ReportingCloud) + +
      • + +
    +
+ +