net.xoetrope.swt
Class XSwtTarget

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  net.xoetrope.swt.XSwtTarget

All Implemented Interfaces:

XAttributedComponent, XContentHolder, org.eclipse.swt.graphics.Drawable

public class XSwtTarget
extends org.eclipse.swt.widgets.Composite
implements XContentHolder, XAttributedComponent

When using framesets the 'screen' is devided up into a number of different target areas. Each target area may contain a page. The content for each target area is set by naming the target area when calling displayPage. This class provides support for this behaviour by wrapping the Container class to ensure the target area is properly sized. How the target areas are actually laid out depends on the layout manager being used.

Copyright: Copyright (c) Xoetrope Ltd., 2002-2003

$Revision: 1.5 $

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

XSwtTarget(org.eclipse.swt.widgets.Composite parent)
Setup a new target area and set its size

XSwtTarget(XApplet parent)
Setup a new target area and set its size

Method Summary

void	add(java.lang.Object c, java.lang.Object constraint) Add a child component
protected void	checkSubclass() Suppress the subclassing exception
void	doLayout() Do the container layout
java.lang.Object	getChildComponent(int i) Get a child component
java.lang.String	getContent() Get the content of this target
boolean	getHasListeners() Get the hasListeners flag
java.lang.String	getName() Get the name of the content holder
void	remove(java.lang.Object c) Remove a child component
int	setAttribute(java.lang.String attribName, java.lang.Object attribValue) Set one or more attributes of the component.
void	setContent(java.lang.String pageName) Set the content of this target
void	setHasListeners(boolean value) Set the hasListeners flag
void	setNextAttributes(java.lang.Object attribs) Set the attributes for the next component being added
void	setup(java.lang.String name, int width, int height, java.util.Hashtable params) Sets up the new target

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XSwtTarget

public XSwtTarget(org.eclipse.swt.widgets.Composite parent)

Setup a new target area and set its size

Parameters:

parent - parent object

XSwtTarget

public XSwtTarget(XApplet parent)

Setup a new target area and set its size

Method Detail

checkSubclass

protected void checkSubclass()

Suppress the subclassing exception

Overrides:

checkSubclass in class org.eclipse.swt.widgets.Composite

setNextAttributes

public void setNextAttributes(java.lang.Object attribs)

Set the attributes for the next component being added

Specified by:

setNextAttributes in interface XContentHolder

Parameters:

attribs - a table of attributes

setup

public void setup(java.lang.String name,
                  int width,
                  int height,
                  java.util.Hashtable params)

Sets up the new target

Specified by:

setup in interface XContentHolder

Parameters:

params - extra parameters for the target

name - set the container name

width - the desired width

height - the desired height

getChildComponent

public java.lang.Object getChildComponent(int i)

Get a child component

Specified by:

getChildComponent in interface XContentHolder

Parameters:

i - the index of the child within the container

Returns:

the child component

add

public void add(java.lang.Object c,
                java.lang.Object constraint)

Add a child component

Specified by:

add in interface XContentHolder

Parameters:

c - the child component

constraint - the layout constraint

remove

public void remove(java.lang.Object c)

Remove a child component

Specified by:

remove in interface XContentHolder

Parameters:

c - the child component

getHasListeners

public boolean getHasListeners()

Get the hasListeners flag

Returns:

the value

setHasListeners

public void setHasListeners(boolean value)

Set the hasListeners flag

Parameters:

value - the new value

getContent

public java.lang.String getContent()

Get the content of this target

Returns:

the content or page name

setContent

public void setContent(java.lang.String pageName)

Set the content of this target

Specified by:

setContent in interface XContentHolder

Parameters:

pageName - the content page name

doLayout

public void doLayout()

Do the container layout

Specified by:

doLayout in interface XContentHolder

getName

public java.lang.String getName()

Get the name of the content holder

Specified by:

getName in interface XContentHolder

Returns:

the name

setAttribute

public int setAttribute(java.lang.String attribName,
                        java.lang.Object attribValue)

Set one or more attributes of the component.

Specified by:

setAttribute in interface XAttributedComponent

Parameters:

attribName - the name of the attribute

attribValue - the value of the attribute

Returns:

0 for success, non zero for failure or to require some further action