org.nuxeo.ecm.spaces.impl.docwrapper

Class DocGadgetImpl

java.lang.Object

org.nuxeo.ecm.spaces.api.AbstractGadget

org.nuxeo.ecm.spaces.impl.docwrapper.DocGadgetImpl

All Implemented Interfaces:

Gadget

public class DocGadgetImpl
extends AbstractGadget

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
DocGadgetImpl(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(Gadget gadget)
URL	getDefinitionUrl()
String	getDescription() description
DocumentModel	getDocument()
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()"
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)

Methods inherited from class org.nuxeo.ecm.spaces.api.AbstractGadget

getPref

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

DocGadgetImpl

public DocGadgetImpl(DocumentModel doc)

Method Detail

getDocument

public DocumentModel getDocument()

getDefinitionUrl

public URL getDefinitionUrl()
                     throws ClientException

Throws:

ClientException

getDescription

public String getDescription()
                      throws ClientException

Description copied from interface: Gadget

description

Returns:

Throws:

ClientException

getId

public String getId()

Description copied from interface: Gadget

Unique identifier of a gadget

Returns:

getName

public String getName()
               throws ClientException

Description copied from interface: Gadget

name

Returns:

Throws:

ClientException

getOwner

public String getOwner()
                throws ClientException

Description copied from interface: Gadget

creator name

Returns:

Throws:

ClientException

getParent

public Space getParent()
                throws ClientException

Throws:

ClientException

getPosition

public int getPosition()
                throws ClientException

Description copied from interface: Gadget

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

Returns:

Throws:

ClientException

getPreferences

public Map<String,String> getPreferences()
                                  throws ClientException

Description copied from interface: Gadget

preferences values

Returns:

Throws:

ClientException

getTitle

public String getTitle()
                throws ClientException

Description copied from interface: Gadget

title

Returns:

Throws:

ClientException

isCollapsed

public boolean isCollapsed()
                    throws ClientException

Description copied from interface: Gadget

Determines if the display state of the gadget

Returns:

Throws:

ClientException

isEqualTo

public boolean isEqualTo(Gadget gadget)

setCollapsed

public void setCollapsed(boolean collapsed)
                  throws ClientException

Throws:

ClientException

setDefinitionUrl

public void setDefinitionUrl(URL url)
                      throws ClientException

Throws:

ClientException

setDescription

public void setDescription(String description)
                    throws ClientException

Throws:

ClientException

setName

public void setName(String name)
             throws ClientException

Throws:

ClientException

setPosition

public void setPosition(int position)
                 throws ClientException

Throws:

ClientException

setPreferences

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

Throws:

ClientException

setTitle

public void setTitle(String title)
              throws ClientException

Throws:

ClientException

getHeight

public int getHeight()
              throws ClientException

Throws:

ClientException

setHeight

public void setHeight(int height)
               throws ClientException

Throws:

ClientException

copyFrom

public void copyFrom(Gadget gadget)
              throws ClientException

Throws:

ClientException

getViewer

public String getViewer()
                 throws ClientException

Throws:

ClientException

hasPermission

public boolean hasPermission(String permissioName)
                      throws ClientException

Throws:

ClientException

save

public void save()
          throws ClientException

Throws:

ClientException