Package org.ametys.web.repository.page.virtual

Class ConfigurableVirtualZone

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.web.repository.page.virtual.ConfigurableVirtualZone

All Implemented Interfaces:

AmetysObject, DataHolder, Zone

public class ConfigurableVirtualZone
extends AbstractAmetysObject
implements Zone

A zone which is configurable

Field Summary

Fields

Modifier and Type	Field	Description
protected VirtualZoneConfiguration	_configuration	The VirtualPageZoneConfiguration
protected ConfigurableVirtualZoneFactory	_factory	The factory
protected String	_id	The id
protected AbstractConfigurableVirtualPage	_page	The Page
protected String	_scheme	The scheme

Fields inherited from interface org.ametys.web.repository.page.Zone

ZONEITEM_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
ConfigurableVirtualZone(AbstractConfigurableVirtualPage page, VirtualZoneConfiguration configuration, String scheme, ConfigurableVirtualZoneFactory factory)	Constructor to create a configurable zone item

Method Summary

Modifier and Type	Method	Description
protected DataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getName()	Retrieves the name of the current object.
Page	getParent()	Returns the parent object in the Ametys hierarchy.
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
SitemapElement	getSitemapElement()	Get the parent page of the zone
VirtualZoneItemConfiguration	getZoneItemConfiguration(String zoneItemId)	Get a zone item configuration by its name
AmetysObjectIterable<? extends ZoneItem>	getZoneItems()	Retrieve the list of used zone items
ModelAwareDataHolder	getZoneParametersHolder()	Get the view parameters

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Field Details

_page

protected AbstractConfigurableVirtualPage _page

The Page

_configuration

protected VirtualZoneConfiguration _configuration

The VirtualPageZoneConfiguration

_id

protected String _id

The id

_scheme

protected String _scheme

The scheme

_factory

protected ConfigurableVirtualZoneFactory _factory

The factory

Constructor Details

ConfigurableVirtualZone

public ConfigurableVirtualZone(AbstractConfigurableVirtualPage page,
 VirtualZoneConfiguration configuration,
 String scheme,
 ConfigurableVirtualZoneFactory factory)

Constructor to create a configurable zone item

Parameters:

page - The abstract virtual configurable page

configuration - The virtual page's zone configuration

scheme - The scheme

factory - The zone's factory

Method Details

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public Page getParent()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemapElement

public SitemapElement getSitemapElement()

Description copied from interface: Zone

Get the parent page of the zone

Specified by:

getSitemapElement in interface Zone

Returns:

The parent page. Cannot be null.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getZoneItemConfiguration

public VirtualZoneItemConfiguration getZoneItemConfiguration(String zoneItemId)

Get a zone item configuration by its name

Parameters:

zoneItemId - The zone item identifier

Returns:

La virtual page zone item configuration

getDataHolder

protected DataHolder getDataHolder()

Description copied from class: AbstractAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in class AbstractAmetysObject

Returns:

the DataHolder of this AmetysObject

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getZoneItems

public AmetysObjectIterable<? extends ZoneItem> getZoneItems()
                                                      throws AmetysRepositoryException

Description copied from interface: Zone

Retrieve the list of used zone items

Specified by:

getZoneItems in interface Zone

Returns:

The list of zone items. Cannot be null.

Throws:

AmetysRepositoryException - if an error occured

getZoneParametersHolder

public ModelAwareDataHolder getZoneParametersHolder()
                                             throws AmetysRepositoryException

Description copied from interface: Zone

Get the view parameters

Specified by:

getZoneParametersHolder in interface Zone

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.