org.nuxeo.ecm.spaces.api

Interface Gadget

All Known Implementing Classes:

AbstractGadget, DocGadgetImpl

public interface Gadget

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(Gadget gadget)
URL	getDefinitionUrl()
String	getDescription() description
int	getHeight()
String	getId() Unique identifier of a gadget
String	getName() name
String	getOwner() creator name
Space	getParent()
int	getPosition() Relative position in the parent container at the place id "getPlaceID()"
String	getPref(String prefKey)
Map<String,String>	getPreferences() preferences values
String	getTitle() title
String	getViewer()
boolean	hasPermission(String permissioName)
boolean	isCollapsed() Determines if the display state of the gadget
boolean	isEqualTo(Gadget gadget)
void	save()
void	setCollapsed(boolean collapsed)
void	setDefinitionUrl(URL url)
void	setDescription(String description)
void	setHeight(int height)
void	setName(String name)
void	setPosition(int position)
void	setPreferences(Map<String,String> prefs)
void	setTitle(String title)

Method Detail

getId

String getId()

Unique identifier of a gadget

Returns:

getName

String getName()
               throws ClientException

name

Returns:

Throws:

ClientException

setName

void setName(String name)
             throws ClientException

Throws:

ClientException

getDefinitionUrl

URL getDefinitionUrl()
                     throws ClientException

Throws:

ClientException

setDefinitionUrl

void setDefinitionUrl(URL url)
                      throws ClientException

Throws:

ClientException

getDescription

String getDescription()
                      throws ClientException

description

Returns:

Throws:

ClientException

setDescription

void setDescription(String description)
                    throws ClientException

Throws:

ClientException

getTitle

String getTitle()
                throws ClientException

title

Returns:

Throws:

ClientException

setTitle

void setTitle(String title)
              throws ClientException

Throws:

ClientException

getOwner

String getOwner()
                throws ClientException

creator name

Returns:

Throws:

ClientException

getViewer

String getViewer()
                 throws ClientException

Throws:

ClientException

getPreferences

Map<String,String> getPreferences()
                                  throws ClientException

preferences values

Returns:

Throws:

ClientException

setPreferences

void setPreferences(Map<String,String> prefs)
                    throws ClientException

Throws:

ClientException

getPref

String getPref(String prefKey)
               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

hasPermission

boolean hasPermission(String permissioName)
                      throws ClientException

Throws:

ClientException

save

void save()
          throws ClientException

Throws:

ClientException