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

java.lang.Object
  org.nuxeo.ecm.spaces.api.AbstractGadget
      org.nuxeo.ecm.spaces.core.impl.docwrapper.DocGadgetImpl

All Implemented Interfaces:

Gadget

public class DocGadgetImpl
extends AbstractGadget

Field Summary

static java.lang.String

TYPE

Constructor Summary

DocGadgetImpl(DocumentModel doc)

Method Summary

void	copyFrom(Gadget gadget)
java.lang.String	getCategory() category of a gadget
java.net.URL	getDefinitionUrl()
java.lang.String	getDescription() Description.
DocumentModel	getDocument()
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.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)

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 java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

DocGadgetImpl

public DocGadgetImpl(DocumentModel doc)

Method Detail

getDocument

public DocumentModel getDocument()

getCategory

public java.lang.String getCategory()
                             throws ClientException

Description copied from interface: Gadget

category of a gadget

Returns:

Throws:

ClientException

getDefinitionUrl

public java.net.URL getDefinitionUrl()
                              throws ClientException

Throws:

ClientException

getDescription

public java.lang.String getDescription()
                                throws ClientException

Description copied from interface: Gadget

Description.

Throws:

ClientException

getId

public java.lang.String getId()

Description copied from interface: Gadget

Unique identifier of a gadget.

getName

public java.lang.String getName()
                         throws ClientException

Description copied from interface: Gadget

Name.

Throws:

ClientException

getOwner

public java.lang.String getOwner()
                          throws ClientException

Description copied from interface: Gadget

creator name

Returns:

Throws:

ClientException

getParent

public Space getParent()
                throws ClientException

Throws:

ClientException

getPlaceId

public java.lang.String getPlaceId()
                            throws ClientException

Description copied from interface: Gadget

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

Returns:

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 java.util.Map<java.lang.String,java.lang.String> getPreferences()
                                                                throws ClientException

Description copied from interface: Gadget

preferences values

Returns:

Throws:

ClientException

getTitle

public java.lang.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)

setCategory

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

Throws:

ClientException

setCollapsed

public void setCollapsed(boolean collapsed)
                  throws ClientException

Throws:

ClientException

setDefinitionUrl

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

Throws:

ClientException

setDescription

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

Throws:

ClientException

setName

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

Throws:

ClientException

setPlaceId

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

Throws:

ClientException

setPosition

public void setPosition(int position)
                 throws ClientException

Throws:

ClientException

setPreferences

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

Throws:

ClientException

setTitle

public void setTitle(java.lang.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 java.lang.String getViewer()
                           throws ClientException

Throws:

ClientException

save

public void save()
          throws ClientException

Throws:

ClientException

isEditable

public boolean isEditable()
                   throws ClientException

Throws:

ClientException

isConfigurable

public boolean isConfigurable()
                       throws ClientException

Throws:

ClientException