mx.controls.olapDataGridClasses.OLAPDataGridRendererProvider - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.controls.olapDataGridClasses
Class	public class OLAPDataGridRendererProvider
Inheritance	OLAPDataGridRendererProvider Object
Subclasses	OLAPDataGridHeaderRendererProvider, OLAPDataGridItemRendererProvider

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The OLAPDataGridRendererProvider class defines the base class for assigning item renderers used by the OLAPDataGrid control. Use properties of the OLAPDataGridRendererProvider class to configure where an item renderer is used in an OLAPDataGrid control.

Each cell in an OLAPDataGrid control is a result of an intersection between the members along a row and the members along a column of the control. However, when you assign an item renderer to an OLAPDataGrid control, you only specify the uniqueName and type properties for one of the dimensions, either row or column. Therefore, you can create a situation where two different item renderers are assigned to the same cell of the control.

In case of a conflict between two or more item renderers, the OLAPDataGrid control applies the item renderer based on the following priorities:

type = OLAPDataGrid.OLAP_MEMBER
type = OLAPDataGrid.OLAP_LEVEL
type = OLAPDataGrid.OLAP_HIERARCHY
type = OLAPDataGrid.OLAP_DIMENSION

Therefore, if an item renderer with a type value of OLAPDataGrid.OLAP_LEVEL and an item renderer with a type value of OLAPDataGrid.OLAP_HIERARCHY are applied to the same cell, the OLAPDataGrid control applies the item renderer with a type value of OLAPDataGrid.OLAP_LEVEL.

If two item renderers have the same value for the type property, the OLAPDataGrid control determines which renderer more closely matches the item, and uses it.

See also

mx.controls.OLAPDataGrid

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		renderer : IFactory The renderer object used for customizing the OLAPDataGrid control.	OLAPDataGridRendererProvider
		styleName : String The name of a CSS style declaration for controlling the appearance of the cell.	OLAPDataGridRendererProvider
		type : int Specifies whether the renderer is applied to a dimension (OLAPDataGrid.OLAP_DIMENSION), hierarchy(OLAPDataGrid.OLAP_HIERARCHY), level(OLAPDataGrid.OLAP_LEVEL), or member (OLAPDataGrid.OLAP_MEMBER) of an axis.	OLAPDataGridRendererProvider
		uniqueName : String The unique name of the IOLAPElement to which the renderer is applied.	OLAPDataGridRendererProvider

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

renderer

property

renderer:IFactory

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The renderer object used for customizing the OLAPDataGrid control.

Implementation
public function get renderer():IFactory
public function set renderer(value:IFactory):void

styleName

property

public var styleName:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The name of a CSS style declaration for controlling the appearance of the cell.

For example, you define the following style in your application, and then use the styleName property to associate it with a specific hierarchy in an OLAP schema:

      <Style>
        .monthStyle
          {
            color:0x755762
            fontSize:14
          }
      </Style>
     
      <mx:ODGHeaderRendererProvider 
        type="OLAPDataGrid.OLAP_HIERARCHY" 
        uniqueName="[Time][Month]" styleName="monthStyle"/>

type

property

type:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies whether the renderer is applied to a dimension (OLAPDataGrid.OLAP_DIMENSION), hierarchy(OLAPDataGrid.OLAP_HIERARCHY), level(OLAPDataGrid.OLAP_LEVEL), or member (OLAPDataGrid.OLAP_MEMBER) of an axis.

Set this property based on the setting of the uniqueName property. For example, if the uniqueName property references a hierarchy of an OLAP schema, set this property to OLAPDataGrid.OLAP_HIERARCHY.

Implementation
public function get type():int
public function set type(value:int):void

uniqueName

property

uniqueName:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The unique name of the IOLAPElement to which the renderer is applied. For example, "[TimeDim][YearHier][2007]" is a unique name, where "2007" is the level belonging to the "YearHier" hierarchy of the "TimeDim" dimension.

The uniqueName property and the type property together specify the target of the item renderer. Because the unique name of "[TimeDim][YearHier][2007]" specifies a level of an OLAP schema, set the type property to OLAPDataGrid.OLAP_LEVEL.

Implementation
public function get uniqueName():String
public function set uniqueName(value:String):void