Class: Docusign::Tab

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign/docusign.rb,
lib/docusign/tab.rb

Overview

http://www.docusign.net/API/3.0Tab

documentID - SOAP::SOAPPositiveInteger
recipientID - SOAP::SOAPPositiveInteger
pageNumber - SOAP::SOAPNonNegativeInteger
xPosition - SOAP::SOAPNonNegativeInteger
yPosition - SOAP::SOAPNonNegativeInteger
scaleValue - SOAP::SOAPDecimal
anchorTabItem - Docusign::AnchorTab
type - Docusign::TabTypeCode
name - SOAP::SOAPString
tabLabel - SOAP::SOAPString
value - SOAP::SOAPString
customTabType - Docusign::CustomTabType
customTabWidth - SOAP::SOAPInt
customTabHeight - SOAP::SOAPInt
customTabRequired - SOAP::SOAPBoolean
customTabLocked - SOAP::SOAPBoolean
customTabDisableAutoSize - SOAP::SOAPBoolean
customTabListItems - SOAP::SOAPString
customTabListValues - SOAP::SOAPString
customTabListSelectedValue - SOAP::SOAPString
customTabRadioGroupName - SOAP::SOAPString
customTabValidationPattern - SOAP::SOAPString
customTabValidationMessage - SOAP::SOAPString
templateLocked - SOAP::SOAPBoolean
templateRequired - SOAP::SOAPBoolean
conditionalParentLabel - SOAP::SOAPString
conditionalParentValue - SOAP::SOAPString
sharedTab - SOAP::SOAPBoolean
requireInitialOnSharedTabChange - SOAP::SOAPBoolean
concealValueOnDocument - SOAP::SOAPBoolean

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(documentID = nil, recipientID = nil, pageNumber = nil, xPosition = nil, yPosition = nil, scaleValue = nil, anchorTabItem = nil, type = nil, name = nil, tabLabel = nil, value = nil, customTabType = nil, customTabWidth = nil, customTabHeight = nil, customTabRequired = nil, customTabLocked = nil, customTabDisableAutoSize = nil, customTabListItems = nil, customTabListValues = nil, customTabListSelectedValue = nil, customTabRadioGroupName = nil, customTabValidationPattern = nil, customTabValidationMessage = nil, templateLocked = nil, templateRequired = nil, conditionalParentLabel = nil, conditionalParentValue = nil, sharedTab = nil, requireInitialOnSharedTabChange = nil, concealValueOnDocument = nil) ⇒ Tab

Returns a new instance of Tab.



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/docusign/docusign.rb', line 489

def initialize(documentID = nil, recipientID = nil, pageNumber = nil, xPosition = nil, yPosition = nil, scaleValue = nil, anchorTabItem = nil, type = nil, name = nil, tabLabel = nil, value = nil, customTabType = nil, customTabWidth = nil, customTabHeight = nil, customTabRequired = nil, customTabLocked = nil, customTabDisableAutoSize = nil, customTabListItems = nil, customTabListValues = nil, customTabListSelectedValue = nil, customTabRadioGroupName = nil, customTabValidationPattern = nil, customTabValidationMessage = nil, templateLocked = nil, templateRequired = nil, conditionalParentLabel = nil, conditionalParentValue = nil, sharedTab = nil, requireInitialOnSharedTabChange = nil, concealValueOnDocument = nil)
  @documentID = documentID
  @recipientID = recipientID
  @pageNumber = pageNumber
  @xPosition = xPosition
  @yPosition = yPosition
  @scaleValue = scaleValue
  @anchorTabItem = anchorTabItem
  @type = type
  @name = name
  @tabLabel = tabLabel
  @value = value
  @customTabType = customTabType
  @customTabWidth = customTabWidth
  @customTabHeight = customTabHeight
  @customTabRequired = customTabRequired
  @customTabLocked = customTabLocked
  @customTabDisableAutoSize = customTabDisableAutoSize
  @customTabListItems = customTabListItems
  @customTabListValues = customTabListValues
  @customTabListSelectedValue = customTabListSelectedValue
  @customTabRadioGroupName = customTabRadioGroupName
  @customTabValidationPattern = customTabValidationPattern
  @customTabValidationMessage = customTabValidationMessage
  @templateLocked = templateLocked
  @templateRequired = templateRequired
  @conditionalParentLabel = conditionalParentLabel
  @conditionalParentValue = conditionalParentValue
  @sharedTab = sharedTab
  @requireInitialOnSharedTabChange = requireInitialOnSharedTabChange
  @concealValueOnDocument = concealValueOnDocument
end

Instance Attribute Details

#anchorTabItem ⇒ Object

Returns the value of attribute anchorTabItem.



464
465
466
 
# File 'lib/docusign/docusign.rb', line 464

def anchorTabItem
  @anchorTabItem
end

#concealValueOnDocument ⇒ Object

Returns the value of attribute concealValueOnDocument.



487
488
489
 
# File 'lib/docusign/docusign.rb', line 487

def concealValueOnDocument
  @concealValueOnDocument
end

#conditionalParentLabel ⇒ Object

Returns the value of attribute conditionalParentLabel.



483
484
485
 
# File 'lib/docusign/docusign.rb', line 483

def conditionalParentLabel
  @conditionalParentLabel
end

#conditionalParentValue ⇒ Object

Returns the value of attribute conditionalParentValue.



484
485
486
 
# File 'lib/docusign/docusign.rb', line 484

def conditionalParentValue
  @conditionalParentValue
end

#customTabDisableAutoSize ⇒ Object

Returns the value of attribute customTabDisableAutoSize.



474
475
476
 
# File 'lib/docusign/docusign.rb', line 474

