~ubuntu-branches/ubuntu/karmic/rhino/karmic

<DT>All Implemented Interfaces: <DD>org.mozilla.javascript.debug.DebuggableObject, <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A>, java.io.Serializable</DD>

</DL>

<DL>

<DT>Direct Known Subclasses: <DD>org.mozilla.javascript.IdScriptableObject</DD>

</DL>

<HR>

<DL>

<DT>public abstract class ScriptableObject<DT>extends java.lang.Object<DT>implements <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A>, java.io.Serializable, org.mozilla.javascript.debug.DebuggableObject</DL>

100

101

102

This is the default implementation of the Scriptable interface. This

103

class provides convenient default behavior that makes it easier to

104

define host objects.

105

106

Various properties and methods of JavaScript objects can be conveniently

107

defined using methods of ScriptableObject.

108

109

Classes extending ScriptableObject must define the getClassName method.

110

111

112

113

<DL>

114

<DT>Author:</DT>

115

<DD>Norris Boyd</DD>

116

<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript"><CODE>Scriptable</CODE></A>,

117

<A HREF="../../../serialized-form.html#org.mozilla.javascript.ScriptableObject">Serialized Form</A></DL>

118

<HR>

119

120

121

122

123

124

125

126

127

128

129

130

Field Summary</TD>

131

</TR>

132

133

134

<CODE>static int</CODE></TD>

135

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#DONTENUM">DONTENUM</A></CODE>

136

137

138

Property attribute indicating property is not enumerated.</TD>

139

</TR>

140

141

142

<CODE>static int</CODE></TD>

143

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#EMPTY">EMPTY</A></CODE>

144

145

146

The empty property attribute.</TD>

147

</TR>

148

149

150

<CODE>static int</CODE></TD>

151

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#PERMANENT">PERMANENT</A></CODE>

152

153

154

Property attribute indicating property cannot be deleted.</TD>

155

</TR>

156

157

158

<CODE>static int</CODE></TD>

159

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY">READONLY</A></CODE>

160

161

162

Property attribute indicating assignment to this property is ignored.</TD>

163

</TR>

164

</TABLE>

165

166

167

168

<TD>Fields inherited from interface org.mozilla.javascript.<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></TD>

169

</TR>

170

171

<TD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#NOT_FOUND">NOT_FOUND</A></CODE></TD>

172

</TR>

173

</TABLE>

174

175

176

177

178

179

180

181

Constructor Summary</TD>

182

</TR>

183

184

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#ScriptableObject()">ScriptableObject</A>()</CODE>

185

186

187

</TD>

188

</TR>

189

190

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#ScriptableObject(org.mozilla.javascript.Scriptable, org.mozilla.javascript.Scriptable)">ScriptableObject</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

191

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> prototype)</CODE>

192

193

194

</TD>

195

</TR>

196

</TABLE>

197

198

199

200

201

202

203

204

Method Summary</TD>

205

</TR>

206

207

208

<CODE> java.lang.Object</CODE></TD>

209

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#associateValue(java.lang.Object, java.lang.Object)">associateValue</A>(java.lang.Object key,

210

java.lang.Object value)</CODE>

211

212

213

Associate arbitrary application-specific value with this object.</TD>

214

</TR>

215

216

217

<CODE>static java.lang.Object</CODE></TD>

218

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#callMethod(org.mozilla.javascript.Context, org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object[])">callMethod</A>(<A HREF="../../../org/mozilla/javascript/Context.html" title="class in org.mozilla.javascript">Context</A> cx,

219

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

220

java.lang.String methodName,

221

java.lang.Object[] args)</CODE>

222

223

224

Call a method of an object.</TD>

225

</TR>

226

227

228

<CODE>static java.lang.Object</CODE></TD>

229

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#callMethod(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object[])">callMethod</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

230

java.lang.String methodName,

231

java.lang.Object[] args)</CODE>

232

233

234

Call a method of an object.</TD>

235

</TR>

236

237

238

<CODE>static void</CODE></TD>

239

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineClass(org.mozilla.javascript.Scriptable, java.lang.Class)">defineClass</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

240

java.lang.Class clazz)</CODE>

241

242

243

Defines JavaScript objects from a Java class that implements Scriptable.</TD>

244

</TR>

245

246

247

<CODE>static void</CODE></TD>

248

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineClass(org.mozilla.javascript.Scriptable, java.lang.Class, boolean)">defineClass</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

249

java.lang.Class clazz,

250

boolean sealed)</CODE>

251

252

253

          Defines JavaScript objects from a Java class, optionally

254

allowing sealing.</TD>

255

</TR>

256

257

258

259

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineFunctionProperties(java.lang.String[], java.lang.Class, int)">defineFunctionProperties</A>(java.lang.String[] names,

260

java.lang.Class clazz,

261

int attributes)</CODE>

262

263

264

          Search for names in a class, adding the resulting methods

265

as properties.</TD>

266

</TR>

267

268

269

<CODE>static void</CODE></TD>

270

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineProperty(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object, int)">defineProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> destination,

271

java.lang.String propertyName,

272

java.lang.Object value,

273

int attributes)</CODE>

274

275

276

Utility method to add properties to arbitrary Scriptable object.</TD>

277

</TR>

278

279

280

281

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineProperty(java.lang.String, java.lang.Class, int)">defineProperty</A>(java.lang.String propertyName,

282

java.lang.Class clazz,

283

int attributes)</CODE>

284

285

286

Define a JavaScript property with getter and setter side effects.</TD>

287

</TR>

288

289

290

291

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineProperty(java.lang.String, java.lang.Object, int)">defineProperty</A>(java.lang.String propertyName,

292

java.lang.Object value,

293

int attributes)</CODE>

294

295

296

Define a JavaScript property.</TD>

297

</TR>

298

299

300

301

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineProperty(java.lang.String, java.lang.Object, java.lang.reflect.Method, java.lang.reflect.Method, int)">defineProperty</A>(java.lang.String propertyName,

302

java.lang.Object delegateTo,

303

java.lang.reflect.Method getter,

304

java.lang.reflect.Method setter,

305

int attributes)</CODE>

306

307

308

Define a JavaScript property.</TD>

309

</TR>

310

311

312

313

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#delete(int)">delete</A>(int index)</CODE>

314

315

316

Removes the indexed property from the object.</TD>

317

</TR>

318

319

320

321

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#delete(java.lang.String)">delete</A>(java.lang.String name)</CODE>

322

323

324

Removes a named property from the object.</TD>

325

</TR>

326

327

328

<CODE>static boolean</CODE></TD>

329

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#deleteProperty(org.mozilla.javascript.Scriptable, int)">deleteProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

330

int index)</CODE>

331

332

333

Removes the property from an object or its prototype chain.</TD>

334

</TR>

335

336

337

<CODE>static boolean</CODE></TD>

338

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)">deleteProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

339

java.lang.String name)</CODE>

340

341

342

Removes the property from an object or its prototype chain.</TD>

343

</TR>

344

345

346

<CODE>protected  java.lang.Object</CODE></TD>

347

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#equivalentValues(java.lang.Object)">equivalentValues</A>(java.lang.Object value)</CODE>

348

349

350

Custom <tt>==</tt> operator.</TD>

351

</TR>

352

353

354

<CODE> java.lang.Object</CODE></TD>

355

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#get(int, org.mozilla.javascript.Scriptable)">get</A>(int index,

356

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

357

358

359

Returns the value of the indexed property or NOT_FOUND.</TD>

360

</TR>

361

362

363

<CODE> java.lang.Object</CODE></TD>

364

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#get(java.lang.String, org.mozilla.javascript.Scriptable)">get</A>(java.lang.String name,

365

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

366

367

368

Returns the value of the named property or NOT_FOUND.</TD>

369

</TR>

370

371

372

<CODE> java.lang.Object[]</CODE></TD>

373

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAllIds()">getAllIds</A>()</CODE>

