Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
11g Release 2 (11.1.2.2.0)

E17490-03

<dvt:customAreaLayer>

dvt:customAreaLayer customAreaLayer custom area layer

UIComponent class: oracle.adf.view.faces.bi.component.thematicMap.UICustomAreaLayer
Component type: oracle.dss.adf.thematicMap.CustomAreaLayer

The customAreaLayer is a child of the thematicMap which let application developer to create a new area layer from their own region data and insert it into the hierarchy. The newly created layer will always gets added above the 'extendsLayer' in the layer hierarchy, and can be used in the same way as any other areaLayer

Model

The customAreaLayer uses a model to access the data in the underlying list. The specific model class is oracle.adf.view.rich.model.CollectionModel. You may also use other model instances, e.g., java.util.List, array, and javax.faces.model.DataModel. The customAreaLayer will automatically convert the instance into a CollectionModel.

Sample

The following sample shows a thematic map where a customAreaLayer called , "cr1", is built by aggregating states from the state layer.

              <dvt:thematicMap id="thematicMap" imageFormat="flash"
                               basemap="usa" 
                               inlineStyle="width:900px;height:600px">
                <dvt:customAreaLayer id="crl1"
                                     value="#{tmapBean.subRegionModel}"
                                     var="row" varStatus="rowStatus"
                                     extendsLayer="states">
                  <dvt:customArea areaid="O__row_name_" label="#{row.name}"
                                  areaList="#{row.subRegions}" id="ca1"/>
                </dvt:customAreaLayer>
                <dvt:areaLayer id="states" layer="states"/>
                <dvt:areaLayer id="custom" layer="crl1">
                  <dvt:areaDataLayer contentDelivery="immediate"
                                     value="#{tmapBean.subRegionModel}"
                                     var="row" varStatus="rowStatus" id="adl1">
                    <dvt:areaLocation name="O__row_name_" id="al1">
                      <dvt:area fillColor="#{row.color}"
                                shortDesc="#{row.subRegions}" id="a1"
                                value="#{row.name}"></dvt:area>
                    </dvt:areaLocation>
                  </dvt:areaDataLayer>
                </dvt:areaLayer>
              </dvt:thematicMap>        
       

Relationship with other tags

The <dvt:customAreaLayer> tag can have the following children:

Screen Shot(s)




Events

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding oracle.adf.view.faces.bi.component.thematicMap.UICustomAreaLayer Only EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
extendsLayer String Yes The name of the layer that this customAreaLayer aggregates
id String Yes The identifier for the component
rendered boolean Yes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc String Yes The short description for the customAreaLayer
value String Yes The data model being used by this customAreaLayer. The specific model class is org.apache.myfaces.trinidad.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The customAreaLayer will automatically convert the instance into a CollectionModel.
var String Yes Name of the EL variable used to reference each element of this Collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).
varStatus String Yes Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:
  • "model" - returns the CollectionModel for this component
  • "index" - returns the zero based row index