def customTabDisableAutoSize
  @customTabDisableAutoSize
end

#customTabHeight ⇒ Object

Returns the value of attribute customTabHeight.



471
472
473
 
# File 'lib/docusign/docusign.rb', line 471

def customTabHeight
  @customTabHeight
end

#customTabListItems ⇒ Object

Returns the value of attribute customTabListItems.



475
476
477
 
# File 'lib/docusign/docusign.rb', line 475

def customTabListItems
  @customTabListItems
end

#customTabListSelectedValue ⇒ Object

Returns the value of attribute customTabListSelectedValue.



477
478
479
 
# File 'lib/docusign/docusign.rb', line 477

def customTabListSelectedValue
  @customTabListSelectedValue
end

#customTabListValues ⇒ Object

Returns the value of attribute customTabListValues.



476
477
478
 
# File 'lib/docusign/docusign.rb', line 476

def customTabListValues
  @customTabListValues
end

#customTabLocked ⇒ Object

Returns the value of attribute customTabLocked.



473
474
475
 
# File 'lib/docusign/docusign.rb', line 473

def customTabLocked
  @customTabLocked
end

#customTabRadioGroupName ⇒ Object

Returns the value of attribute customTabRadioGroupName.



478
479
480
 
# File 'lib/docusign/docusign.rb', line 478

def customTabRadioGroupName
  @customTabRadioGroupName
end

#customTabRequired ⇒ Object

Returns the value of attribute customTabRequired.



472
473
474
 
# File 'lib/docusign/docusign.rb', line 472

def customTabRequired
  @customTabRequired
end

#customTabType ⇒ Object

Returns the value of attribute customTabType.



469
470
471
 
# File 'lib/docusign/docusign.rb', line 469

def customTabType
  @customTabType
end

#customTabValidationMessage ⇒ Object

Returns the value of attribute customTabValidationMessage.



480
481
482
 
# File 'lib/docusign/docusign.rb', line 480

def customTabValidationMessage
  @customTabValidationMessage
end

#customTabValidationPattern ⇒ Object

Returns the value of attribute customTabValidationPattern.



479
480
481
 
# File 'lib/docusign/docusign.rb', line 479

def customTabValidationPattern
  @customTabValidationPattern
end

#customTabWidth ⇒ Object

Returns the value of attribute customTabWidth.



470
471
472
 
# File 'lib/docusign/docusign.rb', line 470

def customTabWidth
  @customTabWidth
end

#documentID ⇒ Object

Returns the value of attribute documentID.



458
459
460
 
# File 'lib/docusign/docusign.rb', line 458

def documentID
  @documentID
end

#name ⇒ Object

Returns the value of attribute name.



466
467
468
 
# File 'lib/docusign/docusign.rb', line 466

def name
  @name
end

#pageNumber ⇒ Object

Returns the value of attribute pageNumber.



460
461
462
 
# File 'lib/docusign/docusign.rb', line 460

def pageNumber
  @pageNumber
end

#recipientID ⇒ Object

Returns the value of attribute recipientID.



459
460
461
 
# File 'lib/docusign/docusign.rb', line 459

def recipientID
  @recipientID
end

#requireInitialOnSharedTabChange ⇒ Object

Returns the value of attribute requireInitialOnSharedTabChange.



486
487
488
 
# File 'lib/docusign/docusign.rb', line 486

def requireInitialOnSharedTabChange
  @requireInitialOnSharedTabChange
end

#scaleValue ⇒ Object

Returns the value of attribute scaleValue.



463
464
465
 
# File 'lib/docusign/docusign.rb', line 463

def scaleValue
  @scaleValue
end

#sharedTab ⇒ Object

Returns the value of attribute sharedTab.



485
486
487
 
# File 'lib/docusign/docusign.rb', line 485

def sharedTab
  @sharedTab
end

#tabLabel ⇒ Object

Returns the value of attribute tabLabel.



467
468
469
 
# File 'lib/docusign/docusign.rb', line 467

def tabLabel
  @tabLabel
end

#templateLocked ⇒ Object

Returns the value of attribute templateLocked.



481
482
483
 
# File 'lib/docusign/docusign.rb', line 481

def templateLocked
  @templateLocked
end

#templateRequired ⇒ Object

Returns the value of attribute templateRequired.



482
483
484
 
# File 'lib/docusign/docusign.rb', line 482

def templateRequired
  @templateRequired
end

#type ⇒ Object

Returns the value of attribute type.



465
466
467
 
# File 'lib/docusign/docusign.rb', line 465

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



468
469
470
 
# File 'lib/docusign/docusign.rb', line 468

def value
  @value
end

#xPosition ⇒ Object

Returns the value of attribute xPosition.



461
462
463
 
# File 'lib/docusign/docusign.rb', line 461

def xPosition
  @xPosition
end

#yPosition ⇒ Object

Returns the value of attribute yPosition.



462
463
464
 
# File 'lib/docusign/docusign.rb', line 462

def yPosition
  @yPosition
end

Instance Method Details

#anchor(options = {}, &block) ⇒ Object 



7
8
9
10
11
12
 
# File 'lib/docusign/tab.rb', line 7

def anchor(options = {}, &block)
  returning anchor_builder.build(options, &block) do |a|
    yield a if block_given?
    self.anchor_tab_item = a
  end
end

#anchor=(options = {}) ⇒ Object 



14
15
16
 
# File 'lib/docusign/tab.rb', line 14

def anchor=(options = {})
  anchor options
end

#anchor_builder ⇒ Object 



18
19
20
 
# File 'lib/docusign/tab.rb', line 18

def anchor_builder
  @anchor_builder ||= Docusign::Builder::AnchorBuilder.new
end