Nuxeo Enterprise Platform 5.4

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

java.lang.Object
  extended by org.nuxeo.ecm.spaces.api.AbstractGadget
      extended by org.nuxeo.ecm.spaces.impl.docwrapper.DocGadgetImpl
All Implemented Interfaces:
Gadget

public class DocGadgetImpl
extends AbstractGadget


Field Summary
static String TYPE
           
 
Constructor Summary
DocGadgetImpl(org.nuxeo.ecm.core.api.DocumentModel doc)
           
 
Method Summary
 void copyFrom(Gadget gadget)
           
 URL getDefinitionUrl()
           
 String getDescription()
          description
 org.nuxeo.ecm.core.api.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(org.nuxeo.ecm.core.api.DocumentModel doc)
Method Detail

getDocument

public org.nuxeo.ecm.core.api.DocumentModel getDocument()

getDefinitionUrl

public URL getDefinitionUrl()
                     throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

getDescription

public String getDescription()
                      throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
description

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

getId

public String getId()
Description copied from interface: Gadget
Unique identifier of a gadget

Returns:

getName

public String getName()
               throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
name

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

getOwner

public String getOwner()
                throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
creator name

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

getParent

public Space getParent()
                throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

getPosition

public int getPosition()
                throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
Relative position in the parent container at the place id "getPlaceID()"

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

getPreferences

public Map<String,String> getPreferences()
                                  throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
preferences values

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

getTitle

public String getTitle()
                throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
title

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

isCollapsed

public boolean isCollapsed()
                    throws org.nuxeo.ecm.core.api.ClientException
Description copied from interface: Gadget
Determines if the display state of the gadget

Returns:
Throws:
org.nuxeo.ecm.core.api.ClientException

isEqualTo

public boolean isEqualTo(Gadget gadget)

setCollapsed

public void setCollapsed(boolean collapsed)
                  throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setDefinitionUrl

public void setDefinitionUrl(URL url)
                      throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setDescription

public void setDescription(String description)
                    throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setName

public void setName(String name)
             throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setPosition

public void setPosition(int position)
                 throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setPreferences

public void setPreferences(Map<String,String> prefs)
                    throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setTitle

public void setTitle(String title)
              throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

getHeight

public int getHeight()
              throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

setHeight

public void setHeight(int height)
               throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

copyFrom

public void copyFrom(Gadget gadget)
              throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

getViewer

public String getViewer()
                 throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

hasPermission

public boolean hasPermission(String permissioName)
                      throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

save

public void save()
          throws org.nuxeo.ecm.core.api.ClientException
Throws:
org.nuxeo.ecm.core.api.ClientException

Nuxeo Enterprise Platform 5.4

Copyright © 2011 Nuxeo SAS. All Rights Reserved.