~certify-web-dev/twisted/certify-trunk

<tr><td align="right">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.widgets.KeyedList.html" target="_top">no frames</a>]</td></tr>

</table></td>

</tr></table>

<h2 class="class">Class KeyedList</h2>

<a href="twisted.web.woven.view.View.html"><code>View</code></a> --+

<a href="twisted.web.woven.widgets.Widget.html"><code>Widget</code></a> --+

<a href="twisted.web.woven.widgets.List.html"><code>List</code></a> --+

KeyedList

</pre>

<hr/>

I am a widget which knows how to display the values stored within a

Python dictionary..

A KeyedList should be specified in the template HTML as so:

| <ul model="blah" view="KeyedList">

| <li pattern="emptyList">This will be displayed if the list is

| empty.</li>

| <li pattern="keyedListItem" view="Text">Foo</li>

| </ul>

</pre>

I can take advantage of <code>listHeader</code>,

<code>listFooter</code> and <code>emptyList</code> items just as a <a

href="twisted.web.woven.widgets.List.html"

class="link"><code>List</code></a> can.

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><a name="_iterateData"></a>_iterateData(self,

parentNode,

submodel,

data)</code>

</td></tr>

<th colspan="2">    Inherited from List</th></tr>

<td><code><a href="twisted.web.woven.widgets.List.html#generateDOM" class="summary-sig-name"><code>generateDOM</code></a>(self,

request,

node)</code>

Return a DOM Node to replace the Node in the template that this Widget

handles.</td></tr>

<th colspan="2">    Inherited from Widget</th></tr>

<td><code><a href="twisted.web.woven.widgets.Widget.html#__init__" class="summary-sig-name"><code>__init__</code></a>(self,

model,

100

submodel,

101

setup,

102

controller,

103

viewStack,

104

*args,

105

**kwargs)</code>

106

</td></tr>

107

108

<td><code><a href="twisted.web.woven.widgets.Widget.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(self,

109

item)</code>

110

111

Convenience syntax for getting an attribute from the resultant DOM

112

Node of this widget.</td></tr>

113

114

<td><code><a href="twisted.web.woven.widgets.Widget.html#__setitem__" class="summary-sig-name"><code>__setitem__</code></a>(self,

115

item,

116

value)</code>

117

118

Convenience syntax for adding attributes to the resultant DOM Node of

119

this widget.</td></tr>

120

121

<td><code><a href="twisted.web.woven.widgets.Widget.html#_regenerate" class="summary-sig-name"><code>_regenerate</code></a>(self,

122

request,

123

node,

124

data)</code>

125

</td></tr>

126

127

<td><code><a href="twisted.web.woven.widgets.Widget.html#_reset" class="summary-sig-name"><code>_reset</code></a>(self)</code>

128

</td></tr>

129

130

<td><code><a href="twisted.web.woven.widgets.Widget.html#add" class="summary-sig-name"><code>add</code></a>(self,

131

item)</code>

132

133

Add `item' to the children of the resultant DOM Node of this

134

widget.</td></tr>

135

136

<td><code><a href="twisted.web.woven.widgets.Widget.html#addEventHandler" class="summary-sig-name"><code>addEventHandler</code></a>(self,

137

eventName,

138

handler,

139

*args)</code>

140

141

Add an event handler to this widget.</td></tr>

142

143

<td><code><a href="twisted.web.woven.widgets.Widget.html#addUpdateMethod" class="summary-sig-name"><code>addUpdateMethod</code></a>(self,

144

updateMethod)</code>

145

146

Add a method to this widget that will be called when the widget is

147

being rendered.</td></tr>

148

149

<td><code><a href="twisted.web.woven.widgets.Widget.html#appendChild" class="summary-sig-name"><code>appendChild</code></a>(self,

150

item)</code>

151

152

Add `item' to the children of the resultant DOM Node of this

153

widget.</td></tr>

154

155

<td><code><a href="twisted.web.woven.widgets.Widget.html#cleanNode" class="summary-sig-name"><code>cleanNode</code></a>(self,

156

node)</code>

157

158

Do your part, prevent infinite recursion!</td></tr>

159

160

<td><code><a href="twisted.web.woven.widgets.Widget.html#generate" class="summary-sig-name"><code>generate</code></a>(self,

161

request,

162

node)</code>

163

164

Allow a view to be used like a widget.</td></tr>

165

166

<td><code><a href="twisted.web.woven.widgets.Widget.html#getAllPatterns" class="summary-sig-name"><code>getAllPatterns</code></a>(self,

167

name,

168

default,

169

clone,

170

deep)</code>

171

172

Get all nodes below this one which have a matching pattern

173

attribute.</td></tr>

174

175

