com.ibm.dse.desktop
Class Desktop

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Panel
                    |
                    +--java.applet.Applet
                          |
                          +--javax.swing.JApplet
                                |
                                +--com.ibm.dse.desktop.Desktop

public class Desktop
extends javax.swing.JApplet
implements DesktopComponent, java.awt.event.WindowListener

The Desktop class provides the top level object that builds the desktop layout based upon the definitions belonging to the rest of the elements in the desktop definition file. The Desktop class cannot be substituted by another class unless the whole set of classes directly related to it are copied to a different package. This process may be suggested in cases where additional functionality is required and changes to the base code might require an enormous effort. When the desktop is created and filled with all the components defined in the desktop XML file, it keeps a list of task information objects. This list allows the application and other internal desktop components to ask for specific task information. When a component that implements the TaskLauncher interface is added to the desktop, a new TaskInfo object is created and added to the list of task information objects.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JApplet
javax.swing.JApplet.AccessibleJApplet
 
Field Summary
protected  BookmarkArea bookmarkArea
          instance of BookmarkArea
protected  boolean change_language
           
static java.lang.String COMPID
          identifier of the Desktop trace
protected  int count
           
protected  int desktopHeight
           
protected  int desktopWidth
           
protected  boolean developerTime
           
protected static java.lang.String FAST_PATH_FORMAT_NAME
          name by default of the fast path format
protected  boolean file_exists
           
protected  java.lang.String finalizerClass
          name of the finalizer class
protected  java.lang.String finalizerMethod
          name of the finalizer metohd
 javax.help.HelpBroker hb
          instance of the HelpBroker
protected  java.lang.String helpFileURL
          URL of the help file
 javax.help.HelpSet hs
          instance of the HelpSet
protected  java.lang.String initializerClass
          name of the initializer class
protected  java.lang.String initializerMethod
          name of the initializer method
static java.lang.Class keyEventClass
          class of the keyEventClass
protected  java.lang.String lookandfeel
          look and feel of the Desktop
protected  MessageArea messageTextField
          instance of the MessageArea
protected  int nextX
          x location of the next component
protected  int nextY
          y location of the next component
protected  java.util.Hashtable nodeBeanTable
          collection of component of the Desktop kept by node
protected  java.awt.ComponentOrientation orientation
          group of packages where Desktop components can be defined
protected  java.lang.String packages
          group of packages where Desktop components can be defined
protected static boolean rebuild
           
protected  TaskArea taskArea
          instance of the TaskArea class
protected  java.util.Hashtable taskCodes
          collection of taskInfos kept by code
protected  java.util.Hashtable taskInfos
          collection of taskInfos kept by taskname
protected static Desktop theDesktop
          instance of Desktop class
protected  java.lang.String title
          title of the Desktop
protected  WorkingArea workingArea
          instance of the WorkingArea class
protected static java.lang.String XML_FILE
          name by default of the xml file
 
Fields inherited from class javax.swing.JApplet
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
Desktop()
          This constructor creates a Desktop object.
 
Method Summary
static int absoluteXcoor(java.awt.Container c)
          Gets the absolute x coordinate for the desktop.
static int absoluteYcoor(java.awt.Container c)
          Gets the absolute y coordinate for the desktop.
 void add(java.lang.Object o)
          Adds a component to the desktop.
 void addTaskInfo(TaskLauncher aTaskLauncher)
          Creates and adds a TaskInfo corresponding to aTaskLauncher and adds this TaskInfo to the desktop's taskInfos list.
