Search This Blog

Showing posts with label SkinPart. Show all posts
Showing posts with label SkinPart. Show all posts

Sunday, 1 September 2013

How to specify the width of the drop down popup in a Flex DropDownList

In a previous post, it has been seen that it is quite easy to make the drop down of the DropDownList auto expand to the size of the contents. But we have also seen that it is a bit flaky, in the sense, the width of the popup jumps around when it encounters content that is longer than any it has been displaying previously. This is because the drop down uses the DataGroup which creates itemRenderers judicially on a "as needed" basis. In some cases, it might be better if the popup opens up to a fixed width to give a consistent UI performance. Again, the standard DropDownList does not allow for it and we have to make a simple tweak to make this happen.

The DropDownList which essentially extends from SkinnableDataContainer, defines a optional SkinPart - dropDown which defines the drop down list area  to be displayed when the list is open. If you have a look at the DropDownListSkin, we can see that this SkinPart is very much present and is actually the wrapper for our drop down contents. So all we need to do is to give it a fixed width and our work is done.

This can be achieved easily by extending the current DropDownList and using a property which can be used to specify the width of the drop down. The simple solution would look something like below:

package com.codedebugged.dropdown.fixedwidth
{
    import spark.components.DropDownList;
    import spark.components.PopUpAnchor;

    public class AutoExpandOrFixedWidthDropDownList extends DropDownList
    {

        [SkinPart]
        public var popUp : PopUpAnchor;

        private var _dropDownWidth : Number = NaN;

        private var dropDownWidthChanged : Boolean;

        [Bindable]
        public function get dropDownWidth() : Number
        {
            return _dropDownWidth;
        }

        public function set dropDownWidth( value : Number ) : void
        {
            if (_dropDownWidth != value)
            {
                _dropDownWidth = value;
                dropDownWidthChanged = true;
                invalidateProperties();
            }
        }

        override protected function commitProperties() : void
        {
            super.commitProperties();

            if (dropDownWidthChanged)
            {
                dropDownWidthChanged = false;
                setDropDownWidth();
            }
        }

        override protected function partAdded( partName : String, instance : Object ) : void
        {
            super.partAdded( partName, instance );

            if (instance == popUp)
            {
                popUp.popUpWidthMatchesAnchorWidth = false;
            }
            else if (instance == dropDown)
            {
                setDropDownWidth();
            }
        }

        private function setDropDownWidth() : void
        {
            if (dropDown && !isNaN( dropDownWidth ))
            {
                dropDown.width = dropDownWidth;
            }
        }
    }

}


The component provides a simple property - dropDownWidth which can be set by the user and it sets the width of the drop down to it. If this property is not set, the list behaves like an auto expanding one as seen in the previous post. A sample application to show the working of the list can be seen below.



Sometimes, it might be difficult to guess the exact width of the drop down but you would still want it open up to a fixed width encompassing even your largest element in the dataprovider. This is where you can use the typicalItem property of the DropDownList. The List based controls use this property to guess their initial width. If you don't specify it, it takes the first item of the dataProvider. You can use it to your benefit by iterating through the dataProvider and finding your largest content. Specify this item as the typicalItem and it would calculate its size depending on it. I will try to post an example of it later.

The same patch should be applicable for a ComboBox as well.

Still, I think the list can be bettered. As you would have noticed, the drop down always opens up aligned to left edge. There could be a need to open the drop down aligned to the right edge or open it up so that is centered to the open button of the DropDownList. I will take this up in another post.

Download the source code

Saturday, 31 August 2013

Auto Expand the width of drop down popup of Flex Spark DropDownList / ComboBox

I am pretty sure many people would have run into this kind of requirement many times. The problem is that when using the Spark controls like the DropDownList, the actual drop down that displays the list of options is defaulted to the width of the DropDownList component. If the length of options are greater than the width of the component, then a horizontal scroll bar appears automatically. Now, horizontal scroll bars are a bit of pain and never look good on a GUI. However, there is a very easy way in which the DropDownList can be made to auto expand to the length of the options it displays.

The key lies in the skin of the DropDownList - DropDownListSkin which uses a PopUpAnchor to control the opening and closing of the drop down options. Here in lies the problem. By default, it sets the popUpWidthMatchesAnchorWidth=true on the PopUpAnchor. To make the DropDownList auto expanding, all that needs to be done is to create a new skin which would be an exact copy of the DropDownListSkin and just set the popUpWidthMatchesAnchorWidth=false as shown below:

    <s:PopUpAnchor id="popUp"  displayPopUp.normal="false" displayPopUp.open="true" includeIn="open"
        left="0" right="0" top="0" bottom="0" itemDestructionPolicy="auto"
        popUpPosition="below" popUpWidthMatchesAnchorWidth="false">


As easy as that! Another way of doing it would be through ActionScipt. For this, you need to create a new component extending from the DropDownList and set the popUpWidthMatchesAnchorWidth false in the new component. The source is shown below:

package com.codedebugged.dropdown.autoexpand
{
    import spark.components.DropDownList;
    import spark.components.PopUpAnchor;

    public class AutoExpandDropDownList extends DropDownList
    {

        [SkinPart]
        public var popUp : PopUpAnchor;

        override protected function partAdded( partName : String, instance : Object ) : void
        {
            super.partAdded( partName, instance );

            if (instance == popUp)
            {
                popUp.popUpWidthMatchesAnchorWidth = false;
            }
        }
    }
}



