dw.experience
Class Component
Object
dw.experience.Component
This class represents a page designer managed component as part of a page. A component comprises of multiple regions that again hold components, thus spanning a hierarchical tree of components. Using the PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings) a region can be rendered which implicitly includes rendering of all contained visible components. All content attributes (defined by the corresponding component type) can be accessed, reading the accordant values as provided by the content editor that created this component.
See Also:
Properties
ID  :  String  (Read Only)
The id of this component.
name  :  String  (Read Only)
The name of this component
typeID  :  String  (Read Only)
The type id of this component.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAttribute(attributeID : String) : Object
Returns the raw attribute value identified by the specified attribute id.
getID() : String
Returns the id of this component.
getName() : String
Returns the name of this component
getRegion(id : String) : Region
Returns the component region that matches the given id.
getTypeID() : String
Returns the type id of this component.
Methods inherited from class Object
Method Detail
getAttribute
getAttribute(attributeID : String) : Object
Returns the raw attribute value identified by the specified attribute id. By raw attribute value we denote the value as provided by the content editor when setting up this component. This value might be fundamentally different from the value as provided through the content dictionary when the render function of the component is invoked. This is due to the fact that during rendering the raw value is processed before being stored in the content dictionary - for example link placeholders in markup text are resolved to real URLs as part of such processing. Accessing the raw value can be helpful if render logic of the component needs to operate on these unprocessed values.
Parameters:
attributeID - the id of the desired attribute
Returns:
the value of the desired attribute, or null if not found

getID
getID() : String
Returns the id of this component.
Returns:
the component id

getName
getName() : String
Returns the name of this component
Returns:
the component name

getRegion
getRegion(id : String) : Region
Returns the component region that matches the given id.
Parameters:
id - the id of the desired component region
Returns:
the region, or null if not found.

getTypeID
getTypeID() : String
Returns the type id of this component.
Returns:
the component type id