374

375

376

Returns an array of ids for the properties of the object.</TD>

377

</TR>

378

379

380

<CODE> java.lang.Object</CODE></TD>

381

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAssociatedValue(java.lang.Object)">getAssociatedValue</A>(java.lang.Object key)</CODE>

382

383

384

Get arbitrary application-specific value associated with this object.</TD>

385

</TR>

386

387

388

389

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(int)">getAttributes</A>(int index)</CODE>

390

391

392

Get the attributes of an indexed property.</TD>

393

</TR>

394

395

396

397

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(int, org.mozilla.javascript.Scriptable)">getAttributes</A>(int index,

398

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

399

400

401

Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(int)"><CODE>getAttributes(int index)</CODE></A>. The engine always

402

ignored the start argument.</TD>

403

</TR>

404

405

406

407

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String)">getAttributes</A>(java.lang.String name)</CODE>

408

409

410

Get the attributes of a named property.</TD>

411

</TR>

412

413

414

415

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String, org.mozilla.javascript.Scriptable)">getAttributes</A>(java.lang.String name,

416

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

417

418

419

Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String)"><CODE>getAttributes(String name)</CODE></A>. The engine always

420

ignored the start argument.</TD>

421

</TR>

422

423

424

<CODE>abstract  java.lang.String</CODE></TD>

425

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getClassName()">getClassName</A>()</CODE>

426

427

428

Return the name of the class.</TD>

429

</TR>

430

431

432

<CODE>static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

433

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getClassPrototype(org.mozilla.javascript.Scriptable, java.lang.String)">getClassPrototype</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

434

java.lang.String className)</CODE>

435

436

437

Get the prototype for the named class.</TD>

438

</TR>

439

440

441

<CODE> java.lang.Object</CODE></TD>

442

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getDefaultValue(java.lang.Class)">getDefaultValue</A>(java.lang.Class typeHint)</CODE>

443

444

445

Implements the [[DefaultValue]] internal method.</TD>

446

</TR>

447

448

449

<CODE>static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

450

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getFunctionPrototype(org.mozilla.javascript.Scriptable)">getFunctionPrototype</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</CODE>

451

452

453

Get the Function.prototype property.</TD>

454

</TR>

455

456

457

<CODE> java.lang.Object[]</CODE></TD>

458

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getIds()">getIds</A>()</CODE>

459

460

461

Returns an array of ids for the properties of the object.</TD>

462

</TR>

463

464

465

<CODE>static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

466

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getObjectPrototype(org.mozilla.javascript.Scriptable)">getObjectPrototype</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</CODE>

467

468

469

Get the Object.prototype property.</TD>

470

</TR>

471

472

473

<CODE> <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

474

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getParentScope()">getParentScope</A>()</CODE>

475

476

477

Returns the parent (enclosing) scope of the object.</TD>

478

</TR>

479

480

481

<CODE>static java.lang.Object</CODE></TD>

482

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getProperty(org.mozilla.javascript.Scriptable, int)">getProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

483

int index)</CODE>

484

485

486

Gets an indexed property from an object or any object in its prototype chain.</TD>

487

</TR>

488

489

490

<CODE>static java.lang.Object</CODE></TD>

491

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getProperty(org.mozilla.javascript.Scriptable, java.lang.String)">getProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

492

java.lang.String name)</CODE>

493

494

495

Gets a named property from an object or any object in its prototype chain.</TD>

496

</TR>

497

498

499

<CODE>static java.lang.Object[]</CODE></TD>

500

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getPropertyIds(org.mozilla.javascript.Scriptable)">getPropertyIds</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj)</CODE>

501

502

503

Returns an array of all ids from an object and its prototypes.</TD>

504

</TR>

505

506

507

<CODE> <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

508

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getPrototype()">getPrototype</A>()</CODE>

509

510

511

Returns the prototype of the object.</TD>

512

</TR>

513

514

515

<CODE>static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></TD>

516

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getTopLevelScope(org.mozilla.javascript.Scriptable)">getTopLevelScope</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj)</CODE>

517

518

519

Get the global scope.</TD>

520

</TR>

521

522

523

<CODE>static java.lang.Object</CODE></TD>

524

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getTopScopeValue(org.mozilla.javascript.Scriptable, java.lang.Object)">getTopScopeValue</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

525

java.lang.Object key)</CODE>

526

527

528

          Get arbitrary application-specific value associated with the top scope

529

of the given scope.</TD>

530

</TR>

531

532

533

<CODE> boolean</CODE></TD>

534

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#has(int, org.mozilla.javascript.Scriptable)">has</A>(int index,

535

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

536

537

538

Returns true if the property index is defined.</TD>

539

</TR>

540

541

542

<CODE> boolean</CODE></TD>

543

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#has(java.lang.String, org.mozilla.javascript.Scriptable)">has</A>(java.lang.String name,

544

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE>

545

546

547

Returns true if the named property is defined.</TD>

548

</TR>

549

550

551

<CODE> boolean</CODE></TD>

552

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#hasInstance(org.mozilla.javascript.Scriptable)">hasInstance</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> instance)</CODE>

553

554

555

Implements the instanceof operator.</TD>

556

</TR>

557

558

559

<CODE>static boolean</CODE></TD>

560

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#hasProperty(org.mozilla.javascript.Scriptable, int)">hasProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

561

int index)</CODE>

562

563

564

          Returns whether an indexed property is defined in an object or any object

565

in its prototype chain.</TD>

566

</TR>

567

568

569

<CODE>static boolean</CODE></TD>

570

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#hasProperty(org.mozilla.javascript.Scriptable, java.lang.String)">hasProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

571

java.lang.String name)</CODE>

572

573

574

          Returns whether a named property is defined in an object or any object

575

in its prototype chain.</TD>

576

</TR>

577

578

579

<CODE> boolean</CODE></TD>

580

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#isSealed()">isSealed</A>()</CODE>

581

582

583

Return true if this object is sealed.</TD>

584

</TR>

585

586

587

588

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#put(int, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A>(int index,

589

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

590

java.lang.Object value)</CODE>

591

592

593

Sets the value of the indexed property, creating it if need be.</TD>

594

</TR>

595

596

597

598

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A>(java.lang.String name,

599

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

600

java.lang.Object value)</CODE>

601

602

603

Sets the value of the named property, creating it if need be.</TD>

604

</TR>

605

606

607

<CODE>static void</CODE></TD>

608

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#putProperty(org.mozilla.javascript.Scriptable, int, java.lang.Object)">putProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

609

int index,

610

java.lang.Object value)</CODE>

611

612

613

Puts an indexed property in an object or in an object in its prototype chain.</TD>

614

</TR>

615

616

617

<CODE>static void</CODE></TD>

618

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#putProperty(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object)">putProperty</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

619

java.lang.String name,

620

java.lang.Object value)</CODE>

621

622

623

Puts a named property in an object or in an object in its prototype chain.</TD>

624

</TR>

625

626

627

628

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#sealObject()">sealObject</A>()</CODE>

629

630

631

Seal this object.</TD>

632

</TR>

633

634

635

636

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(int, int)">setAttributes</A>(int index,

637

int attributes)</CODE>

638

639

640

Set the attributes of an indexed property.</TD>

641

</TR>

642

643

644

645

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(int, org.mozilla.javascript.Scriptable, int)">setAttributes</A>(int index,

646

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

647

int attributes)</CODE>

648

649

650

Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(int, int)"><CODE>setAttributes(int index, int attributes)</CODE></A>.

651

The engine always ignored the start argument.</TD>

652

</TR>

653

654

655

656

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(java.lang.String, int)">setAttributes</A>(java.lang.String name,

657

int attributes)</CODE>

658

659

660

Set the attributes of a named property.</TD>

661

</TR>

662

663

664

665

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int)">setAttributes</A>(java.lang.String name,

666

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

667

int attributes)</CODE>

668

669

