net.xoetrope.xui
Class XTarget

java.lang.Object
  java.awt.Component
      java.awt.Container
          net.xoetrope.xui.XTarget

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, XContentHolder

public class XTarget
extends java.awt.Container
implements XContentHolder

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: 2.6 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

XTarget()
Setup a new target area

Method Summary

void	add(java.lang.Object c, java.lang.Object constraint) Add a child component
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.awt.Dimension	getMinimumSize() Get the minimum size of the target area.
java.awt.Dimension	getPreferredSize() Get the preferred size of the target area.
void	remove(java.lang.Object c) Remove a child 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	setPreferredSize(java.awt.Dimension d) Set the preferred size for this target area
void	setup(java.lang.String name, int width, int height, java.util.Hashtable params) Setup a new target area and set its size
void	update(java.awt.Graphics g) Update the target by repainting

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.xoetrope.xui.XContentHolder

doLayout, getName

Constructor Detail

XTarget

public XTarget()

Setup a new target area

Method Detail

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)

Setup a new target area and set its size

Specified by:

setup in interface XContentHolder

Parameters:

name - The name with which this instance will be associated

width - the width

height - the height

params - extra parameters for the target

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

remove

public void remove(java.lang.Object c)

Remove a child component

Specified by:

remove in interface XContentHolder

Parameters:

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

getPreferredSize

public java.awt.Dimension getPreferredSize()

Get the preferred size of the target area. If zero width and height were specified this method returns the default size, otherwise it returns a dimension with the specified width and height.

Overrides:

getPreferredSize in class java.awt.Container

Returns:

the size

setPreferredSize

public void setPreferredSize(java.awt.Dimension d)

Set the preferred size for this target area

Overrides:

setPreferredSize in class java.awt.Component

Parameters:

d - the new size

getMinimumSize

public java.awt.Dimension getMinimumSize()

Get the minimum size of the target area. If zero width and height were specified this method returns the default size, otherwise it returns a dimension with the specified width and height.

Overrides:

getMinimumSize in class java.awt.Container

Returns:

the size

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

update

public void update(java.awt.Graphics g)

Update the target by repainting

Overrides:

update in class java.awt.Container

Parameters:

g - the graphics context

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