Class: Notesgrip::NotesView

Inherits:
GripWrapper show all
Includes:
DocCollection
Defined in:
lib/notesgrip/NotesView.rb

Overview

NotesView Class ===================

Constant Summary collapse

VW_SPACING_SINGLE = 
0
VW_SPACING_ONE_POINT_25 = 
1
VW_SPACING_ONE_POINT_50 = 
2
VW_SPACING_ONE_POINT_75 = 
3
VW_SPACING_DOUBLE = 
4

Instance Method Summary collapse

Methods included from DocCollection

#[], #each_document

Methods inherited from GripWrapper

#initialize, #raw

Constructor Details

This class inherits a constructor from Notesgrip::GripWrapper

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Notesgrip::GripWrapper

Instance Method Details

#Aliases ⇒ Object

——-Simple Method Relay——–



203
204
205
 
# File 'lib/notesgrip/NotesView.rb', line 203

def Aliases()
  @raw_object.Aliases()
end

#Aliases=(aliases) ⇒ Object 



206
207
208
 
# File 'lib/notesgrip/NotesView.rb', line 206

def Aliases=( aliases)
  @raw_object.Aliases =  aliases
end

#AllEntries ⇒ Object 



8
9
10
 
# File 'lib/notesgrip/NotesView.rb', line 8

def AllEntries
  NotesViewEntryCollection.new(@raw_object.AllEntries)
end

#AutoUpdate ⇒ Object 



210
211
212
 
# File 'lib/notesgrip/NotesView.rb', line 210

def AutoUpdate()
  @raw_object.AutoUpdate()
end

#AutoUpdate=(flag) ⇒ Object 



213
214
215
 
# File 'lib/notesgrip/NotesView.rb', line 213

def AutoUpdate=(flag)
  @raw_object.AutoUpdate = flag
end

#BackgroundColor ⇒ Object 



217
218
219
 
# File 'lib/notesgrip/NotesView.rb', line 217

def BackgroundColor()
  @raw_object.BackgroundColor()
end

#BackgroundColor=(color) ⇒ Object 



220
221
222
 
# File 'lib/notesgrip/NotesView.rb', line 220

def BackgroundColor=(color)
  @raw_object.BackgroundColor = color
end

#Clear ⇒ Object 



345
346
347
 
# File 'lib/notesgrip/NotesView.rb', line 345

def Clear()
  @raw_object.Clear()
end

#ColumnCount ⇒ Object 



224
225
226
 
# File 'lib/notesgrip/NotesView.rb', line 224

def ColumnCount()
  @raw_object.ColumnCount()
end

#ColumnNames ⇒ Object 



12
13
14
15
 
# File 'lib/notesgrip/NotesView.rb', line 12

def ColumnNames
  #@raw_object.ColumnNames
  raise "ColumnNames() is not work."
end

#Columns ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'lib/notesgrip/NotesView.rb', line 17

def Columns
  ret_list = []
  columns = @raw_object.Columns
  return [] unless columns
  columns.each {|raw_column|
    ret_list.push NotesViewColumn.new(raw_column)
  }
  ret_list
end

#CopyColumn(sourceColumn, destinationIndex = nil) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/notesgrip/NotesView.rb', line 36

def CopyColumn( sourceColumn, destinationIndex=nil )
  #raw_object = toRaw(sourceColumn)
  #raw_viewColumn = @raw_object.CopyColumn(sourceColumn, destinationIndex)
  #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
  raise "CopyColumn() is not work."
end

#count ⇒ Object Also known as: size 



193
194
195
 
# File 'lib/notesgrip/NotesView.rb', line 193

def count
  self.AllEntries.Count
end

#CreateColumn(position = nil, columnName = nil, formula = nil) ⇒ Object 



43
44
45
46
47
 
# File 'lib/notesgrip/NotesView.rb', line 43

def CreateColumn( position=nil, columnName=nil, formula=nil )
  #raw_viewColumn = @raw_object.CreateColumn( position, columnName, formula )
  #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
  raise "CreateColumn() is not work."
end

#Created ⇒ Object 



228
229
230
 
# File 'lib/notesgrip/NotesView.rb', line 228

def Created()
  @raw_object.Created()