static void block(java.lang.Object o)
          Allows you to block the desktop and shows the waiting cursor.
 void centerView()
          Centers the view in the display when the desktop is launched as an application (main method is used).
 void changeComponentOrientation(java.awt.ComponentOrientation o)
          Set the language-sensitive orientation that is to be used to order the elements within this component.
 int countNodes(org.w3c.dom.Node n)
          Returns the number of nodes built from the XML element definition.
 void createElement(org.w3c.dom.Node node)
          Creates an element instance defined in the XML file.
 boolean definesTask(TaskLauncher aTaskLauncher)
          This method returns true if aTaskLauncher defines a Task.
 void exitApplication()
          Allows you to exit the desktop application.
 java.lang.String getAppletInfo()
          Gets the applet information.
 BookmarkArea getBookmarkArea()
          Gets the BookmarkArea.
 java.lang.String getBookmarkId()
          Returns the value of the BookmarkId property.
 java.lang.Object getComponentByName(java.lang.String name)
          Gets a desktop component by its name.
 java.util.Vector getComponentsByClass(java.lang.Class c)
          Gets a desktop component by its class.
static Desktop getDesktop()
          Gets the desktop component.
 boolean getDeveloperTime()
          Returns the value of the developerTime property.
 java.lang.String getFileName()
          This method returns the name of the Desktop file
 java.awt.Container getFirstParent()
          This method returns the last Parent of the desktop.
 java.awt.Container getFirstParent(java.awt.Container comp)
          This method returns the last Parent of the components comp.
static javax.swing.JFrame getFrame()
          Gets the desktop frame.
static boolean getFrameworkInitialized()
          This method returns a boolean that indicates if Framework is initialized or not.
 java.lang.String getHelpFileURL()
          Gets the HelpSet file URL.
 javax.swing.ImageIcon getImageIcon(java.lang.Object o)
          Returns the image icon.
static javax.swing.JRootPane getJRootPane(javax.swing.JComponent c)
          Gets the fundamental component in the desktop container hierarchy.
static javax.swing.KeyStroke getKeyStroke(java.lang.String str)
          Gets a KeyStroke instance according to the externalizable string representation.
 java.lang.String getLookAndFeel()
          Returns the value of the lookandfeel property.
 java.util.Hashtable getNamedComponents()
          Gets the list of components ordered by name.
 java.awt.ComponentOrientation getOrientation()
          Returns the new orientation assigned to the Desktop.
 int getOriginalHeight()
          Returns the value of the originalHeight property.
 int getOriginalWidth()
          Returns the value of the width property.
 ProgressIndicator getProgressBean()
          Returns the initialization progress indicator window.
static boolean getShowProgressBar()
          Gets the boolean value that indicates whether the desktop initialization progress bar must be shown or not.
 TaskArea getTaskArea()
          Gets the task area.
 TaskInfo getTaskInfo(java.lang.Object o)
          Returns the TaskInfo corresponding for the Object o.
 TaskInfo getTaskInfo(TaskLauncher aTaskLauncher)
          Return the TaskInfo corresponding for the TaskLauncher aTaskLauncher.
 TaskInfo getTaskInfoByCode(java.lang.String code)
          Return the first TaskInfo from the taskinfos list which contains the code: code.
 java.lang.String getTitle()
          Returns the title.
 WorkingArea getWorkingArea()
          Gets the working area.
 void iniApplication()
          Initializes the application.
 void iniHelp()
          Launches a thread that initializes the Java help system.
 void iniLookAndFeel()
          Initializes with the current platform look and feel.
 void init()
          Handle the Applet init method.
 void initialize()
          Processes the initialization.
 void initTable()
          This method indicates which components are defined at this package.
 void iniXML()
          Parses and initializes the XML definition.
 boolean isMultiTasking()
          Indicates whether the application is multi-tasking or not.
