# khtml Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KJavaApplet Class Reference

A Java applet. More...

`#include <kjavaapplet.h>`

Inheritance diagram for KJavaApplet:

[legend]
Collaboration diagram for KJavaApplet:

[legend]
List of all members.

## Public Types

enum | AppletState { UNKNOWN = 0, CLASS_LOADED = 1, INSTANCIATED = 2, INITIALIZED = 3, STARTED = 4, STOPPED = 5, DESTROYED = 6 }

## Signals

void | jsEvent (const QStringList &args)

## Public Member Functions

| KJavaApplet (KJavaAppletWidget *_parent, KJavaAppletContext *_context=0)
void | setAppletContext (KJavaAppletContext *_context)
void | setAppletClass (const QString &clazzName)
QString & | appletClass ()
void | setBaseURL (const QString &base)
QString & | baseURL ()
void | setCodeBase (const QString &codeBase)
QString & | codeBase ()
void | setArchives (const QString &_archives)
QString & | archives ()
void | setAppletName (const QString &name)
QString & | appletName ()
void | setSize (QSize size)
QSize | size ()
void | setParameter (const QString &name, const QString &value)
QString & | parameter (const QString &name)
QMap< QString, QString > & | getParams ()
void | setWindowName (const QString &title)
QString & | getWindowName ()
void | resizeAppletWidget (int width, int height)
void | create ()
void | init ()
bool | isCreated ()
void | start ()
void | stop ()
int | appletId ()
void | setAppletId (int id)
KJavaAppletContext * | getContext () const
void | setUser (const QString &_user)
const QString & | user () const
void | setPassword (const QString &_password)
const QString & | password () const
void | setAuthName (const QString &_auth)
const QString & | authName () const
void | stateChange (const int newState)
void | setFailed ()
AppletState | state () const
bool | failed () const
bool | isAlive () const
void | jsData (const QStringList &args)

## Detailed Description

A Java applet.

This class encapsulates the data the Applet Server needs to load the Applet class files, and set the proper size of the Applet. It also has an interface for applets to resize themselves.

Author:
  Richard J. Moore, rich@kde.org

  Wynn Wilkes, wynnw@kde.org

Definition at line 50 of file kjavaapplet.h.

## Member Function Documentation

void KJavaApplet::setAppletContext | ( | KJavaAppletContext * | _context | ) |

| Set the applet context'. Definition at line 78 of file kjavaapplet.cpp. References KJavaAppletContext::registerApplet().

void KJavaApplet::setAppletClass | ( | const QString & | clazzName | ) |

| Specify the name of the class file to run. For example 'Lake.class'. Definition at line 84 of file kjavaapplet.cpp. References QObject::className().

QString & KJavaApplet::appletClass | ( |  | ) |

| Get the name of the Class file the applet should run. Definition at line 89 of file kjavaapplet.cpp.

void KJavaApplet::setBaseURL | ( | const QString & | base | ) |

| Set the URL of the document embedding the applet. Definition at line 109 of file kjavaapplet.cpp. References baseURL().

QString & KJavaApplet::baseURL | ( |  | ) |

| get the Base URL of the document embedding the applet Definition at line 114 of file kjavaapplet.cpp. Referenced by setBaseURL().

void KJavaApplet::setCodeBase | ( | const QString & | codeBase | ) |

| Set the codebase of the applet classes. Definition at line 119 of file kjavaapplet.cpp. References codeBase().

QString & KJavaApplet::codeBase | ( |  | ) |

| Get the codebase of the applet classes. Definition at line 124 of file kjavaapplet.cpp. Referenced by setCodeBase().

void KJavaApplet::setArchives | ( | const QString & | _archives | ) |

| Set the list of archives at the Applet's codebase to search in for class files and other resources. Definition at line 139 of file kjavaapplet.cpp.

QString & KJavaApplet::archives | ( |  | ) |

| Get the list of Archives that should be searched for class files and other resources. Definition at line 144 of file kjavaapplet.cpp.

void KJavaApplet::setAppletName | ( | const QString & | name | ) |

| Set the name the applet should be called in its context. Definition at line 161 of file kjavaapplet.cpp.