end

#CreateViewNav(cacheSize = 128) ⇒ Object 



49
50
51
52
 
# File 'lib/notesgrip/NotesView.rb', line 49

def CreateViewNav( cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNav( cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFrom(navigatorObject, cacheSize = 128) ⇒ Object 



54
55
56
57
58
 
# File 'lib/notesgrip/NotesView.rb', line 54

def CreateViewNavFrom( navigatorObject, cacheSize=128 )
  raw_entry = toRaw(navigatorObject)
  raw_viewNavigator = @raw_object.CreateViewNavFrom( raw_entry, cacheSize)
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromAllUnread(username = nil) ⇒ Object 



60
61
62
63
 
# File 'lib/notesgrip/NotesView.rb', line 60

def CreateViewNavFromAllUnread( username=nil )
  raw_viewNavigator = @raw_object.CreateViewNavFromAllUnread( username )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromCategory(category, cacheSize = 128) ⇒ Object 



65
66
67
68
 
# File 'lib/notesgrip/NotesView.rb', line 65

def CreateViewNavFromCategory( category, cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNavFromCategory( category, cacheSize)
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromChildren(navigatorObject, cacheSize = 128) ⇒ Object 



70
71
72
73
74
 
# File 'lib/notesgrip/NotesView.rb', line 70

def CreateViewNavFromChildren(navigatorObject, cacheSize=128 )
  raw_navigatorObject = toRaw(navigatorObject)
  raw_viewNavigator = @raw_object.CreateViewNavFromChildren(raw_navigatorObject, cacheSize)
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromDescendants(navigatorObject, cacheSize = 128) ⇒ Object 



76
77
78
79
80
 
# File 'lib/notesgrip/NotesView.rb', line 76

def CreateViewNavFromDescendants( navigatorObject, cacheSize=128 )
  raw_obj = toRaw(navigatorObject)
  raw_viewNavigator = @raw_object.CreateViewNavFromDescendants( raw_obj, cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavMaxLevel(level, cacheSize = 128) ⇒ Object 



82
83
84
85
 
# File 'lib/notesgrip/NotesView.rb', line 82

def CreateViewNavMaxLevel( level, cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNavMaxLevel( level, cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#each_column ⇒ Object 



185
186
187
188
189
 
# File 'lib/notesgrip/NotesView.rb', line 185

def each_column
  self.Columns.each {|column|
    yield column
  }
end

#each_entry ⇒ Object

—— Additional Methods —–



179
180
181
182
183
 
# File 'lib/notesgrip/NotesView.rb', line 179

def each_entry
  self.AllEntries.each {|entry|
    yield entry
  }
end

#EntryCount ⇒ Object 



232
233
234
 
# File 'lib/notesgrip/NotesView.rb', line 232

def EntryCount()
  @raw_object.EntryCount()
end

#FTSearch(query, maxDocs = 0) ⇒ Object 



87
88
89
 
# File 'lib/notesgrip/NotesView.rb', line 87

def FTSearch( query, maxDocs=0 )
  @raw_object.FTSearch( query, maxDocs )
end

#GetAllDocumentsByKey(keyArray, exactMatch = false) ⇒ Object 



91
92
93
94
 
# File 'lib/notesgrip/NotesView.rb', line 91

def GetAllDocumentsByKey( keyArray , exactMatch = false )
  raw_docCollection = @raw_object.GetAllDocumentsByKey( keyArray , exactMatch)
  NotesDocumentCollection.new(raw_docCollection)
end

#GetAllEntriesByKey(keyArray, exactMatch = false) ⇒ Object 



96
97
98
99
 
# File 'lib/notesgrip/NotesView.rb', line 96

def GetAllEntriesByKey( keyArray , exactMatch=false )
  raw_viewEntryCollection = @raw_object.GetAllEntriesByKey( keyArray , exactMatch)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetAllReadEntries(username = nil) ⇒ Object 



101
102
103
104
 
# File 'lib/notesgrip/NotesView.rb', line 101

def GetAllReadEntries( username=nil )
  raw_viewEntryCollection = @raw_object.GetAllReadEntries( username)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetAllUnreadEntries(username = nil) ⇒ Object 



106
107
108
109
 
# File 'lib/notesgrip/NotesView.rb', line 106

def GetAllUnreadEntries( username=nil )
  raw_viewEntryCollection = @raw_object.GetAllUnreadEntries( username)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetChild(document) ⇒ Object 



111
112
113
114
115
 
# File 'lib/notesgrip/NotesView.rb', line 111

def GetChild( document )
  raw_doc = toRaw(document)
  raw_respdoc = @raw_object.GetChild(raw_doc)
  raw_respdoc ? NotesDocument.new(raw_rspdoc) : nil
end

#GetColumn(columnNumber) ⇒ Object 



117
118
119
120
121
 
# File 'lib/notesgrip/NotesView.rb', line 117

def GetColumn( columnNumber )
  #raw_viewColumn = @raw_object.GetColumn(columnNumber)
  #NotesViewColumn.new(raw_viewColumn)
  raise "GetColumn() is not work."
end

#GetDocumentByKey(keyArray, exactMatch = false) ⇒ Object 



123
124
125
126
 
# File 'lib/notesgrip/NotesView.rb', line 123

def GetDocumentByKey( keyArray, exactMatch=false )
  raw_doc = @raw_object.GetDocumentByKey( keyArray, exactMatch )
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetEntryByKey(keyArray, exactMatch = false) ⇒ Object 



128
129
130
131
 
# File 'lib/notesgrip/NotesView.rb', line 128

def GetEntryByKey( keyArray, exactMatch=false )
  raw_viewEntry = @raw_object.GetEntryByKey( keyArray, exactMatch)
  NotesViewEntry.new(raw_viewEntry)
end

#GetFirstDocument ⇒ Object 



133
134
135
136
 
# File 'lib/notesgrip/NotesView.rb', line 133

def GetFirstDocument
  raw_doc = @raw_object.GetFirstDocument()
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetLastDocument ⇒ Object 



138
139
140
141
 
# File 'lib/notesgrip/NotesView.rb', line 138

def GetLastDocument
  raw_doc = @raw_object.GetLastDocument()
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetNextDocument(document) ⇒ Object 



143
144
145
146
147
 
# File 'lib/notesgrip/NotesView.rb', line 143

def GetNextDocument(document)
  raw_doc = toRaw(document)
  raw_nextDoc = @raw_object.GetNextDocument(raw_doc)
  raw_nextDoc ? NotesDocument.new(raw_nextDoc) : nil
end

#GetNextSibling(document) ⇒ Object 



149
150
151
152
153
 
# File 'lib/notesgrip/NotesView.rb', line 149

def GetNextSibling( document )
  raw_doc = toRaw(document)
  raw_nextDoc = @raw_object.GetNextSibling(raw_doc)
  raw_nextDoc ? NotesDocument.new(raw_nextDoc) : nil
end

#GetNthDocument(index) ⇒ Object 



155
156
157
158
 
# File 'lib/notesgrip/NotesView.rb', line 155

def GetNthDocument(index)
  raw_doc = @raw_object.GetNthDocument(index)
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetParentDocument(document) ⇒ Object 



160
161
162
163
164
 
# File 'lib/notesgrip/NotesView.rb', line 160

def GetParentDocument( document )
  raw_doc = toRaw(document)
  raw_parentDoc = @raw_object.GetParentDocument(raw_doc)
  raw_parentDoc ? NotesDocument.new(raw_parentDoc) : nil
end

#GetPrevDocument(document) ⇒ Object 



166
167
168
169
170
 
# File 'lib/notesgrip/NotesView.rb', line 166

def GetPrevDocument( document )
  raw_doc = toRaw(document)
  raw_prevDoc = @raw_object.GetPrevDocument(raw_doc)
  raw_prevDoc ? NotesDocument.new(raw_prevDoc) : nil
end

#GetPrevSibling(document) ⇒ Object 



172
173
174
175
176
 
# File 'lib/notesgrip/NotesView.rb', line 172

def GetPrevSibling( document )
  raw_doc = toRaw(document)
  raw_prevDoc = @raw_object.GetPrevSibling(raw_doc)
  raw_prevDoc ? NotesDocument.new(raw_prevDoc) : nil
end

#HeaderLines ⇒ Object 



236
237
238
 
# File 'lib/notesgrip/NotesView.rb', line 236

def HeaderLines()
  @raw_object.HeaderLines()
end

#HttpURL ⇒ Object 



240
241
242
 
# File 'lib/notesgrip/NotesView.rb', line 240

def HttpURL()
  @raw_object.HttpURL()
end

#inspect ⇒ Object 



198
199
200
 
# File 'lib/notesgrip/NotesView.rb', line 198

def inspect
  "<#{self.class}, Name:#{self.Name.inspect}>"
end

#IsCalendar ⇒ Object 



244
245
246
 
# File 'lib/notesgrip/NotesView.rb', line 244

def IsCalendar()
  @raw_object.IsCalendar()
end

#IsCategorized ⇒ Object 



248
249
250
 
# File 'lib/notesgrip/NotesView.rb', line 248

def IsCategorized()
  @raw_object.IsCategorized()
end

#IsConflict ⇒ Object 



252
253
254
 
# File 'lib/notesgrip/NotesView.rb', line 252

def IsConflict()
  @raw_object.IsConflict()
end

#IsDefaultView ⇒ Object 



256
257
258
 
# File 'lib/notesgrip/NotesView.rb', line 256

def IsDefaultView()
  @raw_object.IsDefaultView()
end

#IsDefaultView=(flag) ⇒ Object 



259
260
261
 
# File 'lib/notesgrip/NotesView.rb', line 259

def IsDefaultView=(flag)
  @raw_object.IsDefaultView = flag
end

#IsFolder ⇒ Object 



263
264
265
 
# File 'lib/notesgrip/NotesView.rb', line 263

def IsFolder()
  @raw_object.IsFolder()
end

#IsHierarchical ⇒ Object 



267
268
269
 
# File 'lib/notesgrip/NotesView.rb', line 267

def IsHierarchical()
  @raw_object.IsHierarchical()
end

#IsModified ⇒ Object 



271
272
273
 
# File 'lib/notesgrip/NotesView.rb', line 271

def IsModified()
  @raw_object.IsModified()
end

#IsPrivate ⇒ Object 



275
276
277
 
# File 'lib/notesgrip/NotesView.rb', line 275

def IsPrivate()
  @raw_object.IsPrivate()
end

#IsProhibitDesignRefresh ⇒ Object 



279
280
281
 
# File 'lib/notesgrip/NotesView.rb', line 279

def IsProhibitDesignRefresh()
  @raw_object.IsProhibitDesignRefresh()
end

#IsProhibitDesignRefresh=(flag) ⇒ Object 



282
283
284
 
# File 'lib/notesgrip/NotesView.rb', line 282

def IsProhibitDesignRefresh=(flag)
  @raw_object.IsProhibitDesignRefresh = flag
end

#LastModified ⇒ Object 



286
287
288
 
# File 'lib/notesgrip/NotesView.rb', line 286

def LastModified()
  @raw_object.LastModified()
end

#Lock(name, provisionalOK = false) ⇒ Object

NotesDatabase#IsDesignLockingEnabled must be True before use this method.



350
351
352
 
# File 'lib/notesgrip/NotesView.rb', line 350

def Lock(name, provisionalOK=false)
  @raw_object.Lock(name, provisionalOK)
end

#LockHolders ⇒ Object 



290
291
292
 
# File 'lib/notesgrip/NotesView.rb', line 290

def LockHolders()
  @raw_object.LockHolders()
end

#LockProvisional(name) ⇒ Object

NotesDatabase#IsDesignLockingEnabled must be True before use this method.



355
356
357
 
# File 'lib/notesgrip/NotesView.rb', line 355

def LockProvisional(name)
  @raw_object.LockProvisional(name)
end

#MarkAllRead(username = nil) ⇒ Object 



359
360
361
 
# File 'lib/notesgrip/NotesView.rb', line 359

def MarkAllRead(username=nil)
  @raw_object.MarkAllRead(username)
end

#MarkAllUnread(username = nil) ⇒ Object 



363
364
365
 
# File 'lib/notesgrip/NotesView.rb', line 363

def MarkAllUnread(username=nil)
  @raw_object.MarkAllUnread(username)
end

#Name ⇒ Object 



294
295
296
 
# File 'lib/notesgrip/NotesView.rb', line 294

def Name()
  @raw_object.Name()
end

#NotesURL ⇒ Object 



298
299
300
 
# File 'lib/notesgrip/NotesView.rb', line 298

def NotesURL()
  @raw_object.NotesURL()
end

#Parent ⇒ Object 



27
28
29
 
# File 'lib/notesgrip/NotesView.rb', line 27

def Parent
  NotesDatabase.new(@raw_object.Parent)
end

#ProtectReaders ⇒ Object 



302
303
304
 
# File 'lib/notesgrip/NotesView.rb', line 302

def ProtectReaders()
  @raw_object.ProtectReaders()
end

#Readers ⇒ Object 



306
307
308
 
# File 'lib/notesgrip/NotesView.rb', line 306

def Readers()
  @raw_object.Readers()
end

#Readers=(stringArray) ⇒ Object 



309
310
311
 
# File 'lib/notesgrip/NotesView.rb', line 309

def Readers=(stringArray)
  @raw_object.Readers = stringArray
end

#Refresh ⇒ Object 



367
368
369
 
# File 'lib/notesgrip/NotesView.rb', line 367

def Refresh()
  @raw_object.Refresh()
end

#Remove ⇒ Object 



371
372
373
374
 
# File 'lib/notesgrip/NotesView.rb', line 371

def Remove()
  @raw_object.Remove()
  @raw_object = nil
end

#RemoveColumn(columnNameOrIndex = nil) ⇒ Object 



380
381
382
 
# File 'lib/notesgrip/NotesView.rb', line 380

def RemoveColumn(columnNameOrIndex=nil)
  @raw_object.RemoveColumn(columnNameOrIndex)
end

#ResortView(columnName = nil, ascendingFlag = true) ⇒ Object 



376
377
378
 
# File 'lib/notesgrip/NotesView.rb', line 376

def ResortView(columnName=nil, ascendingFlag=true)
  @raw_object.ResortView(columnName, ascendingFlag)
end

#RowLines ⇒ Object 



313
314
315
 
# File 'lib/notesgrip/NotesView.rb', line 313

def RowLines()
  @raw_object.RowLines()
end

#SelectionFormula ⇒ Object 



317
318
319
 
# File 'lib/notesgrip/NotesView.rb', line 317

def SelectionFormula()
  @raw_object.SelectionFormula()
end

#SelectionFormula=(formula) ⇒ Object 



320
321
322
 
# File 'lib/notesgrip/NotesView.rb', line 320

def SelectionFormula=(formula)
  @raw_object.SelectionFormula = formula
end

#SetAliases(aliases) ⇒ Object 



384
385
386
 
# File 'lib/notesgrip/NotesView.rb', line 384

def SetAliases(aliases)
  @raw_object.SetAliases(aliases)
end

#Spacing ⇒ Object 



329
330
331
 
# File 'lib/notesgrip/NotesView.rb', line 329

def Spacing()
  @raw_object.Spacing()
end

#Spacing=(spacing) ⇒ Object 



333
334
335
 
# File 'lib/notesgrip/NotesView.rb', line 333

def Spacing=(spacing)
  @raw_object.Spacing = spacing
end

#TopLevelEntryCount ⇒ Object 



337
338
339
 
# File 'lib/notesgrip/NotesView.rb', line 337

def TopLevelEntryCount()
  @raw_object.TopLevelEntryCount()
end

#UniversalID ⇒ Object Also known as: UNID 



31
32
33
 
# File 'lib/notesgrip/NotesView.rb', line 31

def UniversalID
  @raw_object.UniversalID
end

#UnLock ⇒ Object

NotesDatabase#IsDesignLockingEnabled must be True before use this method.



389
390
391
 
# File 'lib/notesgrip/NotesView.rb', line 389

def UnLock()
  @raw_object.UnLock()
end

#ViewInheritedName ⇒ Object 



341
342
343
 
# File 'lib/notesgrip/NotesView.rb', line 341

def ViewInheritedName()
  @raw_object.ViewInheritedName()
end