feathers.controls.renderers.DefaultDataGridHeaderRenderer

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		alpha : Number The opacity of the object.	DisplayObject
		base : DisplayObject [read-only] The topmost object in the display tree the object is part of.	DisplayObject
		blendMode : String The blend mode determines how the object is blended with the objects underneath.	DisplayObject
		bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent.	DisplayObject
		columnIndex : int The index of the header within the layout.	DefaultDataGridHeaderRenderer
		data : DataGridColumn A column from a data grid.	DefaultDataGridHeaderRenderer
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		filter : FragmentFilter The filter that is attached to the display object.	DisplayObject
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	FeathersControl
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all DefaultDataGridHeaderRenderer components.	DefaultDataGridHeaderRenderer
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.	DisplayObject
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		mask : DisplayObject The display object that acts as a mask for the current object.	DisplayObject
		maskInverted : Boolean Indicates if the masked region of this object is set to be inverted.	DisplayObject
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		name : String The name of the display object (default: null).	DisplayObject
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		numChildren : int [read-only] The number of children of this container.	DisplayObjectContainer
		numLines : int [read-only] The number of text lines displayed by the renderer.	DefaultDataGridHeaderRenderer
		owner : DataGrid The data grid that contains this header renderer.	DefaultDataGridHeaderRenderer
		parent : DisplayObjectContainer [read-only] The display object container that contains this display object.	DisplayObject
		pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e.	DisplayObject
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		root : DisplayObject [read-only] The root object the display object is connected to (i.e.	DisplayObject
		rotation : Number The rotation of the object in radians.	DisplayObject
		scale : Number Sets both 'scaleX' and 'scaleY' to the same value.	DisplayObject
		scaleX : Number The horizontal scale factor.	DisplayObject
		scaleY : Number The vertical scale factor.	DisplayObject
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		skewX : Number The horizontal skew angle in radians.	DisplayObject
		skewY : Number The vertical skew angle in radians.	DisplayObject
		sortOrder : String Indicates if this column is sorted.	DefaultDataGridHeaderRenderer
		stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage.	DisplayObject
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		textRendererFactory : Function A function that generates an ITextRenderer that displays the header's text.	DefaultDataGridHeaderRenderer
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		touchable : Boolean Indicates if this object (and its children) will receive touch events.	DisplayObject
		touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object.	DisplayObjectContainer
		transformationMatrix : Matrix The transformation matrix of the object relative to its parent.	DisplayObject
		transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent.	DisplayObject
		useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite.	DisplayObject
		visible : Boolean The visibility of the object.	DisplayObject
		width : Number [override] The width of the component, in pixels.	FeathersControl
		x : Number The x coordinate of the object relative to the local coordinates of the parent.	DisplayObject
		y : Number The y coordinate of the object relative to the local coordinates of the parent.	DisplayObject

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		textRendererStyleName : String = feathers-data-grid-header-renderer-text-renderer The value added to the styleNameList of the text renderer.	DefaultDataGridHeaderRenderer

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DefaultDataGridHeaderRenderer() Constructor.	DefaultDataGridHeaderRenderer
		addChild(child:DisplayObject):DisplayObject Adds a child to the container.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index.	DisplayObjectContainer
		addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object.	DisplayObject
		alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object.	DisplayObject
		broadcastEvent(event:Event):void Dispatches an event on all children (recursively).	DisplayObjectContainer
		broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively).	DisplayObjectContainer
		contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively).	DisplayObjectContainer
		dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type.	EventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type.	EventDispatcher
		dispose():void [override] Disposes the resources of all children.	DisplayObjectContainer
		drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object.	DisplayObject
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		getChildAt(index:int):DisplayObject Returns a child object at a certain index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively).	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found.	DisplayObjectContainer
		getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system.	DisplayObject
		globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system.	DisplayObject
		hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for the given event type.	EventDispatcher
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.	DisplayObjectContainer
		hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask.	DisplayObject
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates.	DisplayObject
		localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates.	DisplayObject
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container.	DisplayObjectContainer
		removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included).	DisplayObjectContainer
		removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object.	DisplayObject
		removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null.	DisplayObject
		removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it.	DisplayObject
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		render(painter:Painter):void [override] Renders the display object with the help of a painter object.	DisplayObjectContainer
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index.	DisplayObjectContainer
		setRequiresRedraw():void Forces the object to be redrawn in the next frame.	DisplayObject
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class).	DisplayObjectContainer
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children.	DisplayObjectContainer
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

	Method	Defined By
		autoSizeIfNeeded():Boolean If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.	DefaultDataGridHeaderRenderer
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		focusInHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.	FeathersControl
		focusOutHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.	FeathersControl
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.	FeathersControl
		itemToText(item:DataGridColumn):String Determines which text to display in the header.	DefaultDataGridHeaderRenderer
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl

