Package com.apptus.esales.connector

Class Subpanel

java.lang.Object

com.apptus.esales.connector.Subpanel

public class Subpanel
extends Object

A subpanel refers to a public panel, and can be provided to a dynamic page in order to retrieve content from several panels at once without having to predefine a zone. Each subpanel must have a unique name within a dynamic page.

Method Summary

Modifier and Type	Method	Description
Subpanel	addArgument(String name, String value)	Adds an argument to the map of arguments for this subpanel, where key is the parameter name, and value is the argument value.
Subpanel	addArguments(Map<String,String> arguments)	Appends a map of arguments to the arguments of this subpanel.
Subpanel	addAttribute(String name, String value)	Adds a local panel attribute to this subpanel.
Subpanel	addAttributes(Map<String,String> attributes)	Appends a map of attributes to the local panel attributes of this subpanel.
static Subpanel	create(String name, String publicPanel)	Creates a subpanel with a reference to a public panel.
Map<String,String>	getArguments()
Map<String,String>	getAttributes()
String	getName()
String	getPublicPanel()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Subpanel create(String name,
                              String publicPanel)

Creates a subpanel with a reference to a public panel. The subpanel can be supplied to a dynamic page.

Parameters:

name - The name of this subpanel, defining the path shown in the result. This name must be unique for each dynamic page it is provided to.

publicPanel - The path of the public panel.

Returns:

an object representing a subpanel, which can be supplied to a dynamic page

addArgument

public Subpanel addArgument(String name,
                            String value)

Adds an argument to the map of arguments for this subpanel, where key is the parameter name, and value is the argument value.

Parameters:

name - The parameter name.

value - The argument value.

Returns:

the subpanel with the added argument

addArguments

public Subpanel addArguments(Map<String,String> arguments)

Appends a map of arguments to the arguments of this subpanel. Any prior arguments with the same name will be overriden. These arguments will have precedence in any name collisions with the arguments provided to the dynamic page at request time.

Parameters:

arguments - A map of arguments to the subpanel, where key is the parameter name, and value is the argument value.

Returns:

the subpanel with the added arguments

addAttribute

public Subpanel addAttribute(String name,
                             String value)

Adds a local panel attribute to this subpanel. These attributes can be retrieved in the result using PanelContent.attributes().

Parameters:

name - The attribute name.

value - The attribute value.

Returns:

the subpanel with the added local attribute

addAttributes

public Subpanel addAttributes(Map<String,String> attributes)

Appends a map of attributes to the local panel attributes of this subpanel. Any prior attributes with the same name will be overridden. These attributes can be retrieved in the result using PanelContent.attributes().

Parameters:

attributes - A map of local attributes of the subpanel, where key is the attribute name, and value is the attribute value.

Returns:

the subpanel with the added attributes

getName

public String getName()

getPublicPanel

public String getPublicPanel()

getArguments

public Map<String,String> getArguments()

getAttributes

public Map<String,String> getAttributes()