670

Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(java.lang.String, int)"><CODE>setAttributes(String name, int attributes)</CODE></A>.

671

The engine always ignored the start argument.</TD>

672

</TR>

673

674

675

676

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setParentScope(org.mozilla.javascript.Scriptable)">setParentScope</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> m)</CODE>

677

678

679

Sets the parent (enclosing) scope of the object.</TD>

680

</TR>

681

682

683

684

<TD><CODE><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setPrototype(org.mozilla.javascript.Scriptable)">setPrototype</A>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> m)</CODE>

685

686

687

Sets the prototype of the object.</TD>

688

</TR>

689

</TABLE>

690

691

692

693

<TD>Methods inherited from class java.lang.Object</TD>

694

</TR>

695

696

<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>

697

</TR>

698

</TABLE>

699

700

701

702

703

704

705

706

707

708

Field Detail</TD>

709

</TR>

710

</TABLE>

711

712

713

EMPTY</H3>

714

<PRE>

715

public static final int EMPTY</PRE>

716

<DL>

717

<DD>The empty property attribute.

718

719

Used by getAttributes() and setAttributes().

720

721

<DL>

722

<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>getAttributes(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

723

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int)"><CODE>setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int)</CODE></A>,

724

<A HREF="../../../constant-values.html#org.mozilla.javascript.ScriptableObject.EMPTY">Constant Field Values</A></DL>

725

</DL>

726

<HR>

727

728

729

READONLY</H3>

730

<PRE>

731

public static final int READONLY</PRE>

732

<DL>

733

<DD>Property attribute indicating assignment to this property is ignored.

734

735

<DL>

736

<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)"><CODE>put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)</CODE></A>,