static void main(java.lang.String[] args)
          Provides the main entrypoint.
 void manageNode(org.w3c.dom.Node node)
          Checks if a node is a text node or an element node.
 void openTask(java.lang.String op, java.lang.String sp, java.lang.String taskName, java.lang.String type)
          This method opens a new task with the operation op, the operation panel sp.
 void openTask(TaskInfo aTaskInfo, java.lang.String parameters, java.lang.String errorMessage)
          This method opens a new task describe by aTaskInfo.
 void openTask(TaskLauncher aTaskLauncher)
          This method opens a new task described by aTaskLauncher.
 void paint(java.awt.Graphics g)
          Transfer the focus to the first focusable component.
 boolean readXMLFromJAR()
          Returns the boolean value that indicates whether the XML file is read from a JAR or not.
 void reBuild()
          Removes all the components, parses, and initializes them again using the desktop XML definitions file.
 void regenerate()
          This method takes charge of change the language of all the labels of the Desktop, calling the setAtributes method..
 void removeAllComponents()
          This method removes all the components in the desktop.
 void setAttributes(java.lang.Object o, org.w3c.dom.Node node)
          Uses the node description to set the attributes of the Object o.
 void setBookmarkArea(BookmarkArea BMA)
          Sets the BookmarkArea.
 void setBookmarkId(java.lang.Object o)
          Sets the value of the bookmarkId property.
 void setDesktopLocale(java.util.Locale locale)
          This method sets the locale of the Desktop in runtime.
 void setDeveloperTime(java.lang.Object o)
          Sets the value of the developerTime property.
static void setFileName(java.lang.String s)
          This method sets the name of the Desktop file.
 void setFinalizerClass(java.lang.Object o)
          Sets the name of the desktop finalizing class.
 void setFinalizerMethod(java.lang.Object o)
          Sets the name of the desktop finalizing method.
static void setFrameworkInitialized(boolean aBoolean)
          Sets the boolean value that indicates if Framework is initialized or not.
 void setHeight(java.lang.Object o)
          Sets the text field height.
 void setHelpFileURL(java.lang.Object o)
          Sets the HeplSet file URL.
 void setInitializerClass(java.lang.Object o)
          Sets the name of the desktop initializing class.
 void setInitializerMethod(java.lang.Object o)
          Sets the name of the desktop initializing method.
 void setLookAndFeel(java.lang.Object laf)
          Sets the value of the lookandfeel property.
 void setMessageTextField(MessageArea t)
          Sets the message text field.
 void setMultiTasking(java.lang.Object o)
          Sets the property value that indicates whether the application is multi-tasking or not.
 void setOnInitialize(java.lang.Object o)
          Sets the specified Java script code that is executed when the component is initialized.
 void setOrientation(java.lang.Object o)
          Sets the value of the orientation property.
 void setOriginalHeight(int height)
          Sets the value of the originalHeight property.
 void setOriginalWidth(int width)
          Sets the value of the originalWidht property.
 void setPackages(java.lang.Object o)
          Concatenates the desktop package name with the specified class name.
 void setReadXMLFromJAR(boolean readFromJAR)
          Sets the boolean value that indicates whether the XML file is read from a JAR file or not.
static void setShowProgressBar(boolean aBoolean)
          Sets the boolean value that indicates whether the desktop initialization progress bar must be shown or not.
 void setTitle(java.lang.Object o)
          Sets the title.
 void setWidth(java.lang.Object o)
          Sets the text field width.
 void showHelp(java.lang.String s)
          Shows the help section that corresponds to the specified ID.
 void showMessage(java.lang.String s)
          Shows the message s in the desktop text field.
 void showMessage(java.lang.String s, int i)
          Shows the message s in the desktop text field.
 void showProgressBar()
          Shows the progress bar.
static void showTraceMessage(int level, int type, java.lang.String message)
          Shows the message message in the trace window or in the system console.
static void showTraceMessage(int level, int type, java.lang.String message, java.lang.Throwable exception)
          Shows the message message in the trace window or in the system console.
