| Package | mx.controls.advancedDataGridClasses |
| Class | public class AdvancedDataGridSortItemRenderer |
| Inheritance | AdvancedDataGridSortItemRenderer  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
You can override the default sort item renderer by creating a custom
sort item renderer.
There are no special requirements for the sort item renderer, but Adobe
suggests that the sort item renderer call the getFieldSortInfo() method
in the override of the commitProperties() method
to fetch the sort information so that it can display the icon and text appropriately.
You can customize when the sorting gets triggered by dispatching the
AdvancedDataGridEvent.SORT event.
See also
| Property | Defined By | ||
|---|---|---|---|
| grid : AdvancedDataGrid
[read-only]
Returns a reference to the associated AdvancedDataGrid control.
| AdvancedDataGridSortItemRenderer | ||
| label : IUITextField
The internal UITextField object that renders the label of this Button.
| AdvancedDataGridSortItemRenderer | ||
 | resourceManager : IResourceManager
[write-only]
A reference to the object which manages
all of the application's localized resources.
| UIComponent | |
| unscaledHeight : Number
[read-only]
A convenience method for determining the unscaled height
of the component.
| UIComponent | |
| unscaledWidth : Number
[read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList().
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
|
Constructor
| AdvancedDataGridSortItemRenderer | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point.
| DisplayObjectContainer | |
|
Queues a function to be called later.
| UIComponent | |
|
Deletes a style property from this component instance.
| UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates.
| UIComponent | |
|
Converts a Point object from content to local coordinates.
| UIComponent | |
|
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
Dispatches an event into the event flow.
| UIComponent | |
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
Ends all currently playing effects on the component.
| UIComponent | |
|
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
Called after printing is complete.
| UIComponent | |
|
Provides the automation object at the specified index.
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object.
| DisplayObject | |
|
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance.
| DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus.
| UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes.
| DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated.
| UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
Converts a Point object from global to content coordinates.
| UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates.
| DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Evaluates the display object to see if it overlaps or intersects with the
obj display object.
| DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters.
| DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient.
| UIComponent | |
|
Initializes the internal structure of this component.
| UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update.
| UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Converts a Point object from local to content coordinates.
| UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates.
| DisplayObject | |
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Moves the component to a specified position within its parent.
| UIComponent | |
|
Propagates style changes to the children.
| UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent.
| UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well.
| UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer.
| DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Replays the specified event.
| UIComponent | |
|
Resolves a child by using the id provided.
| UIComponent | |
|
[static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing().
| UIComponent | |
|
Sizes the object.
| UIComponent | |
|
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
Set the current state.
| UIComponent | |
|
Sets the focus to this component.
| UIComponent | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Sets a style property on this component instance.
| UIComponent | |
|
Called when the visible property changes.
| UIComponent | |
|
Lets the user drag the specified sprite.
| Sprite | |
|
Ends the startDrag() method.
| Sprite | |
|
Detects changes to style properties.
| UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized.
| UIComponent | |
|
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called.
| UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
|
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method.
| UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements.
| UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component.
| UIComponent | |
|
Returns the primitive value of the specified object.
| Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient.
| UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle.
| UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | |
|
Performs any final processing after child objects are created.
| UIComponent | |
|
Processes the properties set on the component.
| UIComponent | |
|
Create child objects of the component.
| UIComponent | |
|
Creates a new object using a context
based on the embedded font being used.
| UIComponent | |
|
Creates the object using a given moduleFactory.
| UIComponent | |
|
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
Returns the sort information for this column from the AdvancedDataGrid control
so that the control can display the column's number in the sort sequence,
and whether the sort is ascending or descending.
| AdvancedDataGridSortItemRenderer | ||
|
Gets font styles from the AdvancedDataGrid control
and uses them to initialize the corresponding font styles for this render.
| AdvancedDataGridSortItemRenderer | ||
|
Finalizes the initialization of this component.
| UIComponent | |
|
Initializes this component's accessibility code.
| UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
The event handler called for a keyDown event.
| UIComponent | |
|
The event handler called for a keyUp event.
| UIComponent | |
|
Calculates the default size, and optionally the default minimum size,
of the component.
| UIComponent | |
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way.
| UIComponent | |
|
Draws the object and/or sizes and positions its children.
| UIComponent | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Gap between the label and icon, in pixels. The default value is 2. | AdvancedDataGridSortItemRenderer | ||
|
icon
| Type: Class CSS Inheritance: no The class to use as the skin for the arrow that indicates the column sort direction. The default value is mx.skins.halo.DataGridSortArrow. | AdvancedDataGridSortItemRenderer | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
|
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the column header's bottom border and the bottom of the sort item renderer. The default value is 3. | AdvancedDataGridSortItemRenderer | ||
|
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. The default value is 2. | AdvancedDataGridSortItemRenderer | ||
|
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. The default value is 0. | AdvancedDataGridSortItemRenderer | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the column header's top border and the top of the sort item renderer. The default value is 3. | AdvancedDataGridSortItemRenderer | ||
|
proposedColor
| Type: uint Format: Color CSS Inheritance: yes Color of text when the sort is a proposed sort. The default value is 0x999999. | AdvancedDataGridSortItemRenderer | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| grid | property |
Hide Inherited Public Properties
Show Inherited Public Properties
grid:AdvancedDataGrid [read-only] Returns a reference to the associated AdvancedDataGrid control.
protected function get grid():AdvancedDataGrid
| label | property |
protected var label:IUITextField
The internal UITextField object that renders the label of this Button.
The default value is null.
| AdvancedDataGridSortItemRenderer | () | Constructor |
public function AdvancedDataGridSortItemRenderer()
Constructor
| getFieldSortInfo | () | method |
protected function getFieldSortInfo():SortInfo
Returns the sort information for this column from the AdvancedDataGrid control so that the control can display the column's number in the sort sequence, and whether the sort is ascending or descending. The sorting information is represented by an instance of the SortInfo class, where each column in the AdvancedDataGrid control has an associated SortInfo instance.
ReturnsSortInfo — A SortInfo instance.
|
See also
| getFontStyles | () | method |
protected function getFontStyles():void
Gets font styles from the AdvancedDataGrid control
and uses them to initialize the corresponding font styles for this render.
The font styles accessed in the AdvancedDataGrid control include
sortFontFamily, sortFontSize, sortFontStyle,
and sortFontWeight.