Editor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> cgsuite >> [ plugin overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

cgsuite.plugin
Interface Editor

public interface Editor

Defines a graphical editor for one or more games. Instances of this interface are not graphical components; rather, they serve to convert between cgsuite.Games and EditorPanels.

Method Summary

cgsuite.Game constructGame(EditorPanel editorPanel, java.lang.Class type)
          Constructs a cgsuite.Game from the specified EditorPanel.

EditorPanel createDefaultEditorPanel(java.lang.Class type)
          Creates an EditorPanel for the specified game type, initialized to a suitable default representation.

EditorPanel createEditorPanel(cgsuite.Game g)
          Creates an EditorPanel populated with the specified game.

void updateEditorPanel(EditorPanel editorPanel, cgsuite.Game g)
          Updates the specified EditorPanel with the specified cgsuite.Game.

Method Detail

createEditorPanel

public EditorPanel createEditorPanel(cgsuite.Game g)

Creates an EditorPanel populated with the specified game.

createDefaultEditorPanel

public EditorPanel createDefaultEditorPanel(java.lang.Class type)

Creates an EditorPanel for the specified game type, initialized to a suitable default representation.

updateEditorPanel

public void updateEditorPanel(EditorPanel editorPanel,
                              cgsuite.Game g)

Updates the specified EditorPanel with the specified cgsuite.Game. It is assumed that editorPanel was created by this Editor for a game whose type is equal to g.getClass().

constructGame

public cgsuite.Game constructGame(EditorPanel editorPanel,
                                  java.lang.Class type)

Constructs a cgsuite.Game from the specified EditorPanel. It is assumed that editorPanel was created by this Editor for a game whose type is equal to type.