org.objectweb.jac.aspects.gui
Class AppletView

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Panel
                    |
                    +--java.applet.Applet
                          |
                          +--javax.swing.JApplet
                                |
                                +--org.objectweb.jac.aspects.gui.AppletView

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, View, ViewIdentity

public class AppletView

extends JApplet

implements View

This class allows the programmer to insert specialized object views defined as applets.

This is useful when views can be used by an Internet browser at client-side.

The programmer must subclass this class and overload the init method.

See Also:

init(), Serialized Form

Field Summary

protected DisplayContext	context
protected ViewFactory	factory
protected String	label
protected Object[]	parameters
protected Object	substance
protected String	type

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AppletView(ViewFactory factory, DisplayContext context, Object substance)
The AppletView's constructor.

Method Summary

void	close(boolean validate) Close this view.
boolean	equalsView(String type, Object[] parameters)
boolean	equalsView(ViewIdentity view) Tells if a view is the same as another one, ie it has the same type and parameters.
Border	getBorder() Get the value of border.
DisplayContext	getContext()
String	getDescription() Get the value of description.
ViewFactory	getFactory() Gets the factory.
String	getLabel() Gets the view's label (identifier).
MethodItem	getMessage() Get the value of message.
Object[]	getParameters() The parameters that were used to compile the view.
View	getParentView() Get the value of parent.
View	getRootView() Gets the ancestor view whose parent is null
String	getStyle() Gets the user-defined style for this view.
Object	getSubstance()
String	getType() Gets the view type.
Border	getViewBorder() Get the value of viewBorder.
void	init() Initializes the applet view.
boolean	isClosed() Tells if this view has been closed by the GUI or the user.
boolean	isDescendantOf(View ancestor) Tells wether this view has a given view in its ancestors
void	setBorder(Border v) Set the value of border.
void	setContext(DisplayContext context) Sets the display context for this view.
void	setDescription(String v) Set the value of description.
void	setFactory(ViewFactory factory) Sets the factory for this view (WEB, SWING or other supported factory).
void	setFocus(FieldItem field, Object option) Focus a field of an object's view.
void	setHeight(int heigth) Sets the prefered height for this view.
void	setLabel(String label) Sets the label (the identifier) of the view.
void	setMessage(MethodItem v) Set the value of message.
void	setParameters(Object[] parameters) Sets the parameters that were used to construct the view.
void	setParentView(View v) Set the value of parent.
void	setStyle(String style) Sets the view style.
void	setSubstance(Object substance)
void	setType(String type) Set the view type.
void	setViewBorder(Border v) Set the value of viewBorder.
void	setWidth(int width) Sets the prefered width for this view.

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.applet.Applet

destroy, getAppletContext, getAppletInfo, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, 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, 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, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Field Detail

label

protected String label

context

protected DisplayContext context

factory

protected ViewFactory factory

parameters

protected Object[] parameters

type

protected String type

substance

protected Object substance

Constructor Detail

AppletView

public AppletView(ViewFactory factory,
                  DisplayContext context,
                  Object substance)

The AppletView's constructor.

Parameters:

factory -

context -

substance - the object that is represented by this view

Method Detail

getViewBorder

public Border getViewBorder()

Get the value of viewBorder.

Specified by:

getViewBorder in interface View

Returns:

value of viewBorder.

setViewBorder

public void setViewBorder(Border v)

Set the value of viewBorder.

Specified by:

setViewBorder in interface View

Parameters:

v - Value to assign to viewBorder.

getParentView

public View getParentView()

Get the value of parent.

Specified by:

getParentView in interface View

Returns:

value of parent.

See Also:

CompositeView

setParentView

public void setParentView(View v)

Set the value of parent.

Specified by:

setParentView in interface View

Parameters:

v - Value to assign to parent.

See Also:

CompositeView

getRootView

public View getRootView()

Description copied from interface: View

Gets the ancestor view whose parent is null

Specified by:

getRootView in interface View

isDescendantOf

public boolean isDescendantOf(View ancestor)

Description copied from interface: View

Tells wether this view has a given view in its ancestors

Specified by:

isDescendantOf in interface View

Parameters:

ancestor - the ancestor

setStyle

public void setStyle(String style)