737

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>getAttributes(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

738

739

<A HREF="../../../constant-values.html#org.mozilla.javascript.ScriptableObject.READONLY">Constant Field Values</A></DL>

740

</DL>

741

<HR>

742

743

744

DONTENUM</H3>

745

<PRE>

746

public static final int DONTENUM</PRE>

747

<DL>

748

<DD>Property attribute indicating property is not enumerated.

749

750

Only enumerated properties will be returned by getIds().

751

752

<DL>

753

<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getIds()"><CODE>getIds()</CODE></A>,

754

755

756

<A HREF="../../../constant-values.html#org.mozilla.javascript.ScriptableObject.DONTENUM">Constant Field Values</A></DL>

757

</DL>

758

<HR>

759

760

761

PERMANENT</H3>

762

<PRE>

763

public static final int PERMANENT</PRE>

764

<DL>

765

<DD>Property attribute indicating property cannot be deleted.

766

767

<DL>

768

<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#delete(java.lang.String)"><CODE>delete(java.lang.String)</CODE></A>,

769

770

771

<A HREF="../../../constant-values.html#org.mozilla.javascript.ScriptableObject.PERMANENT">Constant Field Values</A></DL>

772

</DL>

773

774

775

776

777

778

779

780

Constructor Detail</TD>

781

</TR>

782

</TABLE>

783

784

785

ScriptableObject</H3>

786

<PRE>

787

public ScriptableObject()</PRE>

788

<DL>

789

</DL>

790

<HR>

791

792

793

ScriptableObject</H3>

794

<PRE>

795

public ScriptableObject(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

796

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> prototype)</PRE>

797

<DL>

798

</DL>

799

800

801

802

803

804

805

806

Method Detail</TD>

807

</TR>

808

</TABLE>

809

810

811

getClassName</H3>

812

<PRE>

813

public abstract java.lang.String getClassName()</PRE>

814

<DL>

815

<DD>Return the name of the class.

816

817

This is typically the same name as the constructor.

818

Classes extending ScriptableObject must implement this abstract

819

method.

820

821

822

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#getClassName()">getClassName</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

823

</DD>

824

825

</DL>

826

</DD>

827

</DL>

828

<HR>

829

830

831

has</H3>

832

<PRE>

833

public boolean has(java.lang.String name,

834

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

835

<DL>

836

<DD>Returns true if the named property is defined.

837

838

839

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)">has</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

840

</DD>

841

842

<DT>Parameters:<DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object in which the lookup began

843

<DT>Returns:<DD>true if and only if the property was found in the object<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.get(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

844

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getProperty(org.mozilla.javascript.Scriptable, java.lang.String)"><CODE>getProperty(org.mozilla.javascript.Scriptable, java.lang.String)</CODE></A></DL>

845

</DD>

846

</DL>

847

<HR>

848

849

850

has</H3>

851

<PRE>

852

public boolean has(int index,

853

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

854

<DL>

855

<DD>Returns true if the property index is defined.

856

857

858

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(int, org.mozilla.javascript.Scriptable)">has</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

859

</DD>

860

861

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object in which the lookup began

862

863

864

</DD>

865

</DL>

866

<HR>

867

868

869

get</H3>

870

<PRE>

871

public java.lang.Object get(java.lang.String name,

872

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

873

<DL>

874

<DD>Returns the value of the named property or NOT_FOUND.

875

876

If the property was created using defineProperty, the

877

appropriate getter method is called.

878

879

880

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)">get</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

881

</DD>

882

883

<DT>Parameters:<DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object in which the lookup began

884

<DT>Returns:<DD>the value of the property (may be null), or NOT_FOUND<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Context.html#getUndefinedValue()"><CODE>Context.getUndefinedValue()</CODE></A></DL>

885

</DD>

886

</DL>

887

<HR>

888

889

890

get</H3>

891

<PRE>

892

public java.lang.Object get(int index,

893

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

894

<DL>

895

<DD>Returns the value of the indexed property or NOT_FOUND.

896

897

898

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(int, org.mozilla.javascript.Scriptable)">get</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

899

</DD>

900

901

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object in which the lookup began

902

<DT>Returns:<DD>the value of the property (may be null), or NOT_FOUND<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.get(String,Scriptable)</CODE></A></DL>

903

</DD>

904

</DL>

905

<HR>

906

907

908

put</H3>

909

<PRE>

910

public void put(java.lang.String name,

911

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

912

java.lang.Object value)</PRE>

913

<DL>

914

<DD>Sets the value of the named property, creating it if need be.

915

916

If the property was created using defineProperty, the

917

appropriate setter method is called.

918

919

If the property's attributes include READONLY, no action is

920

taken.

921

This method will actually set the property in the start

922

object.

923

924

925

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

926

</DD>

927

928

<DT>Parameters:<DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object whose property is being set<DD><CODE>value</CODE> - value to set the property to<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

929

<A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.get(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

930

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#putProperty(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object)"><CODE>putProperty(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object)</CODE></A>,

931

<A HREF="../../../org/mozilla/javascript/Context.html#toObject(java.lang.Object, org.mozilla.javascript.Scriptable)"><CODE>Context.toObject(java.lang.Object, org.mozilla.javascript.Scriptable)</CODE></A></DL>

932

</DD>

933

</DL>

934

<HR>

935

936

937

put</H3>

938

<PRE>

939

public void put(int index,

940

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

941

java.lang.Object value)</PRE>

942

<DL>

943

<DD>Sets the value of the indexed property, creating it if need be.

944

945

946

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(int, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

947

</DD>

948

949

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object whose property is being set<DD><CODE>value</CODE> - value to set the property to<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

950

951

<A HREF="../../../org/mozilla/javascript/Scriptable.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)"><CODE>Scriptable.put(String,Scriptable,Object)</CODE></A>,

952

953

</DD>

954

</DL>

955

<HR>

956

957

958

delete</H3>

959

<PRE>

960

public void delete(java.lang.String name)</PRE>

961

<DL>

962

<DD>Removes a named property from the object.

963

964

If the property is not found, or it has the PERMANENT attribute,

965

no action is taken.

966

967

968

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#delete(java.lang.String)">delete</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

969

</DD>

970

971

<DT>Parameters:<DD><CODE>name</CODE> - the name of the property<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.get(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

972

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)"><CODE>deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)</CODE></A></DL>

973

</DD>

974

</DL>

975

<HR>

976

977

978

delete</H3>

979

<PRE>

980

public void delete(int index)</PRE>

981

<DL>

982

<DD>Removes the indexed property from the object.

983

984

If the property is not found, or it has the PERMANENT attribute,

985

no action is taken.

986

987

988

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#delete(int)">delete</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

989

</DD>

990

991

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.get(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

992

993

</DD>

994

</DL>

995

<HR>

996

997

998

getAttributes</H3>

999

<PRE>

1000

public final int getAttributes(java.lang.String name,

1001

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

1002

<DL>

1003

<DD>Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(java.lang.String)"><CODE>getAttributes(String name)</CODE></A>. The engine always

1004

ignored the start argument.

1005

1006

1007

</DL>

1008

</DD>

1009

1010

</DL>

1011

</DD>

1012

</DL>

1013

<HR>

1014

1015

1016

getAttributes</H3>

1017

<PRE>

1018

public final int getAttributes(int index,

1019

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE>

1020

<DL>

1021

<DD>Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAttributes(int)"><CODE>getAttributes(int index)</CODE></A>. The engine always

1022

ignored the start argument.

1023

1024

1025

</DL>

1026

</DD>

1027

1028

</DL>

1029

</DD>

1030

</DL>

1031

<HR>

1032

1033

1034

setAttributes</H3>

1035

<PRE>

1036

public final void setAttributes(java.lang.String name,

1037

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

1038

int attributes)</PRE>

1039

<DL>

1040

<DD>Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(java.lang.String, int)"><CODE>setAttributes(String name, int attributes)</CODE></A>.

1041

The engine always ignored the start argument.

1042

1043

1044

</DL>

1045

</DD>

1046

1047

</DL>

1048

</DD>

1049

</DL>

1050

<HR>

1051

1052

1053

setAttributes</H3>

1054

<PRE>

1055

public void setAttributes(int index,

1056

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start,

1057

int attributes)</PRE>

1058

<DL>

1059

<DD>Deprecated. Use <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#setAttributes(int, int)"><CODE>setAttributes(int index, int attributes)</CODE></A>.

1060

The engine always ignored the start argument.

1061

1062

1063

</DL>

1064

</DD>

1065

1066

</DL>

1067

</DD>

1068

</DL>

1069

<HR>

1070

1071

1072

getAttributes</H3>

1073

<PRE>

1074

public int getAttributes(java.lang.String name)</PRE>

1075

<DL>

1076

<DD>Get the attributes of a named property.

1077

1078

The property is specified by <code>name</code>

1079

as defined for <code>has</code>.

1080

1081

1082

</DL>

1083

</DD>

1084

1085

<DT>Parameters:<DD><CODE>name</CODE> - the identifier for the property

1086

<DT>Returns:<DD>the bitset of attributes

1087

<DT>Throws:

1088

<DD><CODE><A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript">EvaluatorException</A></CODE> - if the named property is not found<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

1089

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY"><CODE>READONLY</CODE></A>,

1090

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#DONTENUM"><CODE>DONTENUM</CODE></A>,

1091

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#PERMANENT"><CODE>PERMANENT</CODE></A>,

1092

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#EMPTY"><CODE>EMPTY</CODE></A></DL>

1093

</DD>

1094

</DL>

1095

<HR>

1096

1097

1098

getAttributes</H3>

1099

<PRE>

1100

public int getAttributes(int index)</PRE>

1101

<DL>

1102

<DD>Get the attributes of an indexed property.

1103

1104

1105

</DL>

1106

</DD>

1107

1108

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property

1109

<DT>Returns:<DD>the bitset of attributes

1110

<DT>Throws:

1111

<DD><CODE><A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript">EvaluatorException</A></CODE> - if the named property is not found

1112

is not found<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

1113

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY"><CODE>READONLY</CODE></A>,

1114

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#DONTENUM"><CODE>DONTENUM</CODE></A>,

1115

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#PERMANENT"><CODE>PERMANENT</CODE></A>,

1116

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#EMPTY"><CODE>EMPTY</CODE></A></DL>

1117

</DD>

1118

</DL>

1119

<HR>

1120

1121

1122

setAttributes</H3>

1123

<PRE>

1124

public void setAttributes(java.lang.String name,

1125

int attributes)</PRE>

1126

<DL>

1127

<DD>Set the attributes of a named property.

1128

1129

The property is specified by <code>name</code>

1130

as defined for <code>has</code>.

1131

1132

The possible attributes are READONLY, DONTENUM,

1133

and PERMANENT. Combinations of attributes

1134

are expressed by the bitwise OR of attributes.

1135

EMPTY is the state of no attributes set. Any unused

1136

bits are reserved for future use.

1137

1138

1139

</DL>

1140

</DD>

1141

1142

<DT>Parameters:<DD><CODE>name</CODE> - the name of the property<DD><CODE>attributes</CODE> - the bitset of attributes

1143

<DT>Throws:

1144

<DD><CODE><A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript">EvaluatorException</A></CODE> - if the named property is not found<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

1145

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY"><CODE>READONLY</CODE></A>,

1146

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#DONTENUM"><CODE>DONTENUM</CODE></A>,

1147

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#PERMANENT"><CODE>PERMANENT</CODE></A>,

1148

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#EMPTY"><CODE>EMPTY</CODE></A></DL>

1149

</DD>

1150

</DL>

1151

<HR>

1152

1153

1154

setAttributes</H3>

1155

<PRE>

1156

public void setAttributes(int index,

1157

int attributes)</PRE>

1158

<DL>

1159

<DD>Set the attributes of an indexed property.

1160

1161

1162

</DL>

1163

</DD>

1164

1165

<DT>Parameters:<DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>attributes</CODE> - the bitset of attributes

1166

<DT>Throws:

1167

<DD><CODE><A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript">EvaluatorException</A></CODE> - if the named property is not found<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>Scriptable.has(java.lang.String, org.mozilla.javascript.Scriptable)</CODE></A>,

1168

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY"><CODE>READONLY</CODE></A>,

1169

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#DONTENUM"><CODE>DONTENUM</CODE></A>,

1170

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#PERMANENT"><CODE>PERMANENT</CODE></A>,

1171

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#EMPTY"><CODE>EMPTY</CODE></A></DL>

1172

</DD>

1173

</DL>

1174

<HR>

1175

1176

1177

getPrototype</H3>

1178

<PRE>

1179

public <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getPrototype()</PRE>

1180

<DL>

1181

<DD>Returns the prototype of the object.

1182

1183

1184

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#getPrototype()">getPrototype</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1185

</DD>

1186

1187

1188

<DT>Returns:<DD>the prototype</DL>

1189

</DD>

1190

</DL>

1191

<HR>

1192

1193

1194

setPrototype</H3>

1195

<PRE>

1196

public void setPrototype(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> m)</PRE>

1197

<DL>

1198

<DD>Sets the prototype of the object.

1199

1200

1201

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#setPrototype(org.mozilla.javascript.Scriptable)">setPrototype</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1202

</DD>

1203

1204

<DT>Parameters:<DD><CODE>m</CODE> - the prototype to set</DL>

1205

</DD>

1206

</DL>

1207

<HR>

1208

1209

1210

getParentScope</H3>

1211

<PRE>

1212

public <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getParentScope()</PRE>

1213

<DL>

1214

<DD>Returns the parent (enclosing) scope of the object.

1215

1216

1217

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#getParentScope()">getParentScope</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1218

</DD>

1219

1220

1221

<DT>Returns:<DD>the parent scope</DL>

1222

</DD>

1223

</DL>

1224

<HR>

1225

1226

1227

setParentScope</H3>

1228

<PRE>

1229

public void setParentScope(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> m)</PRE>

1230

<DL>

1231

<DD>Sets the parent (enclosing) scope of the object.

1232

1233

1234

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#setParentScope(org.mozilla.javascript.Scriptable)">setParentScope</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1235

</DD>

1236

1237

<DT>Parameters:<DD><CODE>m</CODE> - the parent scope to set</DL>

1238

</DD>

1239

</DL>

1240

<HR>

1241

1242

1243

getIds</H3>

1244

<PRE>

1245

public java.lang.Object[] getIds()</PRE>

1246

<DL>

1247

<DD>Returns an array of ids for the properties of the object.

1248

1249

Any properties with the attribute DONTENUM are not listed.

1250

1251

1252

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#getIds()">getIds</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1253

</DD>

1254

1255

1256

<DT>Returns:<DD>an array of java.lang.Objects with an entry for every

1257

listed property. Properties accessed via an integer index will

1258

have a corresponding

1259

Integer entry in the returned array. Properties accessed by

1260

a String will have a String entry in the returned array.</DL>

1261

</DD>

1262

</DL>

1263

<HR>

1264

1265

1266

getAllIds</H3>

1267

<PRE>

1268

public java.lang.Object[] getAllIds()</PRE>

1269

<DL>

1270

<DD>Returns an array of ids for the properties of the object.

1271

1272

All properties, even those with attribute DONTENUM, are listed.

1273

1274

1275

<DT>Specified by:<DD><CODE>getAllIds</CODE> in interface <CODE>org.mozilla.javascript.debug.DebuggableObject</CODE></DL>

1276

</DD>

1277

1278

1279

<DT>Returns:<DD>an array of java.lang.Objects with an entry for every

1280

listed property. Properties accessed via an integer index will

1281

have a corresponding

1282

Integer entry in the returned array. Properties accessed by

1283

a String will have a String entry in the returned array.</DL>

1284

</DD>

1285

</DL>

1286

<HR>

1287

1288

1289

getDefaultValue</H3>

1290

<PRE>

1291

public java.lang.Object getDefaultValue(java.lang.Class typeHint)</PRE>

1292

<DL>

1293

<DD>Implements the [[DefaultValue]] internal method.

1294

1295

Note that the toPrimitive conversion is a no-op for

1296

every type other than Object, for which [[DefaultValue]]

1297

is called. See ECMA 9.1.

1298

1299

A <code>hint</code> of null means "no hint".

1300

1301

1302

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#getDefaultValue(java.lang.Class)">getDefaultValue</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1303

</DD>

1304

1305

<DT>Parameters:<DD><CODE>typeHint</CODE> - the type hint

1306

<DT>Returns:<DD>the default value for the object

1307

1308

See ECMA 8.6.2.6.</DL>

1309

</DD>

1310

</DL>

1311

<HR>

1312

1313

1314

hasInstance</H3>

1315

<PRE>

1316

public boolean hasInstance(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> instance)</PRE>

1317

<DL>

1318

<DD>Implements the instanceof operator.

1319

1320

This operator has been proposed to ECMA.

1321

1322

1323

<DT>Specified by:<DD><CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html#hasInstance(org.mozilla.javascript.Scriptable)">hasInstance</A></CODE> in interface <CODE><A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></DL>

1324

</DD>

1325

1326

<DT>Parameters:<DD><CODE>instance</CODE> - The value that appeared on the LHS of the instanceof

1327

operator

1328

<DT>Returns:<DD>true if "this" appears in value's prototype chain</DL>

1329

</DD>

1330

</DL>

1331

<HR>

1332

1333

1334

equivalentValues</H3>

1335

<PRE>

1336

protected java.lang.Object equivalentValues(java.lang.Object value)</PRE>

1337

<DL>

1338

<DD>Custom <tt>==</tt> operator.

1339

Must return <A HREF="../../../org/mozilla/javascript/Scriptable.html#NOT_FOUND"><CODE>Scriptable.NOT_FOUND</CODE></A> if this object does not

1340

have custom equality operator for the given value,

1341

<tt>Boolean.TRUE</tt> if this object is equivalent to <tt>value</tt>,

1342

<tt>Boolean.FALSE</tt> if this object is not equivalent to

1343

<tt>value</tt>.

1344

1345

The default implementation returns Boolean.TRUE

1346

if <tt>this == value</tt> or <A HREF="../../../org/mozilla/javascript/Scriptable.html#NOT_FOUND"><CODE>Scriptable.NOT_FOUND</CODE></A> otherwise.

1347

It indicates that by default custom equality is available only if

1348

<tt>value</tt> is <tt>this</tt> in which case true is returned.

1349

1350

1351

</DL>

1352

</DD>

1353

1354

</DL>

1355

</DD>

1356

</DL>

1357

<HR>

1358

1359

1360

defineClass</H3>

1361

<PRE>

1362

public static void defineClass(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

1363

java.lang.Class clazz)

1364

throws java.lang.IllegalAccessException,

1365

java.lang.InstantiationException,

1366

java.lang.reflect.InvocationTargetException</PRE>

1367

<DL>

1368

<DD>Defines JavaScript objects from a Java class that implements Scriptable.

1369

1370

If the given class has a method

1371

<pre>

1372

static void init(Context cx, Scriptable scope, boolean sealed);</pre>

1373

1374

or its compatibility form

1375

<pre>

1376

static void init(Scriptable scope);</pre>

1377

1378

then it is invoked and no further initialization is done.

1379

1380

However, if no such a method is found, then the class's constructors and

1381

methods are used to initialize a class in the following manner.

1382

1383

First, the zero-parameter constructor of the class is called to

1384

create the prototype. If no such constructor exists,

1385

a <A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript"><CODE>EvaluatorException</CODE></A> is thrown.

1386

1387

Next, all methods are scanned for special prefixes that indicate that they

1388

have special meaning for defining JavaScript objects.

1389

These special prefixes are

1390

<ul>

1391

<li><code>jsFunction_</code> for a JavaScript function

1392

<li><code>jsStaticFunction_</code> for a JavaScript function that

1393

is a property of the constructor

1394

<li><code>jsGet_</code> for a getter of a JavaScript property

1395

<li><code>jsSet_</code> for a setter of a JavaScript property

1396

<li><code>jsConstructor</code> for a JavaScript function that

1397

is the constructor

1398

</ul>

1399

1400

If the method's name begins with "jsFunction_", a JavaScript function

1401

is created with a name formed from the rest of the Java method name

1402

following "jsFunction_". So a Java method named "jsFunction_foo" will

1403

define a JavaScript method "foo". Calling this JavaScript function

1404

will cause the Java method to be called. The parameters of the method

1405

must be of number and types as defined by the FunctionObject class.

1406

The JavaScript function is then added as a property

1407

of the prototype.

1408

1409

If the method's name begins with "jsStaticFunction_", it is handled

1410

similarly except that the resulting JavaScript function is added as a

1411

property of the constructor object. The Java method must be static.

1412

1413

If the method's name begins with "jsGet_" or "jsSet_", the method is

1414

considered to define a property. Accesses to the defined property

1415

will result in calls to these getter and setter methods. If no

1416

setter is defined, the property is defined as READONLY.

1417

1418

If the method's name is "jsConstructor", the method is

1419

considered to define the body of the constructor. Only one

1420

method of this name may be defined.

1421

If no method is found that can serve as constructor, a Java

1422

constructor will be selected to serve as the JavaScript

1423

constructor in the following manner. If the class has only one

1424

Java constructor, that constructor is used to define

1425

the JavaScript constructor. If the the class has two constructors,

1426

one must be the zero-argument constructor (otherwise an

1427

<A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript"><CODE>EvaluatorException</CODE></A> would have already been thrown

1428

when the prototype was to be created). In this case

1429

the Java constructor with one or more parameters will be used

1430

to define the JavaScript constructor. If the class has three

1431

or more constructors, an <A HREF="../../../org/mozilla/javascript/EvaluatorException.html" title="class in org.mozilla.javascript"><CODE>EvaluatorException</CODE></A>

1432

will be thrown.

1433

1434

Finally, if there is a method

1435

<pre>

1436

static void finishInit(Scriptable scope, FunctionObject constructor,

1437

Scriptable prototype)</pre>

1438

1439

it will be called to finish any initialization. The <code>scope</code>

1440

argument will be passed, along with the newly created constructor and

1441

the newly created prototype.

1442

1443

1444

</DL>

1445

</DD>

1446

1447

<DT>Parameters:<DD><CODE>scope</CODE> - The scope in which to define the constructor<DD><CODE>clazz</CODE> - The Java class to use to define the JavaScript objects

1448

and properties

1449

<DT>Throws:

1450

<DD><CODE>java.lang.IllegalAccessException</CODE> - if access is not available

1451

to a reflected class member

1452

<DD><CODE>java.lang.InstantiationException</CODE> - if unable to instantiate

1453

the named class

1454

<DD><CODE>java.lang.reflect.InvocationTargetException</CODE> - if an exception is thrown

1455

during execution of methods of the named class<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Function.html" title="interface in org.mozilla.javascript"><CODE>Function</CODE></A>,

1456

<A HREF="../../../org/mozilla/javascript/FunctionObject.html" title="class in org.mozilla.javascript"><CODE>FunctionObject</CODE></A>,

1457

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#READONLY"><CODE>READONLY</CODE></A>,

1458

<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#defineProperty(java.lang.String, java.lang.Object, int)"><CODE>defineProperty(java.lang.String, java.lang.Object, int)</CODE></A></DL>

1459

</DD>

1460

</DL>

1461

<HR>

1462

1463

1464

defineClass</H3>

1465

<PRE>

1466

public static void defineClass(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

1467

java.lang.Class clazz,

1468

boolean sealed)

1469

throws java.lang.IllegalAccessException,

1470

java.lang.InstantiationException,

1471

java.lang.reflect.InvocationTargetException</PRE>

1472

<DL>

1473

<DD>Defines JavaScript objects from a Java class, optionally

1474

allowing sealing.

1475

1476

Similar to <code>defineClass(Scriptable scope, Class clazz)</code>

1477

except that sealing is allowed. An object that is sealed cannot have

1478

properties added or removed. Note that sealing is not allowed in

1479

the current ECMA/ISO language specification, but is likely for

1480

the next version.

1481

1482

1483

</DL>

1484

</DD>

1485

1486

<DT>Parameters:<DD><CODE>scope</CODE> - The scope in which to define the constructor<DD><CODE>clazz</CODE> - The Java class to use to define the JavaScript objects

1487

and properties. The class must implement Scriptable.<DD><CODE>sealed</CODE> - whether or not to create sealed standard objects that

1488

cannot be modified.

1489

<DT>Throws:

1490

<DD><CODE>java.lang.IllegalAccessException</CODE> - if access is not available

1491

to a reflected class member

1492

<DD><CODE>java.lang.InstantiationException</CODE> - if unable to instantiate

1493

the named class

1494

<DD><CODE>java.lang.reflect.InvocationTargetException</CODE> - if an exception is thrown

1495

during execution of methods of the named class<DT>Since:</DT>

1496

1497

</DL>

1498

</DD>

1499

</DL>

1500

<HR>

1501

1502

1503

defineProperty</H3>

1504

<PRE>

1505

public void defineProperty(java.lang.String propertyName,

1506

java.lang.Object value,

1507

int attributes)</PRE>

1508

<DL>

1509

<DD>Define a JavaScript property.

1510

1511

Creates the property with an initial value and sets its attributes.

1512

1513

1514

</DL>

1515

</DD>

1516

1517

<DT>Parameters:<DD><CODE>propertyName</CODE> - the name of the property to define.<DD><CODE>value</CODE> - the initial value of the property<DD><CODE>attributes</CODE> - the attributes of the JavaScript property<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)"><CODE>Scriptable.put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)</CODE></A></DL>

1518

</DD>

1519

</DL>

1520

<HR>

1521

1522

1523

defineProperty</H3>

1524

<PRE>

1525

public static void defineProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> destination,

1526

java.lang.String propertyName,

1527

java.lang.Object value,

1528

int attributes)</PRE>

1529

<DL>

1530

<DD>Utility method to add properties to arbitrary Scriptable object.

1531

If destination is instance of ScriptableObject, calls

1532

defineProperty there, otherwise calls put in destination

1533

ignoring attributes

1534

1535

1536

</DL>

1537

</DD>

1538

1539

</DL>

1540

</DD>

1541

</DL>

1542

<HR>

1543

1544

1545

defineProperty</H3>

1546

<PRE>

1547

public void defineProperty(java.lang.String propertyName,

1548

java.lang.Class clazz,

1549

int attributes)</PRE>

1550

<DL>

1551

<DD>Define a JavaScript property with getter and setter side effects.

1552

1553

If the setter is not found, the attribute READONLY is added to

1554

the given attributes.

1555

1556

The getter must be a method with zero parameters, and the setter, if

1557

found, must be a method with one parameter.

1558

1559

1560

</DL>

1561

</DD>

1562

1563

<DT>Parameters:<DD><CODE>propertyName</CODE> - the name of the property to define. This name

1564

also affects the name of the setter and getter

1565

to search for. If the propertyId is "foo", then

1566

<code>clazz</code> will be searched for "getFoo"

1567

and "setFoo" methods.<DD><CODE>clazz</CODE> - the Java class to search for the getter and setter<DD><CODE>attributes</CODE> - the attributes of the JavaScript property<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)"><CODE>Scriptable.put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)</CODE></A></DL>

1568

</DD>

1569

</DL>

1570

<HR>

1571

1572

1573

defineProperty</H3>

1574

<PRE>

1575

public void defineProperty(java.lang.String propertyName,

1576

java.lang.Object delegateTo,

1577

java.lang.reflect.Method getter,

1578

java.lang.reflect.Method setter,

1579

int attributes)</PRE>

1580

<DL>

1581

<DD>Define a JavaScript property.

1582

1583

Use this method only if you wish to define getters and setters for

1584

a given property in a ScriptableObject. To create a property without

1585

special getter or setter side effects, use

1586

<code>defineProperty(String,int)</code>.

1587

1588

If <code>setter</code> is null, the attribute READONLY is added to

1589

the given attributes.

1590

1591

Several forms of getters or setters are allowed. In all cases the

1592

type of the value parameter can be any one of the following types:

1593

Object, String, boolean, Scriptable, byte, short, int, long, float,

1594

or double. The runtime will perform appropriate conversions based

1595

upon the type of the parameter (see description in FunctionObject).

1596

The first forms are nonstatic methods of the class referred to

1597

by 'this':

1598

<pre>

1599

Object getFoo();

1600

void setFoo(SomeType value);</pre>

1601

Next are static methods that may be of any class; the object whose

1602

property is being accessed is passed in as an extra argument:

1603

<pre>

1604

static Object getFoo(ScriptableObject obj);

1605

static void setFoo(ScriptableObject obj, SomeType value);</pre>

1606

Finally, it is possible to delegate to another object entirely using

1607

the <code>delegateTo</code> parameter. In this case the methods are

1608

nonstatic methods of the class delegated to, and the object whose

1609

property is being accessed is passed in as an extra argument:

1610

<pre>

1611

Object getFoo(ScriptableObject obj);

1612

void setFoo(ScriptableObject obj, SomeType value);</pre>

1613

1614

1615

</DL>

1616

</DD>

1617

1618

<DT>Parameters:<DD><CODE>propertyName</CODE> - the name of the property to define.<DD><CODE>delegateTo</CODE> - an object to call the getter and setter methods on,

1619

or null, depending on the form used above.<DD><CODE>getter</CODE> - the method to invoke to get the value of the property<DD><CODE>setter</CODE> - the method to invoke to set the value of the property<DD><CODE>attributes</CODE> - the attributes of the JavaScript property</DL>

1620

</DD>

1621

</DL>

1622

<HR>

1623

1624

1625

defineFunctionProperties</H3>

1626

<PRE>

1627

public void defineFunctionProperties(java.lang.String[] names,

1628

java.lang.Class clazz,

1629

int attributes)</PRE>

1630

<DL>

1631

<DD>Search for names in a class, adding the resulting methods

1632

as properties.

1633

1634

Uses reflection to find the methods of the given names. Then

1635

FunctionObjects are constructed from the methods found, and

1636

are added to this object as properties with the given names.

1637

1638

1639

</DL>

1640

</DD>

1641

1642

<DT>Parameters:<DD><CODE>names</CODE> - the names of the Methods to add as function properties<DD><CODE>clazz</CODE> - the class to search for the Methods<DD><CODE>attributes</CODE> - the attributes of the new properties<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/FunctionObject.html" title="class in org.mozilla.javascript"><CODE>FunctionObject</CODE></A></DL>

1643

</DD>

1644

</DL>

1645

<HR>

1646

1647

1648

getObjectPrototype</H3>

1649

<PRE>

1650

public static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getObjectPrototype(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</PRE>

1651

<DL>

1652

<DD>Get the Object.prototype property.

1653

See ECMA 15.2.4.

1654

1655

1656

</DL>

1657

</DD>

1658

1659

</DL>

1660

</DD>

1661

</DL>

1662

<HR>

1663

1664

1665

getFunctionPrototype</H3>

1666

<PRE>

1667

public static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getFunctionPrototype(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope)</PRE>

1668

<DL>

1669

<DD>Get the Function.prototype property.

1670

See ECMA 15.3.4.

1671

1672

1673

</DL>

1674

</DD>

1675

1676

</DL>

1677

</DD>

1678

</DL>

1679

<HR>

1680

1681

1682

getClassPrototype</H3>

1683

<PRE>

1684

public static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getClassPrototype(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

1685

java.lang.String className)</PRE>

1686

<DL>

1687

<DD>Get the prototype for the named class.

1688

1689

For example, <code>getClassPrototype(s, "Date")</code> will first

1690

walk up the parent chain to find the outermost scope, then will

1691

search that scope for the Date constructor, and then will

1692

return Date.prototype. If any of the lookups fail, or

1693

the prototype is not a JavaScript object, then null will

1694

be returned.

1695

1696

1697

</DL>

1698

</DD>

1699

1700

<DT>Parameters:<DD><CODE>scope</CODE> - an object in the scope chain<DD><CODE>className</CODE> - the name of the constructor

1701

<DT>Returns:<DD>the prototype for the named class, or null if it

1702

cannot be found.</DL>

1703

</DD>

1704

</DL>

1705

<HR>

1706

1707

1708

getTopLevelScope</H3>

1709

<PRE>

1710

public static <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> getTopLevelScope(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj)</PRE>

1711

<DL>

1712

<DD>Get the global scope.

1713

1714

Walks the parent scope chain to find an object with a null

1715

parent scope (the global object).

1716

1717

1718

</DL>

1719

</DD>

1720

1721

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object

1722

<DT>Returns:<DD>the corresponding global scope</DL>

1723

</DD>

1724

</DL>

1725

<HR>

1726

1727

1728

sealObject</H3>

1729

<PRE>

1730

public void sealObject()</PRE>

1731

<DL>

1732

<DD>Seal this object.

1733

1734

A sealed object may not have properties added or removed. Once

1735

an object is sealed it may not be unsealed.

1736

1737

1738

</DL>

1739

</DD>

1740

1741

<DT>Since:</DT>

1742

1743

</DL>

1744

</DD>

1745

</DL>

1746

<HR>

1747

1748

1749

isSealed</H3>

1750

<PRE>

1751

public final boolean isSealed()</PRE>

1752

<DL>

1753

<DD>Return true if this object is sealed.

1754

1755

It is an error to attempt to add or remove properties to

1756

a sealed object.

1757

1758

1759

</DL>

1760

</DD>

1761

1762

1763

<DT>Returns:<DD>true if sealed, false otherwise.<DT>Since:</DT>

1764

1765

</DL>

1766

</DD>

1767

</DL>

1768

<HR>

1769

1770

1771

getProperty</H3>

1772

<PRE>

1773

public static java.lang.Object getProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1774

java.lang.String name)</PRE>

1775

<DL>

1776

<DD>Gets a named property from an object or any object in its prototype chain.

1777

1778

Searches the prototype chain for a property named <code>name</code>.

1779

1780

1781

1782

</DL>

1783

</DD>

1784

1785

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>name</CODE> - a property name

1786

<DT>Returns:<DD>the value of a property with name <code>name</code> found in

1787

<code>obj</code> or any object in its prototype chain, or

1788

<code>Scriptable.NOT_FOUND</code> if not found<DT>Since:</DT>

1789

1790

</DL>

1791

</DD>

1792

</DL>

1793

<HR>

1794

1795

1796

getProperty</H3>

1797

<PRE>

1798

public static java.lang.Object getProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1799

int index)</PRE>

1800

<DL>

1801

<DD>Gets an indexed property from an object or any object in its prototype chain.

1802

1803

Searches the prototype chain for a property with integral index

1804

<code>index</code>. Note that if you wish to look for properties with numerical

1805

but non-integral indicies, you should use getProperty(Scriptable,String) with

1806

the string value of the index.

1807

1808

1809

1810

</DL>

1811

</DD>

1812

1813

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>index</CODE> - an integral index

1814

<DT>Returns:<DD>the value of a property with index <code>index</code> found in

1815

<code>obj</code> or any object in its prototype chain, or

1816

<code>Scriptable.NOT_FOUND</code> if not found<DT>Since:</DT>

1817

1818

</DL>

1819

</DD>

1820

</DL>

1821

<HR>

1822

1823

1824

hasProperty</H3>

1825

<PRE>

1826

public static boolean hasProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1827

java.lang.String name)</PRE>

1828

<DL>

1829

<DD>Returns whether a named property is defined in an object or any object

1830

in its prototype chain.

1831

1832

Searches the prototype chain for a property named <code>name</code>.

1833

1834

1835

1836

</DL>

1837

</DD>

1838

1839

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>name</CODE> - a property name

1840

<DT>Returns:<DD>the true if property was found<DT>Since:</DT>

1841

1842

</DL>

1843

</DD>

1844

</DL>

1845

<HR>

1846

1847

1848

hasProperty</H3>

1849

<PRE>

1850

public static boolean hasProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1851

int index)</PRE>

1852

<DL>

1853

<DD>Returns whether an indexed property is defined in an object or any object

1854

in its prototype chain.

1855

1856

Searches the prototype chain for a property with index <code>index</code>.

1857

1858

1859

1860

</DL>

1861

</DD>

1862

1863

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>index</CODE> - a property index

1864

<DT>Returns:<DD>the true if property was found<DT>Since:</DT>

1865

1866

</DL>

1867

</DD>

1868

</DL>

1869

<HR>

1870

1871

1872

putProperty</H3>

1873

<PRE>

1874

public static void putProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1875

java.lang.String name,

1876

java.lang.Object value)</PRE>

1877

<DL>

1878

<DD>Puts a named property in an object or in an object in its prototype chain.

1879

1880

Seaches for the named property in the prototype chain. If it is found,

1881

the value of the property is changed. If it is not found, a new

1882

property is added in <code>obj</code>.

1883

1884

1885

</DL>

1886

</DD>

1887

1888

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>name</CODE> - a property name<DD><CODE>value</CODE> - any JavaScript value accepted by Scriptable.put<DT>Since:</DT>

1889

1890

</DL>

1891

</DD>

1892

</DL>

1893

<HR>

1894

1895

1896

putProperty</H3>

1897

<PRE>

1898

public static void putProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1899

int index,

1900

java.lang.Object value)</PRE>

1901

<DL>

1902

<DD>Puts an indexed property in an object or in an object in its prototype chain.

1903

1904

Seaches for the indexed property in the prototype chain. If it is found,

1905

the value of the property is changed. If it is not found, a new

1906

property is added in <code>obj</code>.

1907

1908

1909

</DL>

1910

</DD>

1911

1912

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>index</CODE> - a property index<DD><CODE>value</CODE> - any JavaScript value accepted by Scriptable.put<DT>Since:</DT>

1913

1914

</DL>

1915

</DD>

1916

</DL>

1917

<HR>

1918

1919

1920

deleteProperty</H3>

1921

<PRE>

1922

public static boolean deleteProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1923

java.lang.String name)</PRE>

