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
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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(documentID = nil, recipientID = nil, pageNumber = nil, xPosition = nil, yPosition = 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) ⇒ Tab

Returns a new instance of Tab.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/docusign/docusign.rb', line 442

def initialize(documentID = nil, recipientID = nil, pageNumber = nil, xPosition = nil, yPosition = 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)
  @documentID = documentID
  @recipientID = recipientID
  @pageNumber = pageNumber
  @xPosition = xPosition
  @yPosition = yPosition
  @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
end

Instance Attribute Details

#anchorTabItem ⇒ Object

Returns the value of attribute anchorTabItem.



422
423
424
 
# File 'lib/docusign/docusign.rb', line 422

def anchorTabItem
  @anchorTabItem
end

#customTabDisableAutoSize ⇒ Object

Returns the value of attribute customTabDisableAutoSize.



432
433
434
 
# File 'lib/docusign/docusign.rb', line 432

def customTabDisableAutoSize
  @customTabDisableAutoSize
end

#customTabHeight ⇒ Object

Returns the value of attribute customTabHeight.



429
430
431
 
# File 'lib/docusign/docusign.rb', line 429

def customTabHeight
  @customTabHeight
end

#customTabListItems ⇒ Object

Returns the value of attribute customTabListItems.



433
434
435
 
# File 'lib/docusign/docusign.rb', line 433

def customTabListItems
  @customTabListItems
end

#customTabListSelectedValue ⇒ Object

Returns the value of attribute customTabListSelectedValue.



435
436
437
 
# File 'lib/docusign/docusign.rb', line 435

def customTabListSelectedValue
  @customTabListSelectedValue
end

#customTabListValues ⇒ Object

Returns the value of attribute customTabListValues.



434
435
436
 
# File 'lib/docusign/docusign.rb', line 434

def customTabListValues
  @customTabListValues
end

#customTabLocked ⇒ Object

Returns the value of attribute customTabLocked.



431
432
433
 
# File 'lib/docusign/docusign.rb', line 431

def customTabLocked
  @customTabLocked
end

#customTabRadioGroupName ⇒ Object

Returns the value of attribute customTabRadioGroupName.



436
437
438
 
# File 'lib/docusign/docusign.rb', line 436

def customTabRadioGroupName
  @customTabRadioGroupName
end

#customTabRequired ⇒ Object

Returns the value of attribute customTabRequired.



430
431
432
 
# File 'lib/docusign/docusign.rb', line 430

def customTabRequired
  @customTabRequired
end

#customTabType ⇒ Object

Returns the value of attribute customTabType.



427
428
429
 
# File 'lib/docusign/docusign.rb', line 427

def customTabType
  @customTabType
end

#customTabValidationMessage ⇒ Object

Returns the value of attribute customTabValidationMessage.



438
439
440
 
# File 'lib/docusign/docusign.rb', line 438

def customTabValidationMessage
  @customTabValidationMessage
end

#customTabValidationPattern ⇒ Object

Returns the value of attribute customTabValidationPattern.



437
438
439
 
# File 'lib/docusign/docusign.rb', line 437

def customTabValidationPattern
  @customTabValidationPattern
end

#customTabWidth ⇒ Object

Returns the value of attribute customTabWidth.



428
429
430
 
# File 'lib/docusign/docusign.rb', line 428

def customTabWidth
  @customTabWidth
end

#documentID ⇒ Object

Returns the value of attribute documentID.



417
418
419
 
# File 'lib/docusign/docusign.rb', line 417

def documentID
  @documentID
end

#name ⇒ Object

Returns the value of attribute name.



424
425
426
 
# File 'lib/docusign/docusign.rb', line 424

def name
  @name
end

#pageNumber ⇒ Object

Returns the value of attribute pageNumber.



419
420
421
 
# File 'lib/docusign/docusign.rb', line 419

def pageNumber
  @pageNumber
end

#recipientID ⇒ Object

Returns the value of attribute recipientID.



418
419
420
 
# File 'lib/docusign/docusign.rb', line 418

def recipientID
  @recipientID
end

#tabLabel ⇒ Object

Returns the value of attribute tabLabel.



425
426
427
 
# File 'lib/docusign/docusign.rb', line 425

def tabLabel
  @tabLabel
end

#templateLocked ⇒ Object

Returns the value of attribute templateLocked.



439
440
441
 
# File 'lib/docusign/docusign.rb', line 439

def templateLocked
  @templateLocked
end

#templateRequired ⇒ Object

Returns the value of attribute templateRequired.



440
441
442
 
# File 'lib/docusign/docusign.rb', line 440

def templateRequired
  @templateRequired
end

#type ⇒ Object

Returns the value of attribute type.



423
424
425
 
# File 'lib/docusign/docusign.rb', line 423

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



426
427
428
 
# File 'lib/docusign/docusign.rb', line 426

def value
  @value
end

#xPosition ⇒ Object

Returns the value of attribute xPosition.



420
421
422
 
# File 'lib/docusign/docusign.rb', line 420

def xPosition
  @xPosition
end

#yPosition ⇒ Object

Returns the value of attribute yPosition.



421
422
423
 
# File 'lib/docusign/docusign.rb', line 421

def yPosition
  @yPosition
end

Instance Method Details

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



3
4
5
6
7
8
 
# File 'lib/docusign/tab.rb', line 3

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 



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

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

#anchor_builder ⇒ Object 



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

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