public abstract class ComplexExtendedProperties<T extends ComplexExtendedProperties> extends java.lang.Object implements ExtendedProperties
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AF_NS |
static java.lang.String |
DVT_NS |
static java.lang.String |
F_NS |
Constructor and Description |
---|
ComplexExtendedProperties() |
Modifier and Type | Method and Description |
---|---|
protected void |
_applyToRootElement(ADFDesignTimeContext dtContext,
org.w3c.dom.Element root) |
protected void |
_applyToRootElement(ADFDesignTimeContext dtContext,
org.w3c.dom.Element root,
boolean onlyAttributes) |
void |
applyChanges(BinderParams bindParams)
Applies changes from this set of properties to the subtree rooted by the
bind root in the bind params.
|
void |
applyChanges(BinderParams bindParams,
boolean onlyAttributes)
Applies changes on the subtree root conditionally, based on the value of
the
onlyAttributes parameter.If the value of this parameter is true,
only attribute changes will be applied. |
void |
applyChanges(BinderParams bindParams,
org.w3c.dom.Element rootElement)
Applies changes from this set of properties to the subtree rooted by the
bind root in the bind params.
|
void |
applyChanges(BinderParams bindParams,
org.w3c.dom.Element rootElement,
boolean onlyAttributes)
Applies changes from this set of properties to the subtree rooted by the
bind root in the bind params.
|
void |
applyChanges(CreatorParams params,
org.w3c.dom.Element rootElement,
boolean onlyAttributes)
Applies changes from this set of properties to the subtree rooted by the
bind root in the CreatorParams params.
|
void |
cloneFrom(ComplexExtendedProperties properties) |
protected java.lang.String |
getAttribute(java.lang.String localName)
Gets the attribute that will be applied on the root element of the bind root.
|
protected T |
getComplexChild(java.lang.String namespace,
java.lang.String localName)
In the majority of the cases, this override will be actually called, and most child tags will have the
defautl rank of 1.
|
protected T |
getComplexChild(java.lang.String namespace,
java.lang.String localName,
java.lang.Object rank)
Gets the value of a simple child that will be added to the root element of the
bind root.
|
protected java.util.List<T> |
getComplexChildAsList(java.lang.String namespace,
java.lang.String localName) |
abstract java.lang.String |
getTagName() |
void |
populateAttributesAndChildTags(org.w3c.dom.Element root,
java.util.List<java.lang.String> packages) |
protected void |
removeComplexChildList(java.lang.String namespace,
java.lang.String localName)
This call will remove all occurences of a given child tag that was set as
a list.
|
protected void |
setAttribute(java.lang.String localName,
java.lang.String value)
Sets the attribute that will be applied on the root element of the bind root.
|
protected void |
setComplexChild(java.lang.String namespace,
java.lang.String localName,
java.lang.Object rank,
T childTag)
Sets the value of a simple child that will be added to the root element of the
bind root.
|
protected void |
setComplexChild(java.lang.String namespace,
java.lang.String localName,
T childTag) |
protected void |
setComplexChildAsList(java.lang.String namespace,
java.util.List<T> tags) |
public static final java.lang.String DVT_NS
public static final java.lang.String F_NS
public static final java.lang.String AF_NS
public abstract java.lang.String getTagName()
public void applyChanges(BinderParams bindParams)
applyChanges
in interface ExtendedProperties
bindParams
- The bind params containing the binding rootpublic void applyChanges(BinderParams bindParams, boolean onlyAttributes)
onlyAttributes
parameter.If the value of this parameter is true,
only attribute changes will be applied. Otherwise both attributes and child tags (if exist)
The bind root must be of an Element type for this to take into affect.bindParams
- The bind params containing the binding rootonlyAttributes
- Boolean, true of applying only attributes from the options class to the bind root Element.public void applyChanges(BinderParams bindParams, org.w3c.dom.Element rootElement)
bindParams
- The bind params containing the binding rootrootElement
- A Element
that represents the root. If null, an attempt will be made to retrieve
it from the BinderParams
.public void applyChanges(BinderParams bindParams, org.w3c.dom.Element rootElement, boolean onlyAttributes)
bindParams
- The bind params containing the binding rootrootElement
- A Element
that represents the root. If null, an attempt will be made to retrieve
it from the BinderParams
.onlyAttributes
- If true, then apply only attribute changes to the subtree rootpublic void applyChanges(CreatorParams params, org.w3c.dom.Element rootElement, boolean onlyAttributes)
params
- The CreatorParams instance containing the root element upon
which the method will try to apply its properties and child tags.rootElement
- A Element
that represents the root. If null, an attempt will be made to retrieve
it from the BinderParams
.onlyAttributes
- If true, then apply only attribute changes to the subtree rootprotected void setAttribute(java.lang.String localName, java.lang.String value)
localName
- Localname of the attributevalue
- Value to setprotected java.lang.String getAttribute(java.lang.String localName)
localName
- The name of the attribute.localName
.protected void setComplexChild(java.lang.String namespace, java.lang.String localName, T childTag)
protected void setComplexChild(java.lang.String namespace, java.lang.String localName, java.lang.Object rank, T childTag)
namespace
- Namespace of the childlocalName
- Localname of the childrank
- The rank of the childTagchildTag
- The child tag that will be added to this ComplexExtendedProperties
Some complex attributes accept the same childTag type more then once. For instance the SeriesSet tag can have one or more
Series tags as child tags. In these cases we will add these child tags using a rank parameter so that the uniqueness of the
Map key would be enforced.protected java.util.List<T> getComplexChildAsList(java.lang.String namespace, java.lang.String localName)
namespace
- namespace of the TaglocalName
- the local name of the Tagprotected void setComplexChildAsList(java.lang.String namespace, java.util.List<T> tags)
protected void removeComplexChildList(java.lang.String namespace, java.lang.String localName)
namespace
- namespace of the child tag we want to removelocalName
- the name of the child tag.protected T getComplexChild(java.lang.String namespace, java.lang.String localName)
namespace
- The namespace URI for the child tag we are trying to retrievelocalName
- The local name of the child tag we are trying to retrieve.protected T getComplexChild(java.lang.String namespace, java.lang.String localName, java.lang.Object rank)
namespace
- Namespace of the childlocalName
- Localname of the childrank
- The rank of the child tag
Some complex attributes accept the same childTag type more then once. For instance the SeriesSet tag can have one or more
Series tags as child tags. In these cases we will add these child tags using a rank parameter so that the uniqueness of the
Map key would be enforced.protected final void _applyToRootElement(ADFDesignTimeContext dtContext, org.w3c.dom.Element root)
protected final void _applyToRootElement(ADFDesignTimeContext dtContext, org.w3c.dom.Element root, boolean onlyAttributes)
public void cloneFrom(ComplexExtendedProperties properties)
public void populateAttributesAndChildTags(org.w3c.dom.Element root, java.util.List<java.lang.String> packages)