static void unBlock(java.lang.Object o)
          Unblocks the desktop and shows the default cursor.
 void windowActivated(java.awt.event.WindowEvent e)
          Invoked when a window is activated.
 void windowClosed(java.awt.event.WindowEvent e)
          Invoked when a window has been closed.
 void windowClosing(java.awt.event.WindowEvent e)
          Invoked when a window is in the process of being closed.
 void windowDeactivated(java.awt.event.WindowEvent e)
          Invoked when a window is deactivated.
 void windowDeiconified(java.awt.event.WindowEvent e)
          Invoked when a window is de-iconified.
 void windowIconified(java.awt.event.WindowEvent e)
          Invoked when a window is iconified.
 void windowOpened(java.awt.event.WindowEvent e)
          Invoked when a window has been opened.
 
Methods inherited from class javax.swing.JApplet
addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.applet.Applet
destroy, getAppletContext, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop
 
Methods inherited from class java.awt.Panel
addNotify
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setCursor, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

packages

protected java.lang.String packages
group of packages where Desktop components can be defined

orientation

protected java.awt.ComponentOrientation orientation
group of packages where Desktop components can be defined

theDesktop

protected static Desktop theDesktop
instance of Desktop class

nextX

protected int nextX
x location of the next component

nextY

protected int nextY
y location of the next component

XML_FILE

protected static java.lang.String XML_FILE
name by default of the xml file

FAST_PATH_FORMAT_NAME

protected static final java.lang.String FAST_PATH_FORMAT_NAME
name by default of the fast path format

taskArea

protected TaskArea taskArea
instance of the TaskArea class

workingArea

protected WorkingArea workingArea
instance of the WorkingArea class

initializerClass

protected java.lang.String initializerClass
name of the initializer class

initializerMethod

protected java.lang.String initializerMethod
name of the initializer method

finalizerClass

protected java.lang.String finalizerClass
name of the finalizer class

finalizerMethod

protected java.lang.String finalizerMethod
name of the finalizer metohd

helpFileURL

protected java.lang.String helpFileURL
URL of the help file

lookandfeel

protected java.lang.String lookandfeel
look and feel of the Desktop

messageTextField

protected MessageArea messageTextField
instance of the MessageArea

taskInfos

protected java.util.Hashtable taskInfos
collection of taskInfos kept by taskname

taskCodes

protected java.util.Hashtable taskCodes
collection of taskInfos kept by code

title

protected java.lang.String title
title of the Desktop

nodeBeanTable

protected java.util.Hashtable nodeBeanTable
collection of component of the Desktop kept by node

keyEventClass

public static transient java.lang.Class keyEventClass
class of the keyEventClass

hs

public javax.help.HelpSet hs
instance of the HelpSet

hb

public javax.help.HelpBroker hb
instance of the HelpBroker

bookmarkArea

protected BookmarkArea bookmarkArea
instance of BookmarkArea

rebuild

protected static boolean rebuild

COMPID

public static final java.lang.String COMPID
identifier of the Desktop trace

file_exists

protected boolean file_exists

change_language

protected boolean change_language

count

protected int count

developerTime

protected boolean developerTime

desktopWidth

protected int desktopWidth

desktopHeight

protected int desktopHeight
Constructor Detail

Desktop

public Desktop()
This constructor creates a Desktop object.
Method Detail

absoluteXcoor

public static int absoluteXcoor(java.awt.Container c)
Gets the absolute x coordinate for the desktop.
Parameters:
c - java.awt.Container
Returns:
int

absoluteYcoor

public static int absoluteYcoor(java.awt.Container c)
Gets the absolute y coordinate for the desktop.
Parameters:
c - java.awt.Container
Returns:
int

add

public void add(java.lang.Object o)
Adds a component to the desktop.
Specified by:
add in interface DesktopComponent
Parameters:
o - java.lang.Object

addTaskInfo

public void addTaskInfo(TaskLauncher aTaskLauncher)
Creates and adds a TaskInfo corresponding to aTaskLauncher and adds this TaskInfo to the desktop's taskInfos list.
Parameters:
aTaskLauncher - TaskLauncher

block