1924

<DL>

1925

<DD>Removes the property from an object or its prototype chain.

1926

1927

Searches for a property with <code>name</code> in obj or

1928

its prototype chain. If it is found, the object's delete

1929

method is called.

1930

1931

1932

</DL>

1933

</DD>

1934

1935

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>name</CODE> - a property name

1936

<DT>Returns:<DD>true if the property doesn't exist or was successfully removed<DT>Since:</DT>

1937

1938

</DL>

1939

</DD>

1940

</DL>

1941

<HR>

1942

1943

1944

deleteProperty</H3>

1945

<PRE>

1946

public static boolean deleteProperty(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1947

int index)</PRE>

1948

<DL>

1949

<DD>Removes the property from an object or its prototype chain.

1950

1951

Searches for a property with <code>index</code> in obj or

1952

its prototype chain. If it is found, the object's delete

1953

method is called.

1954

1955

1956

</DL>

1957

</DD>

1958

1959

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object<DD><CODE>index</CODE> - a property index

1960

<DT>Returns:<DD>true if the property doesn't exist or was successfully removed<DT>Since:</DT>

1961

1962

</DL>

1963

</DD>

1964

</DL>

1965

<HR>

1966

1967

1968

getPropertyIds</H3>

1969

<PRE>

1970

public static java.lang.Object[] getPropertyIds(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj)</PRE>