Summary	Defined By
added	Dispatched when an object is added to a parent.	DisplayObject
addedToStage	Dispatched when an object is connected to the stage (directly or indirectly).	DisplayObject
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
enterFrame	Dispatched once every frame on every object that is connected to the stage.	DisplayObject
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
keyDown	Dispatched when a key on the keyboard is pressed.	DisplayObject
keyUp	Dispatched when a key on the keyboard is released.	DisplayObject
removed	Dispatched when an object is removed from its parent.	DisplayObject
removedFromStage	Dispatched when an object is removed from the stage and won't be rendered any longer.	DisplayObject
resize	Dispatched when the width or height of the control changes.	FeathersControl
touch	Dispatched when an object is touched.	DisplayObject
triggered	Dispatched when the the user taps or clicks the header renderer.	DefaultDataGridHeaderRenderer

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
backgroundDisabledSkin	Type: starling.display.DisplayObject A background to display when the header renderer is disabled. In the following example, the header renderers is given a disabled background skin: headerRenderer.backgroundDisabledSkin = new Image( texture ); The default value is `null`. See also backgroundSkin	DefaultDataGridHeaderRenderer
backgroundSkin	Type: starling.display.DisplayObject A background to behind the header renderer's content. In the following example, the header renderers is given a background skin: headerRenderer.backgroundSkin = new Image( texture ); The default value is `null`. See also backgroundDisabledSkin	DefaultDataGridHeaderRenderer
customTextRendererStyleName	Type: String A style name to add to the header renderer's text renderer sub-component. Typically used by a theme to provide different styles to different header renderers. In the following example, a custom text renderer style name is passed to the header renderer: headerRenderer.customTextRendererStyleName = "my-custom-header-text"; In your theme, you can target this sub-component style name to provide different styles than the default: getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-header-text", setCustomHeaderTextStyles ); The default value is `null`. See also DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER feathers.core.FeathersControl.styleNameList textRendererFactory	DefaultDataGridHeaderRenderer
disabledFontStyles	Type: starling.text.TextFormat The font styles used to display the header renderer's text when the component is disabled. In the following example, the disabled font styles are customized: headerRenderer.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 ); Note: The `starling.text.TextFormat` class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the `textRendererFactory` to set more advanced styles on the text renderer. The default value is `null`. See also starling.text.TextFormat fontStyles	DefaultDataGridHeaderRenderer
focusIndicatorSkin	Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when `showFocus()` is called. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft focusPadding	FeathersControl
focusPadding	Type: Number Quickly sets all focus padding properties to the same value. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft	FeathersControl
focusPaddingBottom	Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingLeft	Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingRight	Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingTop	Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also focusPadding	FeathersControl
fontStyles	Type: starling.text.TextFormat The font styles used to display the header renderer's text. In the following example, the font styles are customized: headerRenderer.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 ); Note: The `starling.text.TextFormat` class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the `textRendererFactory` to set more advanced styles. The default value is `null`. See also starling.text.TextFormat disabledFontStyles	DefaultDataGridHeaderRenderer
horizontalAlign	Type: String The location where the header renderer's content is aligned horizontally (on the x-axis). In the following example, the horizontal alignment is changed to right: headerRenderer.horizontalAlign = HorizontalAlign.RIGHT; Note: The `HorizontalAlign.JUSTIFY` constant is not supported. The default value is `feathers.layout.HorizontalAlign.LEFT`. See also feathers.layout.HorizontalAlign.LEFT feathers.layout.HorizontalAlign.CENTER feathers.layout.HorizontalAlign.RIGHT	DefaultDataGridHeaderRenderer
padding	Type: Number Quickly sets all padding properties to the same value. The `padding` getter always returns the value of `paddingTop`, but the other padding values may be different. In the following example, the padding on all four sides is set to 20 pixels: headerRenderer.padding = 20; The default value is `0`. See also paddingTop paddingRight paddingBottom paddingLeft	DefaultDataGridHeaderRenderer
paddingBottom	Type: Number The minimum space, in pixels, between the component's bottom edge and the component's content. In the following example, the bottom padding is set to 20 pixels: headerRenderer.paddingBottom = 20; The default value is `0`. See also padding	DefaultDataGridHeaderRenderer
paddingLeft	Type: Number The minimum space, in pixels, between the component's left edge and the component's content. In the following example, the left padding is set to 20 pixels: headerRenderer.paddingLeft = 20; The default value is `0`. See also padding	DefaultDataGridHeaderRenderer
paddingRight	Type: Number The minimum space, in pixels, between the component's right edge and the component's content. In the following example, the right padding is set to 20 pixels: headerRenderer.paddingRight = 20; The default value is `0`. See also padding	DefaultDataGridHeaderRenderer
paddingTop	Type: Number The minimum space, in pixels, between the component's top edge and the component's content. In the following example, the top padding is set to 20 pixels: headerRenderer.paddingTop = 20; The default value is `0`. See also padding	DefaultDataGridHeaderRenderer
sortAscendingIcon	Type: starling.display.DisplayObject An icon to display when the column is sorted in ascending order. In the following example, sort ascending icon is customized: headerRenderer.sortAscendingIcon = new Image( texture ); The default value is `null`. See also sortDescendingIcon	DefaultDataGridHeaderRenderer
sortDescendingIcon	Type: starling.display.DisplayObject An icon to display when the column is sorted in descending order. In the following example, the sort descending icon is customized: headerRenderer.sortDescendingIcon = new Image( texture ); The default value is `null`. See also sortAscendingIcon	DefaultDataGridHeaderRenderer
verticalAlign	Type: String The location where the header renderer's content is aligned vertically (on the y-axis). In the following example, the vertical alignment is changed to bottom: headerRenderer.verticalAlign = VerticalAlign.BOTTOM; Note: The `VerticalAlign.JUSTIFY` constant is not supported. The default value is `feathers.layout.VerticalAlign.MIDDLE`. See also feathers.layout.VerticalAlign.TOP feathers.layout.VerticalAlign.MIDDLE feathers.layout.VerticalAlign.BOTTOM	DefaultDataGridHeaderRenderer
wordWrap	Type: Boolean Determines if the text wraps to the next line when it reaches the width (or max width) of the component. In the following example, the header renderer's text is wrapped: headerRenderer.wordWrap = true; The default value is `false`.	DefaultDataGridHeaderRenderer

	Constant	Defined By
		DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER : String = feathers-data-grid-header-renderer-text-renderer [static] The default value added to the styleNameList of the text renderer.	DefaultDataGridHeaderRenderer
		INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = focus [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = styles [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

Property Detail

columnIndex

property

columnIndex:int

The index of the header within the layout.

This property is set by the data grid, and should not be set manually.

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

data

property

data:DataGridColumn

A column from a data grid. The data may change if this header renderer is reused for a new column because it's no longer needed for the original column.

This property is set by the data grid, and should not be set manually.

Implementation
public function get data():DataGridColumn
public function set data(value:DataGridColumn):void

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all DefaultDataGridHeaderRenderer components.

The default value is null.

numLines

property

numLines:int [read-only]

The number of text lines displayed by the renderer. The component may contain multiple text lines if the text contains line breaks or if the wordWrap property is enabled.

Implementation
public function get numLines():int

See also

wordWrap

owner

property

owner:DataGrid

The data grid that contains this header renderer.

This property is set by the data grid, and should not be set manually.

Implementation
public function get owner():DataGrid
public function set owner(value:DataGrid):void

sortOrder

property

sortOrder:String

Indicates if this column is sorted.

This property is set by the data grid, and should not be set manually.

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

textRendererFactory

property

textRendererFactory:Function

A function that generates an ITextRenderer that displays the header's text. The factory may be used to set custom properties on the ITextRenderer.

In the following example, a custom text renderer factory is passed to the renderer:

    headerRenderer.textRendererFactory = function():ITextRenderer
    {
        var textRenderer:TextFieldTextRenderer = new TextFieldTextRenderer();
        textRenderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
        textRenderer.embedFonts = true;
        return textRenderer;
    };

The default value is null.

Implementation
public function get textRendererFactory():Function
public function set textRendererFactory(value:Function):void

textRendererStyleName

property

protected var textRendererStyleName:String = feathers-data-grid-header-renderer-text-renderer

The value added to the styleNameList of the text renderer. This variable is protected so that sub-classes can customize the label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER.

To customize the text renderer style name without subclassing, see customTextRendererStyleName.

Constructor Detail

DefaultDataGridHeaderRenderer

()

Constructor

public function DefaultDataGridHeaderRenderer()

Constructor.

Method Detail

autoSizeIfNeeded

()

method

protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Returns

Boolean

itemToText

()

method

protected function itemToText(item:DataGridColumn):String

Determines which text to display in the header.

Parameters

item:DataGridColumn

Returns

String

Event Detail

triggered

Event

Event Object Type: starling.events.Event
Event.type property = starling.events.Event.TRIGGERED

Dispatched when the the user taps or clicks the header renderer. The touch must remain within the bounds of the header renderer on release to register as a tap or a click.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`data`	null
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Event type for a triggered button.

Constant Detail

DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER

Constant

public static const DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER:String = feathers-data-grid-header-renderer-text-renderer

The default value added to the styleNameList of the text renderer.

Dimanche Mars 3 2019, 06:15 PM +01:00

Starling and Feathers Extensions AS3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
DefaultDataGridHeaderRenderer	Properties \| Methods \| Events \| Styles \| Constants

Package	feathers.controls.renderers
Class	public class DefaultDataGridHeaderRenderer
Inheritance	DefaultDataGridHeaderRenderer FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements	IDataGridHeaderRenderer