org.jdesktop.wonderland.client.cell.properties
Interface CellPropertiesEditor


public interface CellPropertiesEditor

An interface to represent a graphical editor of the cell properties. This interface is implemented by the actual GUI frame and typically consists of a series of panels to edit some part of the cell (and cell component) properties.

Author:
Jordan Slott

Method Summary
 void addToUpdateList(CellComponentServerState cellComponentServerState)
          Adds a CellComponentServerState object to the "update" list to be sent to the server during the next "apply" operation.
 void addToUpdateList(CellServerState cellServerState)
          Adds a CellServerState object to the "update" list to be sent to the server during the next "apply" operation.
 Cell getCell()
          Returns the Cell being edited.
 CellServerState getCellServerState()
          Returns an instance of the Cell's server state object representing the state of the Cell when the properties editor was first displayed.
 void setPanelDirty(java.lang.Class clazz, boolean isDirty)
          Tells the properties editor that the panel with the given class name is either "dirty" (true, information has changed) or "clean" (false, information has not changed) since the last "save".
 

Method Detail

getCell

Cell getCell()
Returns the Cell being edited.

Returns:
The Cell object

getCellServerState

CellServerState getCellServerState()
Returns an instance of the Cell's server state object representing the state of the Cell when the properties editor was first displayed.

Returns:
The CellServerState object

setPanelDirty

void setPanelDirty(java.lang.Class clazz,
                   boolean isDirty)
Tells the properties editor that the panel with the given class name is either "dirty" (true, information has changed) or "clean" (false, information has not changed) since the last "save".

Parameters:
clazz - The Class of the panel object
isDirty - True to tell the properties editor the panel is dirty, false if clean.

addToUpdateList

void addToUpdateList(CellServerState cellServerState)
Adds a CellServerState object to the "update" list to be sent to the server during the next "apply" operation.

Parameters:
cellServerState - The Cell server state to add to the update list

addToUpdateList

void addToUpdateList(CellComponentServerState cellComponentServerState)
Adds a CellComponentServerState object to the "update" list to be sent to the server during the next "apply" operation.

Parameters:
cellComponentServerState - The CellComponent server state to add to the update list


Open Wonderland - http://openwonderland.org