public static void block(java.lang.Object o)
Allows you to block the desktop and shows the waiting cursor.
Parameters:
o - java.lang.Object

centerView

public void centerView()
Centers the view in the display when the desktop is launched as an application (main method is used).

changeComponentOrientation

public void changeComponentOrientation(java.awt.ComponentOrientation o)
Set the language-sensitive orientation that is to be used to order the elements within this component.
Parameters:
o - ComponentOrientation

countNodes

public int countNodes(org.w3c.dom.Node n)
Returns the number of nodes built from the XML element definition.
Parameters:
n - org.w3c.dom.Node
Returns:
int

createElement

public void createElement(org.w3c.dom.Node node)
Creates an element instance defined in the XML file.
Parameters:
node - org.w3c.dom.Node

definesTask

public boolean definesTask(TaskLauncher aTaskLauncher)
This method returns true if aTaskLauncher defines a Task.

To define a Task a TaskLauncher has to define all its attributes.

Parameters:
aTaskLauncher - com.ibm.dse.desktop.TaskLauncher
Returns:
boolean

exitApplication

public void exitApplication()
Allows you to exit the desktop application.

getAppletInfo

public java.lang.String getAppletInfo()
Gets the applet information.
Overrides:
getAppletInfo in class java.applet.Applet
Returns:
java.lang.String

getBookmarkArea

public BookmarkArea getBookmarkArea()
Gets the BookmarkArea.
Returns:
com.ibm.dse.desktop.BookmarkArea

getBookmarkId

public java.lang.String getBookmarkId()
Returns the value of the BookmarkId property.
Returns:
com.ibm.dse.desktop.BookmarkId - The current value of BookmarkId.

getComponentByName

public java.lang.Object getComponentByName(java.lang.String name)
Gets a desktop component by its name.
Parameters:
name - java.lang.String
Returns:
java.lang.Object

getComponentsByClass

public java.util.Vector getComponentsByClass(java.lang.Class c)
Gets a desktop component by its class.
Parameters:
level - int
Returns:
java.util.Vector

getDesktop

public static Desktop getDesktop()
Gets the desktop component.
Returns:
com.ibm.dse.desktop.Desktop

getDeveloperTime

public boolean getDeveloperTime()
Returns the value of the developerTime property.
Returns:
boolean - The current value of developerTime.

getFileName

public java.lang.String getFileName()
This method returns the name of the Desktop file
Returns:
String

getFirstParent

public java.awt.Container getFirstParent()
This method returns the last Parent of the desktop.
Returns:
java.awt.Container

getFirstParent

public java.awt.Container getFirstParent(java.awt.Container comp)
This method returns the last Parent of the components comp.

Returns:
java.awt.Container

getFrame

public static javax.swing.JFrame getFrame()
Gets the desktop frame. It should be used when the desktop is launched as an application (main method), not as an applet (frame = null).
Returns:
com.sun.java.swing.JFrame

getFrameworkInitialized

public static boolean getFrameworkInitialized()
This method returns a boolean that indicates if Framework is initialized or not.
Returns:
boolean

getHelpFileURL

public java.lang.String getHelpFileURL()
Gets the HelpSet file URL.
Returns:
java.lang.String

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.lang.Object o)
Returns the image icon.
Parameters:
o - java.lang.Object
Returns:
com.sun.java.swing.ImageIcon

getJRootPane

public static javax.swing.JRootPane getJRootPane(javax.swing.JComponent c)
Gets the fundamental component in the desktop container hierarchy.
Parameters:
c - com.sun.java.swing.JComponent
Returns:
com.sun.java.swing.JRootPane

getKeyStroke

public static javax.swing.KeyStroke getKeyStroke(java.lang.String str)
Gets a KeyStroke instance according to the externalizable string representation.
Parameters:
java.lang.String - str
Returns:
com.sun.java.swing.KeyStroke

getLookAndFeel