QString & KJavaApplet::appletName | ( |  | ) |

| Get the name the applet should be called in its context. Definition at line 176 of file kjavaapplet.cpp. Referenced by stateChange().

void KJavaApplet::setSize | ( | QSize | size | ) |

| Set the size of the applet. Definition at line 129 of file kjavaapplet.cpp.

QSize KJavaApplet::size | ( |  | ) |

| Get the size of the applet. Definition at line 134 of file kjavaapplet.cpp.

void KJavaApplet::setParameter | ( | const QString & | name,
|  | const QString & | value
| ) |

| Specify a parameter to be passed to the applet. Definition at line 99 of file kjavaapplet.cpp. References QMap::insert().

QString & KJavaApplet::parameter | ( | const QString & | name | ) |

| Look up the parameter value for the given Parameter. Returns QString::null if the name has not been set. Definition at line 94 of file kjavaapplet.cpp.

QMap< QString, QString > & KJavaApplet::getParams | ( |  | ) |

| Get a reference to the Paramaters and their values. Definition at line 104 of file kjavaapplet.cpp.

void KJavaApplet::setWindowName | ( | const QString & | title | ) |

| Set the window title for swallowing. Definition at line 166 of file kjavaapplet.cpp.

QString & KJavaApplet::getWindowName | ( |  | ) |

| Get the window title this applet should use. Definition at line 171 of file kjavaapplet.cpp.

void KJavaApplet::resizeAppletWidget | ( | int | width,
|  | int | height
| ) |

| Interface for applets to resize themselves. Definition at line 149 of file kjavaapplet.cpp. References endl(), jsData(), and kdDebug().

void KJavaApplet::create | ( |  | ) |

| Send message to AppletServer to create this applet's frame to be swallowed and download the applet classes. Definition at line 181 of file kjavaapplet.cpp. References KJavaAppletContext::create(). Referenced by KJavaAppletWidget::showApplet().

void KJavaApplet::init | ( |  | ) |

| Send message to AppletServer to Initialize and show this applet. Definition at line 188 of file kjavaapplet.cpp. References KJavaAppletContext::init().

bool KJavaApplet::isCreated | ( |  | ) |

| Returns status of applet- whether it's been created or not. Definition at line 73 of file kjavaapplet.cpp. Referenced by KJavaAppletWidget::showApplet().

void KJavaApplet::start | ( |  | ) |

| Run the applet. Definition at line 193 of file kjavaapplet.cpp. References KJavaAppletContext::start(). Referenced by stateChange().

void KJavaApplet::stop | ( |  | ) |

| Pause the applet. Definition at line 198 of file kjavaapplet.cpp. References KJavaAppletContext::stop().

int KJavaApplet::appletId | ( |  | ) |

| Returns the unique ID this applet is given. Definition at line 203 of file kjavaapplet.cpp.

void KJavaApplet::setAppletId | ( | int | id | ) |

| Set the applet ID. Definition at line 208 of file kjavaapplet.cpp.

void KJavaApplet::setUser | ( | const QString & | _user | ) | `[inline]`

| Get/Set the user name. Definition at line 209 of file kjavaapplet.h.

void KJavaApplet::setPassword | ( | const QString & | _password | ) | `[inline]`

| Get/Set the user password. Definition at line 215 of file kjavaapplet.h.

void KJavaApplet::setAuthName | ( | const QString & | _auth | ) | `[inline]`

| Get/Set the auth name. Definition at line 221 of file kjavaapplet.h.

void KJavaApplet::stateChange | ( | const int | newState | ) |

| called from the protocol engine changes the status according to the one on the java side. Do not call this yourself! Definition at line 213 of file kjavaapplet.cpp. References appletName(), endl(), kdError(), and start().

void KJavaApplet::jsData | ( | const QStringList & | args | ) | `[inline]`

| JavaScript coming from Java. Definition at line 237 of file kjavaapplet.h. Referenced by resizeAppletWidget().

The documentation for this class was generated from the following files:

- kjavaapplet.h
- kjavaapplet.cpp

This file is part of the documentation for khtml Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:33:26 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003