<td><code><a href="twisted.web.woven.widgets.Widget.html#__getitem__" class="summary-sig-name"><code>getAttribute</code></a>(self,

176

item)</code>

177

178

Convenience syntax for getting an attribute from the resultant DOM

179

Node of this widget.</td></tr>

180

181

<td><code><a href="twisted.web.woven.widgets.Widget.html#getData" class="summary-sig-name"><code>getData</code></a>(self,

182

request)</code>

183

184

I have a model; however since I am a widget I am only responsible for

185

a portion of that model.</td></tr>

186

187

<td><code><a href="twisted.web.woven.widgets.Widget.html#getPattern" class="summary-sig-name"><code>getPattern</code></a>(self,

188

name,

189

default,

190

clone,

191

deep)</code>

192

193

Get a named slot from the incoming template node.</td></tr>

194

195

<td><code><a href="twisted.web.woven.widgets.Widget.html#getTopModel" class="summary-sig-name"><code>getTopModel</code></a>(self)</code>

196

197

Get a reference to this page's top model object.</td></tr>

198

199

<td><code><a href="twisted.web.woven.widgets.Widget.html#initialize" class="summary-sig-name"><code>initialize</code></a>(self,

200

*args,

201

**kwargs)</code>

202

203

Use this method instead of __init__ to initialize your Widget, so you

204

don't have to deal with calling the __init__ of the superclass.</td></tr>

205

206

<td><code><a href="twisted.web.woven.widgets.Widget.html#insert" class="summary-sig-name"><code>insert</code></a>(self,

207

index,

208

item)</code>

209

210

Insert `item' at `index' in the children list of the resultant DOM

211

Node of this widget.</td></tr>

212

213

<td><code><a href="twisted.web.woven.widgets.Widget.html#modelChanged" class="summary-sig-name"><code>modelChanged</code></a>(self,

214

payload)</code>

215

</td></tr>

216

217

<td><code><a href="twisted.web.woven.widgets.Widget.html#onEvent" class="summary-sig-name"><code>onEvent</code></a>(self,

218

request,

219

eventName,

220

*args)</code>

221

222

Dispatch a client-side event to an event handler that was registered

223

using addEventHandler.</td></tr>

224

225

<td><code><a href="twisted.web.woven.widgets.Widget.html#__setitem__" class="summary-sig-name"><code>setAttribute</code></a>(self,

226

item,

227

value)</code>

228

229

Convenience syntax for adding attributes to the resultant DOM Node of

230

this widget.</td></tr>

231

232

<td><code><a href="twisted.web.woven.widgets.Widget.html#setData" class="summary-sig-name"><code>setData</code></a>(self,

233

request,

234

data)</code>

235

236

If the return value of <a

237

href="twisted.web.woven.widgets.Widget.html#getData"

238

class="link"><code>getData</code></a> is a Deferred, I am called when the

239

result of the Deferred is available.</td></tr>

240

241

<td><code><a href="twisted.web.woven.widgets.Widget.html#setDataCallback" class="summary-sig-name"><code>setDataCallback</code></a>(self,

242

result,

243

request,

244

node)</code>

245

</td></tr>

246

247

<td><code><a href="twisted.web.woven.widgets.Widget.html#setError" class="summary-sig-name"><code>setError</code></a>(self,

248

request,

249

message)</code>

250

251

Convenience method for allowing a Controller to report an error to the

252

user.</td></tr>

253

254

<td><code><a href="twisted.web.woven.widgets.Widget.html#setNode" class="summary-sig-name"><code>setNode</code></a>(self,

255

node)</code>

256

257

Set a node for this widget to use instead of creating one

258

programatically.</td></tr>

259

260

<td><code><a href="twisted.web.woven.widgets.Widget.html#setSubmodel" class="summary-sig-name"><code>setSubmodel</code></a>(self,

261

submodel)</code>

262

263

I use the submodel to know which attribute in self.model I am

264

responsible for</td></tr>

265

266

<td><code><a href="twisted.web.woven.widgets.Widget.html#setUp" class="summary-sig-name"><code>setUp</code></a>(self,

267

request,

268

node,

269

data)</code>

270

271

Override this method to set up your Widget prior to generateDOM.</td></tr>

272

273

<th colspan="2">    Inherited from View</th></tr>

274

275

<td><code><a href="twisted.web.woven.view.View.html#dispatchResult" class="summary-sig-name"><code>dispatchResult</code></a>(self,

276

request,

277

node,

278

result)</code>

279

280

Check a given result from handling a node and look up a NodeMutator

281

adapter which will convert the result into a node and insert it into the

282

DOM tree.</td></tr>

283

284