1971

<DL>

1972

<DD>Returns an array of all ids from an object and its prototypes.

1973

1974

1975

1976

</DL>

1977

</DD>

1978

1979

<DT>Parameters:<DD><CODE>obj</CODE> - a JavaScript object

1980

<DT>Returns:<DD>an array of all ids from all object in the prototype chain.

1981

If a given id occurs multiple times in the prototype chain,

1982

it will occur only once in this list.<DT>Since:</DT>

1983

1984

</DL>

1985

</DD>

1986

</DL>

1987

<HR>

1988

1989

1990

callMethod</H3>

1991

<PRE>

1992

public static java.lang.Object callMethod(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

1993

java.lang.String methodName,

1994

java.lang.Object[] args)</PRE>

1995

<DL>

1996

<DD>Call a method of an object.

1997

1998

1999

</DL>

2000

</DD>

2001

2002

<DT>Parameters:<DD><CODE>obj</CODE> - the JavaScript object<DD><CODE>methodName</CODE> - the name of the function property<DD><CODE>args</CODE> - the arguments for the call<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/Context.html#getCurrentContext()"><CODE>Context.getCurrentContext()</CODE></A></DL>

2003

</DD>

2004

</DL>

2005

<HR>

2006

2007

2008

callMethod</H3>

2009

