org.apache.cocoon.portal.coplet
Class CopletDataFeatures

java.lang.Object
  extended byorg.apache.cocoon.portal.coplet.CopletDataFeatures

public final class CopletDataFeatures
extends Object

This class contains constants and utility methods for the standard features of a coplet.

Version:
$Id: CopletDataFeatures.java 322495 2005-10-16 17:52:43Z cziegeler $

Field Summary
static String ATTRIBUTE_FULLSCREEN
          This is the name of the coplet data attribute containing a boolean value indicating if the coplet supports the full-screen mode.
static String ATTRIBUTE_MANDATORY
          This is the name of the coplet data attribute containing a boolean value indicating if a user is allowed to remove the coplet (default is false meaning it's not mandatory and the user is allowed to remove it.
static String ATTRIBUTE_SIZABLE
          This is the name of the coplet data attribute containing a boolean value indicating if the user is allowed to resize the coplet.
 
Constructor Summary
CopletDataFeatures()
           
 
Method Summary
static Object getAttributeValue(CopletData data, String key, Object defaultValue)
           
static boolean isMandatory(CopletData data)
          Is this coplet mandatory?
static boolean isSizable(CopletData data)
          Is this coplet sizable?
static void setMandatory(CopletData data, boolean value)
           
static void setSizable(CopletData data, boolean value)
           
static boolean supportsFullScreenMode(CopletData data)
          Does this coplet support the full screen mode?
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_SIZABLE

public static final String ATTRIBUTE_SIZABLE
This is the name of the coplet data attribute containing a boolean value indicating if the user is allowed to resize the coplet. (default is true)

See Also:
Constant Field Values

ATTRIBUTE_MANDATORY

public static final String ATTRIBUTE_MANDATORY
This is the name of the coplet data attribute containing a boolean value indicating if a user is allowed to remove the coplet (default is false meaning it's not mandatory and the user is allowed to remove it.

See Also:
Constant Field Values

ATTRIBUTE_FULLSCREEN

public static final String ATTRIBUTE_FULLSCREEN
This is the name of the coplet data attribute containing a boolean value indicating if the coplet supports the full-screen mode. (default is true)

See Also:
Constant Field Values
Constructor Detail

CopletDataFeatures

public CopletDataFeatures()
Method Detail

getAttributeValue

public static Object getAttributeValue(CopletData data,
                                       String key,
                                       Object defaultValue)

isSizable

public static boolean isSizable(CopletData data)
Is this coplet sizable?


isMandatory

public static boolean isMandatory(CopletData data)
Is this coplet mandatory?


supportsFullScreenMode

public static boolean supportsFullScreenMode(CopletData data)
Does this coplet support the full screen mode?


setSizable

public static void setSizable(CopletData data,
                              boolean value)

setMandatory

public static void setMandatory(CopletData data,
                                boolean value)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.