Web Components
  1. Classes
  2. QppMeta

File

platform-components-ng/projects/platform-components-lib/src/lib/components/meta/qpp-meta.ts

Description

A SmartContent Meta object. Meta is an aggregation of different types of meta objects which can be associated with a SmartContent element.

Extends

QppAbstractMeta

Index

Properties
Methods

Properties

Readonly type
Default value : QppMetaConstants.META

The meta object type.
attributes
Type : QppMetaAttribute[]
collections
Type : QppMetaCollection[]

Collections which are part of this Meta group
groups
Type : QppMetaGroup[]

(Sub) Groups in a Meta Group

Methods

appendAttribute
appendAttribute(attr: QppMetaAttribute)

Add an attribute in the Group

Parameters :
Name Type Optional Description
attr QppMetaAttribute No

An Attribute object to associated with the meta Group.
Returns : void
appendCollection
appendCollection(coll: QppMetaCollection)

Add a collection in the Group

Parameters :
Name Type Optional Description
coll QppMetaCollection No

collection
Returns : void

void
appendGroup
appendGroup(grp: QppMetaGroup)

Add a sub-group in the Group

Parameters :
Name Type Optional Description
grp QppMetaGroup No

group
Returns : void

void
appendNewAttribute
appendNewAttribute(attrName, attrValues)

Add an new attribute, with specified name and values, to the Group

Parameters :
Name Optional Description
attrName No

for Attribute
attrValues No

for Attribute
Returns : void

void
isEmpty
isEmpty()

Check if QXmlEditor.meta.Meta object is empty . A meta is considered empty if there is no Group/Collection/Attribute in it.

Returns : boolean

boolean
removeAttribute
removeAttribute(attribute: string | QppMetaAttribute)

Removes an Attribute meta object from its parent Group or Member

Parameters :
Name Type Optional Description
attribute string | QppMetaAttribute No

either name of a attribute meta object or the attribute object to be removed.
Returns : void

void
removeCollection
removeCollection(collection: string | QppMetaCollection)

Removes a Collection meta object from a parent Group or Member Meta Object.

Parameters :
Name Type Optional Description
collection string | QppMetaCollection No

either name of a collection meta object or the collection object to be removed.
Returns : void

void
removeGroup
removeGroup(group: string | QppMetaGroup)

Removes a Group meta object from a parent Group or Member meta object.

Parameters :
Name Type Optional Description
group string | QppMetaGroup No

either name of a group meta object or the group object to be removed.
Returns : void

void

result-matching ""

    No results matching ""