Description copied from interface: View

Sets the view style. The style can be exploited in different maners depending on the GUI supports (e.g. with CSS for the WEB). Styles are user-defined.

Specified by:

setStyle in interface View

getStyle

public String getStyle()

Description copied from interface: View

Gets the user-defined style for this view.

Specified by:

getStyle in interface View

Returns:

the style, null if undefined

getBorder

public Border getBorder()

Get the value of border.

Returns:

value of border.

setBorder

public void setBorder(Border v)

Set the value of border.

Parameters:

v - Value to assign to border.

getDescription

public String getDescription()

Get the value of description.

Specified by:

getDescription in interface View

Returns:

value of description.

setDescription

public void setDescription(String v)

Set the value of description.

Specified by:

setDescription in interface View

Parameters:

v - Value to assign to description.

See Also:

View.setMessage(MethodItem)

setLabel

public void setLabel(String label)

Description copied from interface: View

Sets the label (the identifier) of the view.

Specified by:

setLabel in interface View

Parameters:

label - a string that identifies the view

getLabel

public String getLabel()

Description copied from interface: View

Gets the view's label (identifier).

Specified by:

getLabel in interface View

Returns:

the view's label

getMessage

public MethodItem getMessage()

Get the value of message.

Specified by:

getMessage in interface View

Returns:

value of message.

setMessage

public void setMessage(MethodItem v)

Set the value of message.

Specified by:

setMessage in interface View

Parameters:

v - Value to assign to message.

See Also:

View.setDescription(String)

setContext

public void setContext(DisplayContext context)

Description copied from interface: View

Sets the display context for this view.

The display context contains the factory that is used for this view.

Specified by:

setContext in interface View

getContext

public DisplayContext getContext()

Specified by:

getContext in interface View

Returns:

the DisplayContext of the view

setFactory

public void setFactory(ViewFactory factory)

Description copied from interface: View

Sets the factory for this view (WEB, SWING or other supported factory).

Specified by:

setFactory in interface View

getFactory

public ViewFactory getFactory()

Description copied from interface: View

Gets the factory.

Specified by:

getFactory in interface View

setWidth

public void setWidth(int width)

Description copied from interface: View

Sets the prefered width for this view.

Specified by:

setWidth in interface View

setHeight

public void setHeight(int heigth)

Description copied from interface: View

Sets the prefered height for this view.

Specified by:

setHeight in interface View

setParameters

public void setParameters(Object[] parameters)

Description copied from interface: ViewIdentity

Sets the parameters that were used to construct the view.

Specified by:

setParameters in interface ViewIdentity

getParameters

public Object[] getParameters()

Description copied from interface: ViewIdentity

The parameters that were used to compile the view.

Specified by:

getParameters in interface ViewIdentity

setType

public void setType(String type)

Description copied from interface: ViewIdentity

Set the view type.

Specified by:

setType in interface ViewIdentity

getType

public String getType()

Description copied from interface: ViewIdentity

Gets the view type.

Specified by:

getType in interface ViewIdentity

Returns:

view type string as declared in web.acc or swing.acc depending on the GUI target

equalsView

public boolean equalsView(ViewIdentity view)

Description copied from interface: ViewIdentity

Tells if a view is the same as another one, ie it has the same type and parameters.

Specified by:

equalsView in interface ViewIdentity

equalsView

public boolean equalsView(String type,
                          Object[] parameters)

Specified by:

equalsView in interface ViewIdentity

close

public void close(boolean validate)

Description copied from interface: View

Close this view. This should be upcalled when the view is closed in order to free resources or close other dependant views.

Specified by:

close in interface View

isClosed

public boolean isClosed()

Description copied from interface: View

Tells if this view has been closed by the GUI or the user.

Specified by:

isClosed in interface View

getSubstance

public Object getSubstance()

setSubstance

public void setSubstance(Object substance)

setFocus

public void setFocus(FieldItem field,
                     Object option)

Description copied from interface: View

Focus a field of an object's view.

Specified by:

setFocus in interface View

Parameters:

field - the field to focus

option - an extra option

init

public void init()

Initializes the applet view.

The programmer must overload this class and start the init method code with super.init() so that the applet's container initialization is done.

Overrides:

init in class Applet