public java.lang.String getLookAndFeel()
Returns the value of the lookandfeel property.
Returns:
int - The current value of lookandfeel.

getNamedComponents

public java.util.Hashtable getNamedComponents()
Gets the list of components ordered by name.
Returns:
Hastable

getOrientation

public java.awt.ComponentOrientation getOrientation()
Returns the new orientation assigned to the Desktop.
Returns:
java.awt.ComponentOrientation orientation

getOriginalHeight

public int getOriginalHeight()
Returns the value of the originalHeight property.

The originalHeight is the initial height of the Desktop before any modification.

Returns:
int - The current value of originalHeight.

getOriginalWidth

public int getOriginalWidth()
Returns the value of the width property.

The originalWidth is the initial width of the Desktop befor any modificaction.

Returns:
int - The current value of width.

getProgressBean

public ProgressIndicator getProgressBean()
Returns the initialization progress indicator window.
Returns:
com.ibm.dse.base.ProgressIndicator

getShowProgressBar

public static boolean getShowProgressBar()
Gets the boolean value that indicates whether the desktop initialization progress bar must be shown or not.
Returns:
boolean

getTaskArea

public TaskArea getTaskArea()
Gets the task area.
Returns:
TaskArea

getTaskInfo

public TaskInfo getTaskInfo(TaskLauncher aTaskLauncher)
Return the TaskInfo corresponding for the TaskLauncher aTaskLauncher.

Parameters:
aTaskLauncher - TaskLauncher
Returns:
com.ibm.dse.desktop.TaskInfo

getTaskInfo

public TaskInfo getTaskInfo(java.lang.Object o)
Returns the TaskInfo corresponding for the Object o.

Parameters:
o - java.lang.Object
Returns:
com.ibm.dse.desktop.TaskInfo

getTaskInfoByCode

public TaskInfo getTaskInfoByCode(java.lang.String code)
Return the first TaskInfo from the taskinfos list which contains the code: code.

If no TaskInfo corresponding to this code is found it returns null.

Parameters:
code - java.lang.String
Returns:
com.ibm.dse.desktop.TaskInfo

getTitle

public java.lang.String getTitle()
Returns the title.
Returns:
java.lang.String

getWorkingArea

public WorkingArea getWorkingArea()
Gets the working area.
Returns:
WorkingArea

iniApplication

public void iniApplication()
                    throws java.lang.Exception
Initializes the application.
Throws:
java.lang.Exception -  

iniHelp

public void iniHelp()
Launches a thread that initializes the Java help system.

iniLookAndFeel

public void iniLookAndFeel()
                    throws java.lang.Exception
Initializes with the current platform look and feel.
Throws:
java.lang.Exception -  

init

public void init()
Handle the Applet init method.
Overrides:
init in class java.applet.Applet

initialize

public void initialize()
                throws java.lang.Exception
Processes the initialization.
Throws:
java.lang.Exception -  

initTable

public void initTable()
This method indicates which components are defined at this package.

iniXML

public void iniXML()
            throws java.lang.Exception
Parses and initializes the XML definition.
Throws:
java.lang.Exception -  

isMultiTasking

public boolean isMultiTasking()
Indicates whether the application is multi-tasking or not.
Returns:
boolean

main

public static void main(java.lang.String[] args)
Provides the main entrypoint. It starts the part when it is run as an application.
Parameters:
args - java.lang.String[]

manageNode

public void manageNode(org.w3c.dom.Node node)
Checks if a node is a text node or an element node. If a node is an element node then it creates the corresponding element instance.
Parameters:
node - Nodeorg.w3c.dom.Node

openTask

public void openTask(TaskInfo aTaskInfo,
                     java.lang.String parameters,
                     java.lang.String errorMessage)
This method opens a new task describe by aTaskInfo.

If parameters is specified the method will try to create the task's operation with the parameters specified by parameters. errorMessage specifies the message to display if the creation of the task is stopped by an exception.

