org.jdesktop.wonderland.client.cell.properties.spi
Interface PropertiesFactorySPI


public interface PropertiesFactorySPI

An interface implemented by cells that allow their properties to be edited by a GUI properties panel. This class must be annotated with

Author:
Jordan Slott

Method Summary
 void apply()
          Applies the values current set in the properties GUI panel to the state of the Cell.
 void close()
          Tells the properties GUI panel that it is being closed.
 java.lang.String getDisplayName()
          Returns a human-readable display name of the panel.
 javax.swing.JPanel getPropertiesJPanel()
          Returns a panel to be used in the properties editing dialog.
 void open()
          Tells the proeprties GUI panel that is is about to be displayed and it should refresh its values against the currently set values in the state of the Cell.
 void restore()
          Instructs the GUI to refresh its values against the currently set values in the state of the Cell or the last known "original" state.
 void setCellPropertiesEditor(CellPropertiesEditor editor)
          Sets the cell properties editor containing this individual property sheet.
 

Method Detail

getDisplayName

java.lang.String getDisplayName()
Returns a human-readable display name of the panel. This name will be used to identify the panel amongst other panel in the edit dialog.

Returns:
The name of the configuration panel

setCellPropertiesEditor

void setCellPropertiesEditor(CellPropertiesEditor editor)
Sets the cell properties editor containing this individual property sheet.

Parameters:
editor - A CellProperties Editor object

getPropertiesJPanel

javax.swing.JPanel getPropertiesJPanel()
Returns a panel to be used in the properties editing dialog.

Returns:
A JPanel

open

void open()
Tells the proeprties GUI panel that is is about to be displayed and it should refresh its values against the currently set values in the state of the Cell. This method is typically called when a Cell is first selected or after an appply(). Therefore, it may be invoked multiple times without any intervening close() method invocations.


close

void close()
Tells the properties GUI panel that it is being closed. The panel should revert any intermediate changes it made to the state of the Cell after the last time apply() was invoked. It should also perform any necessary cleanup (e.g. remove listeners on the current Cell) before a new Cell's properties are displayed.


restore

void restore()
Instructs the GUI to refresh its values against the currently set values in the state of the Cell or the last known "original" state.


apply

void apply()
Applies the values current set in the properties GUI panel to the state of the Cell.



Open Wonderland - http://openwonderland.org