com.partnersoft.maps.model

Class AbstractMapEditActor

java.lang.Object

com.partnersoft.maps.model.AbstractMapEditActor

All Implemented Interfaces:

MapEditActor

Direct Known Subclasses:

AbstractModuleMapEditActor

public class AbstractMapEditActor
extends java.lang.Object
implements MapEditActor

A do-nothing implementation of MapEditActor. Returns false from all the isFooSupported() methods and throws UnsupportedOperationExceptions from all the action methods.

Subclasses must override the isFooSupported() and foo() methods they support. For example:

 public class MoveOnlyActor extends AbstractMapEditActor {
        public boolean isMoveSupported() {
                return true;
        }
 
        public void move(MapDataItem item, Point newLocation) {
                // clever moving code goes here
        }
 }
 

Copyright 2007 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
AbstractMapEditActor()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(MapEditContext context) Intentionally NOT abstract, this ensures that we catch any missing methods and put a do-nothing stub for it.
void	connect(MapEditContext context) Performs a connect action.
void	convert(MapEditContext context) Converts an item to the selected type.
void	copy(MapEditContext context) Performs a copy.
void	delete(MapEditContext context) Performs a delete.
void	edit(MapEditContext context) Edits an item.
Ephemeron	ephemeronFor(MapEditContext context) Returns an Ephemeron for the given context.
boolean	isAddSupported(MapEditContext context) Returns true if add is supported.
boolean	isConnectSupported(MapEditContext context) Returns true if connect is supported.
boolean	isConvertSupported(MapEditContext context) Returns true if convert is supported.
boolean	isCopySupported(MapEditContext context) Returns true if copy is supported.
boolean	isDeleteSupported(MapEditContext context) Returns true if delete is supported.
boolean	isEditSupported(MapEditContext context) Returns true if edit is supported.
boolean	isMoveSupported(MapEditContext context) Returns true if moving is supported.
boolean	isRotateSupported(MapEditContext context) Returns true if rotate is supported.
java.util.List<java.lang.String>	listDataPanelActionsFor(MapEditContext context) Returns a list of action names to put in the view data tab for the given item.
java.util.List<java.lang.String>	listSupportedActions(MapEditContext context) Returns a list of action names to put in the Wheel Menu action menu for the given item.
java.util.List<MapEditTool>	listSupportedTools() Returns a list of drawing scripts/things applicable for the given item.
void	move(MapEditContext context) Performs a move.
void	rotate(MapEditContext context) Performs a rotate.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMapEditActor

public AbstractMapEditActor()

Method Detail

add

public void add(MapEditContext context)

Intentionally NOT abstract, this ensures that we catch any missing methods and put a do-nothing stub for it.

Specified by:

add in interface MapEditActor

Parameters:

context - TODO

copy

public void copy(MapEditContext context)

Description copied from interface: MapEditActor

Performs a copy. Throws UnsupportedOperationException if isCopySupported() is false.

Specified by:

copy in interface MapEditActor

Parameters:

context - TODO

delete

public void delete(MapEditContext context)

Description copied from interface: MapEditActor

Performs a delete. Throws UnsupportedOperationException if isDeleteSupported() is false.

Specified by:

delete in interface MapEditActor

Parameters:

context - TODO

convert

public void convert(MapEditContext context)

Description copied from interface: MapEditActor

Converts an item to the selected type. Throws UnsupportedOperationException if isConvertSupported() is false.

Specified by:

convert in interface MapEditActor

Parameters:

context - TODO

edit

public void edit(MapEditContext context)

Description copied from interface: MapEditActor

Edits an item. Throws UnsupportedOperationException if isEditSupported() is false.

Specified by:

edit in interface MapEditActor

Parameters:

context - TODO

isAddSupported

public boolean isAddSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if add is supported.

Specified by:

isAddSupported in interface MapEditActor

isCopySupported

public boolean isCopySupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if copy is supported.

Specified by:

isCopySupported in interface MapEditActor

isConvertSupported

public boolean isConvertSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if convert is supported.

Specified by:

isConvertSupported in interface MapEditActor

isEditSupported

public boolean isEditSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if edit is supported.

Specified by:

isEditSupported in interface MapEditActor

isDeleteSupported

public boolean isDeleteSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if delete is supported.

Specified by:

isDeleteSupported in interface MapEditActor

isMoveSupported

public boolean isMoveSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if moving is supported.

Specified by:

isMoveSupported in interface MapEditActor

isRotateSupported

public boolean isRotateSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if rotate is supported.

Specified by:

isRotateSupported in interface MapEditActor

isConnectSupported

public boolean isConnectSupported(MapEditContext context)

Description copied from interface: MapEditActor

Returns true if connect is supported.

Specified by:

isConnectSupported in interface MapEditActor

move

public void move(MapEditContext context)

Description copied from interface: MapEditActor

Performs a move. Throws UnsupportedOperationException if isMoveSupported() is false.

Specified by:

move in interface MapEditActor

Parameters:

context - TODO

rotate

public void rotate(MapEditContext context)

Description copied from interface: MapEditActor

Performs a rotate. Throws UnsupportedOperationException if isRotateSupported() is false.

Specified by:

rotate in interface MapEditActor

Parameters:

context - TODO

connect

public void connect(MapEditContext context)

Description copied from interface: MapEditActor

Performs a connect action. Throws UnsupportedOperationException if isConnectSupported() is false.

Specified by:

connect in interface MapEditActor

listSupportedActions

public java.util.List<java.lang.String> listSupportedActions(MapEditContext context)

Description copied from interface: MapEditActor

Returns a list of action names to put in the Wheel Menu action menu for the given item.

Specified by:

listSupportedActions in interface MapEditActor

listDataPanelActionsFor

public java.util.List<java.lang.String> listDataPanelActionsFor(MapEditContext context)

Description copied from interface: MapEditActor

Returns a list of action names to put in the view data tab for the given item.

Specified by:

listDataPanelActionsFor in interface MapEditActor

listSupportedTools

public java.util.List<MapEditTool> listSupportedTools()

Description copied from interface: MapEditActor

Returns a list of drawing scripts/things applicable for the given item. TODO: a better name please

Specified by:

listSupportedTools in interface MapEditActor

Returns:

ephemeronFor

public Ephemeron ephemeronFor(MapEditContext context)

Description copied from interface: MapEditActor

Returns an Ephemeron for the given context.

Specified by:

ephemeronFor in interface MapEditActor