<td><code><a href="twisted.web.woven.view.View.html#dispatchResultCallback" class="summary-sig-name"><code>dispatchResultCallback</code></a>(self,

285

result,

286

request,

287

node)</code>

288

289

Deal with a callback from a deferred, checking to see if it is ok to

290

send the page yet or not.</td></tr>

291

292

<td><code><a href="twisted.web.woven.view.View.html#getChild" class="summary-sig-name"><code>getChild</code></a>(self,

293

path,

294

request)</code>

295

</td></tr>

296

297

<td><code><a href="twisted.web.woven.view.View.html#getChildWithDefault" class="summary-sig-name"><code>getChildWithDefault</code></a>(self,

298

path,

299

request)</code>

300

</td></tr>

301

302

<td><code><a href="twisted.web.woven.view.View.html#getNodeController" class="summary-sig-name"><code>getNodeController</code></a>(self,

303

request,

304

node,

305

submodel,

306

model)</code>

307

308

Get a controller object to handle this node.</td></tr>

309

310

<td><code><a href="twisted.web.woven.view.View.html#getNodeModel" class="summary-sig-name"><code>getNodeModel</code></a>(self,

311

request,

312

node,

313

submodel)</code>

314

315

Get the model object associated with this node.</td></tr>

316

317

<td><code><a href="twisted.web.woven.view.View.html#getNodeView" class="summary-sig-name"><code>getNodeView</code></a>(self,

318

request,

319

node,

320

submodel,

321

model)</code>

322

</td></tr>

323

324

<td><code><a href="twisted.web.woven.view.View.html#getSubview" class="summary-sig-name"><code>getSubview</code></a>(self,

325

request,

326

node,

327

model,

328

viewName)</code>

329

330

Get a sub-view from me.</td></tr>

331

332

<td><code><a href="twisted.web.woven.view.View.html#getTemplate" class="summary-sig-name"><code>getTemplate</code></a>(self,

333

request)</code>

334

335

Override this if you want to have your subclass look up its template

336

using a different method.</td></tr>

337

338

<td><code><a href="twisted.web.woven.view.View.html#handleControllerResults" class="summary-sig-name"><code>handleControllerResults</code></a>(self,

339

controllerResult,

340

request,

341

node,

342

controller,

343

view)</code>

344

345

Handle a deferred from a controller.</td></tr>

346

347

<td><code><a href="twisted.web.woven.view.View.html#handleDocument" class="summary-sig-name"><code>handleDocument</code></a>(self,

348

request,

349

document)</code>

350

351

Handle the root node, and send the page if there are no outstanding

352

callbacks when it returns.</td></tr>

353

354

<td><code><a href="twisted.web.woven.view.View.html#handleNewNode" class="summary-sig-name"><code>handleNewNode</code></a>(self,

355

request,

356

returnNode)</code>

357

</td></tr>

358

359

<td><code><a href="twisted.web.woven.view.View.html#handleNode" class="summary-sig-name"><code>handleNode</code></a>(self,

360

request,

361

node)</code>

362

</td></tr>

363

364

<td><code><a href="twisted.web.woven.view.View.html#handleOutstanding" class="summary-sig-name"><code>handleOutstanding</code></a>(self,

365

request)</code>

366

</td></tr>

367

368

<td><code><a href="twisted.web.woven.view.View.html#importViewLibrary" class="summary-sig-name"><code>importViewLibrary</code></a>(self,

369

namespace)</code>

370

</td></tr>

371

372

<td><code><a href="twisted.web.woven.view.View.html#lookupTemplate" class="summary-sig-name"><code>lookupTemplate</code></a>(self,

373

request)</code>

374

375

Use acquisition to look up the template named by self.templateFile,

376

located anywhere above this object in the heirarchy, and use it as the

377

template.</td></tr>

378

379

<td><code><a href="twisted.web.woven.view.View.html#recurseChildren" class="summary-sig-name"><code>recurseChildren</code></a>(self,

380

request,

381

node)</code>

382

383

If this node has children, handle them.</td></tr>

384

385

<td><code><a href="twisted.web.woven.view.View.html#render" class="summary-sig-name"><code>render</code></a>(self,

386

request,

387

doneCallback)</code>

388

</td></tr>

389

390

<td><code><a href="twisted.web.woven.view.View.html#renderFailure" class="summary-sig-name"><code>renderFailure</code></a>(self,

391

failure,

392

request)</code>

393

</td></tr>

394

395

<td><code><a href="twisted.web.woven.view.View.html#sendPage" class="summary-sig-name"><code>sendPage</code></a>(self,

396

request)</code>

397

398

Check to see if handlers recorded any errors before sending the

399

page</td></tr>

400

401

