org.nuxeo.ecm.spaces.api
Interface Gadget

All Known Implementing Classes:

AbstractGadget, DocGadgetImpl

public interface Gadget

Method Summary

void	copyFrom(Gadget gadget)
java.lang.String	getCategory() category of a gadget
java.net.URL	getDefinitionUrl()
java.lang.String	getDescription() Description.
int	getHeight()
java.lang.String	getId() Unique identifier of a gadget.
java.lang.String	getName() Name.
java.lang.String	getOwner() creator name
Space	getParent()
java.lang.String	getPlaceId() Key corresponding to the place where the gadget will be positionned in the view
int	getPosition() Relative position in the parent container at the place id "getPlaceID()"
java.lang.String	getPref(java.lang.String prefKey)
java.util.Map<java.lang.String,java.lang.String>	getPreferences() preferences values
java.lang.String	getTitle() title
java.lang.String	getViewer()
boolean	isCollapsed() Determines if the display state of the gadget
boolean	isConfigurable()
boolean	isEditable()
boolean	isEqualTo(Gadget gadget)
void	save()
void	setCategory(java.lang.String category)
void	setCollapsed(boolean collapsed)
void	setDefinitionUrl(java.net.URL url)
void	setDescription(java.lang.String description)
void	setHeight(int height)
void	setName(java.lang.String name)
void	setPlaceId(java.lang.String placeId)
void	setPosition(int position)
void	setPreferences(java.util.Map<java.lang.String,java.lang.String> prefs)
void	setTitle(java.lang.String title)

Method Detail

getId

java.lang.String getId()

Unique identifier of a gadget.

getName

java.lang.String getName()
                         throws ClientException

Name.

Throws:

ClientException

setName

void setName(java.lang.String name)
             throws ClientException

Throws:

ClientException

getDefinitionUrl

java.net.URL getDefinitionUrl()
                              throws ClientException

Throws:

ClientException

setDefinitionUrl

void setDefinitionUrl(java.net.URL url)
                      throws ClientException

Throws:

ClientException

getDescription

java.lang.String getDescription()
                                throws ClientException

Description.

Throws:

ClientException

setDescription

void setDescription(java.lang.String description)
                    throws ClientException

Throws:

ClientException

getTitle

java.lang.String getTitle()
                          throws ClientException

title

Returns:

Throws:

ClientException

setTitle

void setTitle(java.lang.String title)
              throws ClientException

Throws:

ClientException

getOwner

java.lang.String getOwner()
                          throws ClientException

creator name

Returns:

Throws:

ClientException

getViewer

java.lang.String getViewer()
                           throws ClientException

Throws:

ClientException

getCategory

java.lang.String getCategory()
                             throws ClientException

category of a gadget

Returns:

Throws:

ClientException

setCategory

void setCategory(java.lang.String category)
                 throws ClientException

Throws:

ClientException

getPreferences

java.util.Map<java.lang.String,java.lang.String> getPreferences()
                                                                throws ClientException

preferences values

Returns:

Throws:

ClientException

setPreferences

void setPreferences(java.util.Map<java.lang.String,java.lang.String> prefs)
                    throws ClientException

Throws:

ClientException

getPref

java.lang.String getPref(java.lang.String prefKey)
                         throws ClientException

Throws:

ClientException

getPlaceId

java.lang.String getPlaceId()
                            throws ClientException

Key corresponding to the place where the gadget will be positionned in the view

Returns:

Throws:

ClientException

setPlaceId

void setPlaceId(java.lang.String placeId)
                throws ClientException

Throws:

ClientException

getPosition

int getPosition()
                throws ClientException

Relative position in the parent container at the place id "getPlaceID()"

Returns:

Throws:

ClientException

setPosition

void setPosition(int position)
                 throws ClientException

Throws:

ClientException

isCollapsed

boolean isCollapsed()
                    throws ClientException

Determines if the display state of the gadget

Returns:

Throws:

ClientException

setCollapsed

void setCollapsed(boolean collapsed)
                  throws ClientException

Throws:

ClientException

isEqualTo

boolean isEqualTo(Gadget gadget)
                  throws ClientException

Throws:

ClientException

getParent

Space getParent()
                throws ClientException

Throws:

ClientException

getHeight

int getHeight()
              throws ClientException

Throws:

ClientException

setHeight

void setHeight(int height)
               throws ClientException

Throws:

ClientException

copyFrom

void copyFrom(Gadget gadget)
              throws ClientException

Throws:

ClientException

save

void save()
          throws ClientException

Throws:

ClientException

isEditable

boolean isEditable()
                   throws ClientException

Throws:

ClientException

isConfigurable

boolean isConfigurable()
                       throws ClientException

Throws:

ClientException