Parameters:
aTaskInfo - com.ibm.dse.desktop.TaskInfo
parameters - java.lang.String
errorMessage - java.lang.String.

openTask

public void openTask(TaskLauncher aTaskLauncher)
This method opens a new task described by aTaskLauncher.

If aTaskLauncher doesn't specify all the attribues needed to open a new task the method will optain this information from the taskInfos list.

Parameters:
aTaskLauncher - com.ibm.dse.desktop.TaskLauncher

openTask

public void openTask(java.lang.String op,
                     java.lang.String sp,
                     java.lang.String taskName,
                     java.lang.String type)
This method opens a new task with the operation op, the operation panel sp.

It uses the parameter taskName to find a short and a long description for this task. If there is no TaskInfo corresponding to the taskName the new task has the taskname as description.

Parameters:
op - Operation
sp - SmartPanel
taskName - java.lang.String

paint

public void paint(java.awt.Graphics g)
Transfer the focus to the first focusable component.
Overrides:
paint in class java.awt.Container
Parameters:
g - java.awt.Graphics

readXMLFromJAR

public boolean readXMLFromJAR()
Returns the boolean value that indicates whether the XML file is read from a JAR or not.
Returns:
boolean

reBuild

public void reBuild()
Removes all the components, parses, and initializes them again using the desktop XML definitions file.

regenerate

public void regenerate()
This method takes charge of change the language of all the labels of the Desktop, calling the setAtributes method..

removeAllComponents

public void removeAllComponents()
This method removes all the components in the desktop.

When there is any opened task in the desktop, the TaskArea and the WorkingArea won't be removed. This method is currently used to remove all the elements of the desktop before rebuilding it.


setAttributes

public void setAttributes(java.lang.Object o,
                          org.w3c.dom.Node node)
Uses the node description to set the attributes of the Object o.

The object o must have setters for all the attributes described in the node. If it doesn't the method will show a warning message.

Parameters:
o - java.lang.Object
node - org.w3c.dom.Node

setBookmarkArea

public void setBookmarkArea(BookmarkArea BMA)
Sets the BookmarkArea.
Parameters:
com.ibm.dse.desktop.BookmarkArea -  

setBookmarkId

public void setBookmarkId(java.lang.Object o)
Sets the value of the bookmarkId property.

The BookmarkId is the personal identifier for each Desktop user.


setDesktopLocale

public void setDesktopLocale(java.util.Locale locale)
This method sets the locale of the Desktop in runtime.
Parameters:
locale - Locale

setDeveloperTime

public void setDeveloperTime(java.lang.Object o)
Sets the value of the developerTime property.
Parameters:
developerTime - boolean. The new value of the property.

setFileName

public static void setFileName(java.lang.String s)
This method sets the name of the Desktop file. This name is the name of the xml file, and the path will be the path defined at the dse.ini.
Parameters:
String - s

setFinalizerClass

public void setFinalizerClass(java.lang.Object o)
Sets the name of the desktop finalizing class.
Parameters:
o - java.lang.Object

setFinalizerMethod

public void setFinalizerMethod(java.lang.Object o)
Sets the name of the desktop finalizing method.
Parameters:
o - java.lang.Object

setFrameworkInitialized

public static void setFrameworkInitialized(boolean aBoolean)
Sets the boolean value that indicates if Framework is initialized or not.
Parameters:
aBoolean - boolean

setHeight

public void setHeight(java.lang.Object o)
Sets the text field height.
Parameters:
o - java.lang.Object

setHelpFileURL

public void setHelpFileURL(java.lang.Object o)
Sets the HeplSet file URL.
Parameters:
o - java.lang.Object

setInitializerClass

public void setInitializerClass(java.lang.Object o)
Sets the name of the desktop initializing class.
Parameters:
o - java.lang.Object

setInitializerMethod