<td><code><a href="twisted.web.woven.view.View.html#setController" class="summary-sig-name"><code>setController</code></a>(self,

402

controller)</code>

403

</td></tr>

404

405

<td><code><a href="twisted.web.woven.view.View.html#setSubviewFactory" class="summary-sig-name"><code>setSubviewFactory</code></a>(self,

406

name,

407

factory,

408

setup,

409

*args,

410

**kwargs)</code>

411

</td></tr>

412

413

<td><code><a href="twisted.web.woven.view.View.html#setupAllStacks" class="summary-sig-name"><code>setupAllStacks</code></a>(self)</code>

414

</td></tr>

415

416

<td><code><a href="twisted.web.woven.view.View.html#setupViewStack" class="summary-sig-name"><code>setupViewStack</code></a>(self)</code>

417

</td></tr>

418

419

<td><code><a href="twisted.web.woven.view.View.html#unlinkViews" class="summary-sig-name"><code>unlinkViews</code></a>(self)</code>

420

</td></tr>

421

</table>

422

423

424

425

426

427

<th colspan="2">Instance Variable Summary</th></tr>

428

429

<th colspan="2">    Inherited from Widget</th></tr>

430

431

<td><a href="twisted.web.woven.widgets.Widget.html#model"><code>model</code></a>: If the current model is an <a

432

href="twisted.web.woven.model.Model.html"

433

class="link"><code>model.Model</code></a>, then the result of

434

model.getData().</td></tr>

435

</table>

436

437

438

439

440

441

<th colspan="2">Class Variable Summary</th></tr>

442

443

<th colspan="2">    Inherited from List</th></tr>

444

445

<td><a href="twisted.web.woven.widgets.List.html#defaultItemView"><code>defaultItemView</code></a> = <code>'DefaultWidget' </code>

446

</td></tr>

447

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

448

<td><a href="twisted.web.woven.widgets.List.html#tagName"><code>tagName</code></a>: The tag name of the element that this widget creates.</td></tr>

449

450

<th colspan="2">    Inherited from Widget</th></tr>

451

452

<td><a href="twisted.web.woven.widgets.Widget.html#clearNode"><code>clearNode</code></a> = 0                                                                     </td></tr>

453

454

<td><a href="twisted.web.woven.widgets.Widget.html#livePage"><code>livePage</code></a> = 1                                                                     </td></tr>

455

456

<td><a href="twisted.web.woven.widgets.Widget.html#setupStacks"><code>setupStacks</code></a> = 0                                                                     </td></tr>

457

458

<td><a href="twisted.web.woven.widgets.Widget.html#wantsAllNotifications"><code>wantsAllNotifications</code></a>: Indicate that this widget wants to recieve every change notification

459

from the main model, not just notifications that affect its model.</td></tr>

460

461

<th colspan="2">    Inherited from View</th></tr>

462

<tr><td align="right" valign="top" width="15%"><code>tuple</code></td>

463

<td><a href="twisted.web.woven.view.View.html#__implements__"><code>__implements__</code></a> = , <class twisted.web.woven.interfaces.IView at 0x85936d4>)"><code>(<class twisted.web.resource.IResource ...</code>

464

</td></tr>

465

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

466

<td><a href="twisted.web.woven.view.View.html#doneCallback"><code>doneCallback</code></a> = None                                                                  </td></tr>

467

468

<td><a href="twisted.web.woven.view.View.html#isLeaf"><code>isLeaf</code></a> = 1                                                                     </td></tr>

469

470

<td><a href="twisted.web.woven.view.View.html#template"><code>template</code></a> = <code>'' </code>

471

</td></tr>

472

473

<td><a href="twisted.web.woven.view.View.html#templateDirectory"><code>templateDirectory</code></a> = <code>'' </code>

474

</td></tr>

475

476

<td><a href="twisted.web.woven.view.View.html#templateFile"><code>templateFile</code></a> = <code>'' </code>

477

</td></tr>

478

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

479

<td><a href="twisted.web.woven.view.View.html#templateNode"><code>templateNode</code></a> = None                                                                  </td></tr>

480

481

<td><a href="twisted.web.woven.view.View.html#viewLibraries"><code>viewLibraries</code></a> = <code>[] </code>

482

</td></tr>

483

</table>

484

485

486

487

488

489

490

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

491

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

492

493

494

495

496

497

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

498

</th></tr></table>

499

</th>

500

</tr>

501

</table>

502

503

504

<tr>

505

<td align="left">Generated by Epydoc 2.0 on Sat May 15 20:08:15 2004</td>

506

<td align="right"><a href="http://epydoc.sourceforge.net"

507

>http://epydoc.sf.net</a></td>

508

</tr>

509

</table>

510

</body>

511

</html>

Older »