A sample application to show the difference between the normal DropDownList and the auto expanding one :



Notice that the drop down of the list on the right automatically grows. However, the auto expansion is a bit flaky as it jumps around in size when it encounters a lengthier data in the dataprovider. A better way would be to possibly give the drop down a fixed width which I will try to look into in another post. Since the ComboBox and the DropDownList basically work on the same principle, the same trick can be applied to get a auto expanding ComboBox as well.

Download the source

Saturday, 24 August 2013

Flex Popup as a UIComponent

One of the things that I don't like about the Flex Popup's is that despite it being a "view", I can not declare it within mxml. I have to create a separate class for the popup component and then use the PopUpManager API to display it and remove it. Wouldn't be so nice if I could just declare the component to opened up, within my mxml  and I could easily pass/get data from the component using bindings etc.

It is especially useful when creating Skinnable components as I can declare some component as a SkinPart and in the skin declare it to be opened up in a popup.

As I was looking to do something like that, I came across another Flex component - PopUpAnchor.
This is a very useful component which can be used to position a popup control. What this control doesn't do, is to open the popup in modal and centered manner. So I decided to create my own PopUpUIComponent component by stripping this PopUpAnchor of all the positioning code and use it only to open centered/ modal popups.

I quickly hatched a sample application which allows user to input text and then the text is passed onto the popup using bindings. The application can be seen below.


The PopUpUIComponent looks like this:


package
{
    import flash.display.DisplayObject;
    import flash.events.Event;
    import mx.core.FlexGlobals;
    import mx.core.IFlexDisplayObject;
    import mx.core.IUIComponent;
    import mx.core.UIComponent;
    import mx.managers.PopUpManager;
    import mx.styles.ISimpleStyleClient;

    [DefaultProperty( "popUp" )]
    public class PopUpUIComponent extends UIComponent
    {

        public function PopUpUIComponent()
        {
            addEventListener( Event.ADDED_TO_STAGE, addedToStageHandler );
            addEventListener( Event.REMOVED_FROM_STAGE, removedFromStageHandler );
        }

        [Bindable]
        public var isCentered : Boolean = true;

        [Bindable]
        public var isModal : Boolean = true;

        [Bindable]
        public var parentOfPopup : DisplayObject = FlexGlobals.topLevelApplication as DisplayObject;

        private var _displayPopUp : Boolean = false;

        private var _popUp : IFlexDisplayObject;

        public function get displayPopUp() : Boolean
        {
            return _displayPopUp;
        }

        /**
         *  If <code>true</code>, adds the <code>popUp</code> control to the PopUpManager.
         *  If <code>false</code>, it removes the control.
         *
         *  @default false
         */
        public function set displayPopUp( value : Boolean ) : void
        {
            if (_displayPopUp == value)
            {
                return;
            }

            _displayPopUp = value;
            addOrRemovePopUp();
        }

        public function get popUp() : IFlexDisplayObject
        {
            return _popUp
        }

        [Bindable( "popUpChanged" )]

        /**
         *  The IFlexDisplayObject to add to the PopUpManager when the PopupUIComponent is opened.
         *  If the <code>popUp</code> control implements IFocusManagerContainer, the
         *  <code>popUp</code> control will have its
         *  own FocusManager. If the user uses the Tab key to navigate between
         *  controls, only the controls in the <code>popUp</code> control are accessed.
         */
        public function set popUp( value : IFlexDisplayObject ) : void
        {
            if (_popUp == value)
            {
                return;
            }

            _popUp = value;

            if (_popUp is ISimpleStyleClient)
            {
                ISimpleStyleClient( _popUp ).styleName = this;
            }

            dispatchEvent( new Event( "popUpChanged" ));
        }

        private function addOrRemovePopUp() : void
        {
            if (popUp == null)
            {
                return;
            }

            if (DisplayObject( popUp ).parent == null && displayPopUp)
            {
                PopUpManager.addPopUp( popUp, parentOfPopup, isModal );
                if (isCentered)
                {
                    PopUpManager.centerPopUp( popUp );
                }
                if (popUp is IUIComponent)
                {
                    IUIComponent( popUp ).owner = this;
                }
            }
            else if (DisplayObject( popUp ).parent != null && displayPopUp == false)
            {
                removeAndResetPopUp();
            }
        }

        private function addedToStageHandler( event : Event ) : void
        {
            addOrRemovePopUp();
        }

        private function removeAndResetPopUp() : void
        {
            PopUpManager.removePopUp( popUp );
        }

        private function removedFromStageHandler( event : Event ) : void
        {
            if (popUp != null && DisplayObject( popUp ).parent != null)
            {
                removeAndResetPopUp();
            }
        }
    }

}

The opening and the closing of the popup is controlled by displayPopup var (same as in PopUpAnchor).

It is not the most perfect component but it does make things easier for me to use popups in mxml skins.Of course, there are some good alternatives out there if you are using frameworks like Cairngorm which has a nice popup library.

Hope it helps!

Download the source code