public void setInitializerMethod(java.lang.Object o)
Sets the name of the desktop initializing method.
Parameters:
o - java.lang.Object

setLookAndFeel

public void setLookAndFeel(java.lang.Object laf)
Sets the value of the lookandfeel property.
Parameters:
laf - Object .The new value of the property.

setMessageTextField

public void setMessageTextField(MessageArea t)
Sets the message text field.
Parameters:
t - TextField

setMultiTasking

public void setMultiTasking(java.lang.Object o)
Sets the property value that indicates whether the application is multi-tasking or not.
Parameters:
o - java.lang.Object

setOnInitialize

public void setOnInitialize(java.lang.Object o)
Sets the specified Java script code that is executed when the component is initialized.
Parameters:
o - java.lang.Object

setOrientation

public void setOrientation(java.lang.Object o)
Sets the value of the orientation property.

The orientation is the Component orientation of the Desktop.


setOriginalHeight

public void setOriginalHeight(int height)
Sets the value of the originalHeight property.
Parameters:
originalHeight - int The new value of the property.

setOriginalWidth

public void setOriginalWidth(int width)
Sets the value of the originalWidht property.
Parameters:
originalWidth - int The new value of the property.

setPackages

public void setPackages(java.lang.Object o)
Concatenates the desktop package name with the specified class name.
Parameters:
o - java.lang.Object

setReadXMLFromJAR

public void setReadXMLFromJAR(boolean readFromJAR)
Sets the boolean value that indicates whether the XML file is read from a JAR file or not.
Parameters:
readFromJAR - boolean

setShowProgressBar

public static void setShowProgressBar(boolean aBoolean)
Sets the boolean value that indicates whether the desktop initialization progress bar must be shown or not.
Parameters:
aBoolean - boolean

setTitle

public void setTitle(java.lang.Object o)
Sets the title.
Parameters:
o - java.lang.Object

setWidth

public void setWidth(java.lang.Object o)
Sets the text field width.
Parameters:
o - java.lang.Object

showHelp

public void showHelp(java.lang.String s)
Shows the help section that corresponds to the specified ID.
Parameters:
s - java.lang.String

showMessage

public void showMessage(java.lang.String s)
Shows the message s in the desktop text field.
Parameters:
s - java.lang.String

showMessage

public void showMessage(java.lang.String s,
                        int i)
Shows the message s in the desktop text field.
Parameters:
s - java.lang.String
i - int

showProgressBar

public void showProgressBar()
Shows the progress bar. If the framework is initialized, it reads the DSE.INI file to determine whether to show the progress bar or not. If the framework is not initialized, it takes the class static attribute value that indicates whether to show the progress bar or not.

showTraceMessage

public static void showTraceMessage(int level,
                                    int type,
                                    java.lang.String message)
Shows the message message in the trace window or in the system console.
Parameters:
level - int
message - java.lang.String
exception - java.lang.Throwable

showTraceMessage

public static void showTraceMessage(int level,
                                    int type,
                                    java.lang.String message,
                                    java.lang.Throwable exception)
Shows the message message in the trace window or in the system console.
Parameters:
level - int
message - java.lang.String
exception - java.lang.Throwable

unBlock

public static void unBlock(java.lang.Object o)
Unblocks the desktop and shows the default cursor.
Parameters:
o - java.lang.Object

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)
Invoked when a window is activated.
Specified by:
windowActivated in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)
Invoked when a window has been closed.
Specified by:
windowClosed in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)
Invoked when a window is in the process of being closed.
Specified by:
windowClosing in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)
Invoked when a window is deactivated.
Specified by:
windowDeactivated in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)
Invoked when a window is de-iconified.
Specified by:
windowDeiconified in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)
Invoked when a window is iconified.
Specified by:
windowIconified in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)
Invoked when a window has been opened.
Specified by:
windowOpened in interface java.awt.event.WindowListener
Parameters:
e - java.awt.event.WindowEvent