View Javadoc

1   /*
2    *   Magic-Project is a turn based strategy simulator
3    *   Copyright (C) 2003-2007 Fabrice Daugan
4    *
5    *   This program is free software; you can redistribute it and/or modify it 
6    * under the terms of the GNU General Public License as published by the Free 
7    * Software Foundation; either version 2 of the License, or (at your option) any
8    * later version.
9    *
10   *   This program is distributed in the hope that it will be useful, but WITHOUT 
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
13   * details.
14   *
15   *   You should have received a copy of the GNU General Public License along  
16   * with this program; if not, write to the Free Software Foundation, Inc., 
17   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  package net.sf.magicproject.action.objectmap;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  
24  import net.sf.magicproject.action.Actiontype;
25  import net.sf.magicproject.action.UserAction;
26  import net.sf.magicproject.action.handler.StandardAction;
27  import net.sf.magicproject.clickable.ability.Ability;
28  import net.sf.magicproject.event.context.ContextEventListener;
29  
30  /***
31   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
32   * @since 0.90
33   */
34  public abstract class ObjectMap extends UserAction implements StandardAction {
35  
36  	/***
37  	 * Create an instance of TargetList by reading a file Offset's file must
38  	 * pointing on the first byte of this action <br>
39  	 * <ul>
40  	 * Structure of InputStream : Data[size]
41  	 * <li>super [Action]</li>
42  	 * </ul>
43  	 * 
44  	 * @param inputStream
45  	 *          file containing this action
46  	 * @throws IOException
47  	 *           If some other I/O error occurs
48  	 */
49  	protected ObjectMap(InputStream inputStream) throws IOException {
50  		super(inputStream);
51  	}
52  
53  	@Override
54  	public final Actiontype getIdAction() {
55  		return Actiontype.TARGET_LIST;
56  	}
57  
58  	public abstract boolean play(ContextEventListener context, Ability ability);
59  
60  	@Override
61  	public abstract String toString(Ability ability);
62  
63  	@Override
64  	public final String toHtmlString(Ability ability, int times,
65  			ContextEventListener context) {
66  		if (actionName != null && actionName.charAt(0) != '%'
67  				&& actionName.charAt(0) != '@' && actionName.indexOf("%n") != -1) {
68  			return super.toHtmlString(ability, times, context);
69  		}
70  		return "";
71  	}
72  
73  }