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

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

</table></td>

</tr></table>

<h2 class="class">Class File</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.Input.html"><code>Input</code></a> --+

File

</pre>

<hr/>

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

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

request,

node,

data)</code>

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

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

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

submodel)</code>

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

responsible for</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,

submodel,

setup,

controller,

viewStack,

*args,

**kwargs)</code>

</td></tr>

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

item)</code>

Convenience syntax for getting an attribute from the resultant DOM

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

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

item,

100

value)</code>

101

102

Convenience syntax for adding attributes to the resultant DOM Node of

103

this widget.</td></tr>

104

105

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

106

request,

107

node,

108

data)</code>

109

</td></tr>

110

111

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

112

</td></tr>

113

114

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

115

item)</code>

116

117

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

118

widget.</td></tr>

119

120

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

121

eventName,

122

handler,

123

*args)</code>

124

125

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

126

127

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

128

updateMethod)</code>

129

130

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

131

being rendered.</td></tr>

132

133

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

134

item)</code>

135

136

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

137

widget.</td></tr>

138

139

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

140

node)</code>

141

142

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

143

144

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

145

request,

146

node)</code>

147

148

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

149

150

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

151

request,

152

node)</code>

153

154

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

155

handles.</td></tr>

156

157

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

158

name,

159

default,

160

clone,

161

deep)</code>

162

163

Get all nodes below this one which have a matching pattern

164

attribute.</td></tr>

165

166

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

167

item)</code>

168

169

Convenience syntax for getting an attribute from the resultant DOM

170

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

171

172

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

173

request)</code>

174

175

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

176

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

177

178

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

179

name,

180

default,

181

clone,

182

deep)</code>

183

184

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

185

186

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

187

188

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

189

190

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

191

*args,

192

**kwargs)</code>

193

194

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

195

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

196

197

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

198

index,

199

item)</code>

200

201

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

202

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

203

204

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

205

payload)</code>

206

</td></tr>

207

208

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

209

request,

210

eventName,

211

*args)</code>

212

213

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

214

using addEventHandler.</td></tr>

215

216

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

217

item,

218

value)</code>

219

220

Convenience syntax for adding attributes to the resultant DOM Node of

221

this widget.</td></tr>

222

223

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

224

request,

225

data)</code>

226

227

If the return value of <a

228

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

229

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

230

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

231

232

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

233

result,

234

request,

235

node)</code>

236

</td></tr>

237

238

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

239

request,

240

message)</code>

241

242

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

243

user.</td></tr>

244

245

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

246

node)</code>

247

248

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

249

programatically.</td></tr>

250

251

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

252

253

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

254

request,

255

node,

256

result)</code>

257

258

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

259

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

260

DOM tree.</td></tr>

261

262

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

263

result,

264

request,

265

node)</code>

266

267

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

268

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

269

270

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

271

path,

272

request)</code>

273

</td></tr>

274

275

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

276

path,

277

request)</code>

278

</td></tr>

279

280

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

281

request,

282

node,

283

submodel,

284

model)</code>

285

286

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

287

288

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

289

request,

290

node,

291

submodel)</code>

292

293

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

294

295

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

296

request,

297

node,

298

submodel,

299

model)</code>

300

</td></tr>

301

302

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

303

request,

304

node,

305

model,

306

viewName)</code>

307

308

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

309

310

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

311

request)</code>

312

313

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

314

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

315

316

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

317

controllerResult,

318

request,

319

node,

320

controller,

321

view)</code>

322

323

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

324

325

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

326

request,

327

document)</code>

328

329

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

330

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

331

332

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

333

request,

334

returnNode)</code>

335

</td></tr>

336

337

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

338

request,

339

node)</code>

340

</td></tr>

341

342

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

343

request)</code>

344

</td></tr>

345

346

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

347

namespace)</code>

348

</td></tr>

349

350

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

351

request)</code>

352

353

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

354

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

355

template.</td></tr>

356

357

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

358

request,

359

node)</code>

360

361

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

362

363

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

364

request,

365

doneCallback)</code>

366

</td></tr>

367

368

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

369

failure,

370

request)</code>

371

</td></tr>

372

373

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

374

request)</code>

375

376

Check to see if handlers recorded any errors before sending the

377

page</td></tr>

378

379

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

380

controller)</code>

381

</td></tr>

382

383

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

384

name,

385

factory,

386

setup,

387

*args,

388

**kwargs)</code>

389

</td></tr>

390

391

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

392

</td></tr>

393

394

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

395

</td></tr>

396

397

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

398

</td></tr>

399

</table>

400

401

402

403

404

405

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

406

407

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

408

409

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

410

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

411

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

412

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

413

</table>

414

415

416

417

418

419

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

420

421

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

422

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

423

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

424

425

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

426

427

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

428

429

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

430

431

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

432

433

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

434

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

435

436

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

437

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

438

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

439

</td></tr>

440

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

441

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

442

443

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

444

445

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

446

</td></tr>

447

448

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

449

</td></tr>

450

451

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

452

</td></tr>

453

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

454

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

455

456

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

457

</td></tr>

458

</table>

459

460

461

462

463

464

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

465

</table>

466

467

468

469

<h3>setUp(self,

470

request,

471

node,

472

data)

473

</h3>

474

Override this method to set up your Widget prior to generateDOM.

475

This is a good place to call methods like <a

476

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

477

class="link"><code>add</code></a>, <a

478

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

479

class="link"><code>insert</code></a>, <a

480

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

481

class="link"><code>__setitem__</code></a> and <a

482

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

483

class="link"><code>__getitem__</code></a>.

484

Overriding this method obsoletes overriding generateDOM directly, in

485

most cases.

486

487

<dl><dt>Parameters:</dt>

488

<dd><code>request</code>

489

490

(type=<a href="twisted.web.server.Request.html"

491

class="link"><code>twisted.web.server.Request</code></a>.)

492

<dd><code>node</code> -

493

The DOM node which this Widget is operating on.

494

<dd><code>data</code> -

495

The Model data this Widget is meant to operate upon.

496

</dd>

497

</dl>

498

<dl><dt>Overrides:</dt>

499

<dd><a href="twisted.web.woven.widgets.Input.html#setUp"><code>twisted.web.woven.widgets.Input.setUp</code></a> (inherited documentation)

500

</dd>

501

</dl>

502

</dd></dl>

503

</td></tr></table>

504

505

506

507

508

509

510

511

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

512

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

513

514

515

516

517

518

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

519

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

520

</th>

521

</tr>

522

</table>

523

524

525

<tr>

526

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

527

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

528

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

529

</tr>

530

</table>

531

</body>

532

</html>

Older »