<PRE>

2010

public static java.lang.Object callMethod(<A HREF="../../../org/mozilla/javascript/Context.html" title="class in org.mozilla.javascript">Context</A> cx,

2011

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> obj,

2012

java.lang.String methodName,

2013

java.lang.Object[] args)</PRE>

2014

<DL>

2015

<DD>Call a method of an object.

2016

2017

2018

</DL>

2019

</DD>

2020

2021

<DT>Parameters:<DD><CODE>cx</CODE> - the Context object associated with the current thread.<DD><CODE>obj</CODE> - the JavaScript object<DD><CODE>methodName</CODE> - the name of the function property<DD><CODE>args</CODE> - the arguments for the call</DL>

2022

</DD>

2023

</DL>

2024

<HR>

2025

2026

2027

getAssociatedValue</H3>

2028

<PRE>

2029

public final java.lang.Object getAssociatedValue(java.lang.Object key)</PRE>

2030

<DL>

2031

<DD>Get arbitrary application-specific value associated with this object.

2032

2033

2034

</DL>

2035

</DD>

2036

2037

<DT>Parameters:<DD><CODE>key</CODE> - key object to select particular value.<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#associateValue(java.lang.Object, java.lang.Object)"><CODE>associateValue(Object key, Object value)</CODE></A></DL>

