public class GroupDescriptor extends Object implements ElementDescriptor, com.escenic.module.CanContainModules
ElementDescriptor
that describes a valid Group
instance.Modifier and Type | Field and Description |
---|---|
static List<PropertyDescriptor> |
EMPTY_OPTIONS_LIST |
Constructor and Description |
---|
GroupDescriptor(Integer pPublicationId,
String pName,
String pLabel,
String pDescription,
boolean pRoot,
List<AreaDescriptor> pAreaDescriptors) |
GroupDescriptor(Integer pPublicationId,
String pName,
String pLabel,
String pDescription,
boolean pRoot,
List<PropertyDescriptor> pOptionsDescriptors,
List<AreaDescriptor> pAreaDescriptors)
Creates a new GroupDescriptor.
|
GroupDescriptor(Integer pPublicationId,
String pName,
String pLabel,
String pDescription,
boolean pRoot,
List<PropertyDescriptor> pOptionsDescriptors,
List<AreaDescriptor> pAreaDescriptors,
List<com.escenic.module.Module> pModules) |
GroupDescriptor(Integer pPublicationId,
String pName,
String pLabel,
String pDescription,
boolean pRoot,
List<PropertyDescriptor> pOptionsDescriptors,
List<AreaDescriptor> pAreaDescriptors,
List<com.escenic.module.Module> pModules,
URI pURI) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object pOther) |
List<AreaDescriptor> |
getAreaDescriptors() |
String |
getDescription() |
String |
getLabel() |
com.escenic.module.Module |
getModule(URI pURI,
String pElementName)
The first module instance with the URI and element name as specified, and with no attributes, or
null if
there is no module which matches. |
com.escenic.module.Module |
getModule(URI pURI,
String pElementName,
String pAttributeName,
String pValue)
The first module instance with the URI and element name as specified, and with an attribute value as specified, or
null if there is no module which matches. |
List<com.escenic.module.Module> |
getModules()
Gets all the modules regardless of namespace.
|
List<com.escenic.module.Module> |
getModules(URI pURI)
Return a list of Module instances for the containing element.
|
List<com.escenic.module.Module> |
getModules(URI pURI,
String pElementName)
Return a list of module instances with the URI and element name as specified.
|
List<com.escenic.module.Module> |
getModules(URI pURI,
String pElementName,
String pAttributeName,
String pValue)
Return a list of module instances with the URI and element name as specified, and with an attribute value as
specified.
|
String |
getName() |
MapPropertyDescriptor |
getOptionsDescriptor() |
Integer |
getPublicationId() |
URI |
getURI() |
int |
hashCode() |
boolean |
hasModules()
If there are any modules registered, this would return true.
|
boolean |
isRoot() |
public static final List<PropertyDescriptor> EMPTY_OPTIONS_LIST
public GroupDescriptor(Integer pPublicationId, String pName, String pLabel, String pDescription, boolean pRoot, List<AreaDescriptor> pAreaDescriptors)
public GroupDescriptor(Integer pPublicationId, String pName, String pLabel, String pDescription, boolean pRoot, List<PropertyDescriptor> pOptionsDescriptors, List<AreaDescriptor> pAreaDescriptors)
AreaDescriptors
defines the available areas for a Group
.
If the area descriptor's allowed elements contain ElementDescriptor
s that are instanceof
GroupCreator
, then they're replaced by the return value from
GroupCreator.createGroup(GroupDescriptor)
.pRoot
- flag to indicate if this GroupDescriptor may be used as a "root group".pOptionsDescriptors
- pAreaDescriptors
- the available areas.GroupCreator
public GroupDescriptor(Integer pPublicationId, String pName, String pLabel, String pDescription, boolean pRoot, List<PropertyDescriptor> pOptionsDescriptors, List<AreaDescriptor> pAreaDescriptors, List<com.escenic.module.Module> pModules)
public GroupDescriptor(Integer pPublicationId, String pName, String pLabel, String pDescription, boolean pRoot, List<PropertyDescriptor> pOptionsDescriptors, List<AreaDescriptor> pAreaDescriptors, List<com.escenic.module.Module> pModules, URI pURI)
public Integer getPublicationId()
public String getName()
getName
in interface ElementDescriptor
public String getLabel()
getLabel
in interface ElementDescriptor
public URI getURI()
public String getDescription()
getDescription
in interface ElementDescriptor
public MapPropertyDescriptor getOptionsDescriptor()
public List<AreaDescriptor> getAreaDescriptors()
public boolean isRoot()
public List<com.escenic.module.Module> getModules()
com.escenic.module.CanContainModules
getModules
in interface com.escenic.module.CanContainModules
public List<com.escenic.module.Module> getModules(URI pURI)
com.escenic.module.CanContainModules
getModules
in interface com.escenic.module.CanContainModules
pURI
- The URI of the namespace of the markuppublic List<com.escenic.module.Module> getModules(URI pURI, String pElementName)
com.escenic.module.CanContainModules
getModules
in interface com.escenic.module.CanContainModules
pURI
- The URI of the namespace of the markuppElementName
- The name of the element you are looking forpublic List<com.escenic.module.Module> getModules(URI pURI, String pElementName, String pAttributeName, String pValue)
com.escenic.module.CanContainModules
getModules
in interface com.escenic.module.CanContainModules
pURI
- The URI of the namespace of the markuppElementName
- The name of the element you are looking forpAttributeName
- The name of the attribute you want to look forpValue
- The value of the attribute you want to look for, or null
if you want an element without this
attribute.public com.escenic.module.Module getModule(URI pURI, String pElementName, String pAttributeName, String pValue)
com.escenic.module.CanContainModules
null
if there is no module which matches.getModule
in interface com.escenic.module.CanContainModules
pURI
- The URI of the namespace of the markuppElementName
- The name of the element you are looking fornull
if no such module exists.public com.escenic.module.Module getModule(URI pURI, String pElementName)
com.escenic.module.CanContainModules
null
if
there is no module which matches.getModule
in interface com.escenic.module.CanContainModules
pURI
- The URI of the namespace of the markuppElementName
- The name of the element you are looking fornull
if no such module exists.public boolean hasModules()
com.escenic.module.CanContainModules
hasModules
in interface com.escenic.module.CanContainModules
true
if any modules exist.© 1998- 2018 Stibo DX