2038

</DD>

2039

</DL>

2040

<HR>

2041

2042

2043

getTopScopeValue</H3>

2044

<PRE>

2045

public static java.lang.Object getTopScopeValue(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> scope,

2046

java.lang.Object key)</PRE>

2047

<DL>

2048

<DD>Get arbitrary application-specific value associated with the top scope

2049

of the given scope.

2050

The method first calls <A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getTopLevelScope(org.mozilla.javascript.Scriptable)"><CODE>getTopLevelScope(Scriptable scope)</CODE></A>

2051

and then searches the prototype chain of the top scope for the first

2052

object containing the associated value with the given key.

2053

2054

2055

</DL>

2056

</DD>

2057

2058

<DT>Parameters:<DD><CODE>scope</CODE> - the starting scope.<DD><CODE>key</CODE> - key object to select particular value.<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAssociatedValue(java.lang.Object)"><CODE>getAssociatedValue(Object key)</CODE></A></DL>

2059

</DD>

2060

</DL>

2061

<HR>

2062

2063

2064

associateValue</H3>

2065

<PRE>

2066

public final java.lang.Object associateValue(java.lang.Object key,

2067

java.lang.Object value)</PRE>

2068

<DL>

2069

<DD>Associate arbitrary application-specific value with this object.

2070

Value can only be associated with the given object and key only once.

2071

The method ignores any subsequent attempts to change the already

2072

associated value.

2073

The associated values are not serilized.

2074

2075

2076

</DL>

2077

</DD>

2078

2079

<DT>Parameters:<DD><CODE>key</CODE> - key object to select particular value.<DD><CODE>value</CODE> - the value to associate

2080

<DT>Returns:<DD>the passed value if the method is called first time for the

2081

given key or old value for any subsequent calls.<DT>See Also:<DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getAssociatedValue(java.lang.Object)"><CODE>getAssociatedValue(Object key)</CODE></A></DL>

2082

</DD>

2083

</DL>

2084

2085

<HR>

2086

2087

2088

2089

2090

2091

2092

<TR>

2093

2094

2095

2096

2097

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A> </TD>

2098

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>

2099

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>

2100

2101

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A> </TD>

2102

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A> </TD>

2103

2104

</TR>

2105

</TABLE>

2106

</TD>

2107

2108

2109

</TD>

2110

</TR>

2111

2112

<TR>

2113

2114

<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">PREV CLASS</A>

2115

<A HREF="../../../org/mozilla/javascript/SecurityController.html" title="class in org.mozilla.javascript">NEXT CLASS</A></TD>

2116

2117

<A HREF="../../../index.html" target="_top">FRAMES</A>

2118

<A HREF="ScriptableObject.html" target="_top">NO FRAMES</A>

2119

2120

<!--

2121

if(window==top) {

2122

document.writeln('<A HREF="../../../allclasses-noframe.html">All Classes</A>');

2123

}

2124

//-->

2125

</SCRIPT>

2126

2127

<A HREF="../../../allclasses-noframe.html">All Classes</A>

2128

</NOSCRIPT>

2129

2130

</TD>

2131

</TR>

2132

<TR>

2133

2134

SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></TD>

2135

2136

DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></TD>

2137

</TR>

2138

</TABLE>

2139

2140

2141

2142

<HR>

2143

2144

</BODY>

2145

</HTML>

Older »