Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

# GUI.GUIMultiColumnListBox

00001 00002 00003 00004 00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146
00147
00148
00149
00150
00151
00152
00153
00154
00155
00156
00157
00158
00159
00160
00161
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171
00172
00173
00174
00175
00176
00177
00178
00179
00180
00181
00182
00183
00184
00185
00186
00187
00188
00189
00190
00191
00192
00193
00194
00195
00196
00197
00198
00199
00200
00201
00202
00203
00204
00205
00206
00207
00208
00209
00210
00211
00212
00213
00214
00215
00216
00217
00218
00219
00220
00221
00222
00223
00224
00225
00226
00227
00228
00229
00230
00231
00232
00233
00234
00235
00236
00237
00238
00239
00240
00241
00242
00243
00244
00245
00246
00247
00248
00249
00250
00251
00252
00253
00254
00255
00256
00257
00258
00259
00260
00261
00262
00263
00264
00265
00266
00267
00268
00269
00270
00271
00272
00273
00274
00275
00276
00277
00278
00279
00280
00281
00282
00283
00284
00285
00286
00287
00288
00289
00290
00291
00292
00293
00294
00295
00296
00297
00298
00299
00300
00301
00302
00303
00304
00305
00306
00307
00308
00309
00310
00311
00312
00313
00314
00315
00316
00317

    /*=============================================================================
    	In Game GUI Editor System V1.0
    	2003 - Irrational Games, LLC.
    	* Dan Kaplan
    =============================================================================*/
    #if !IG_GUI_LAYOUT
    #error This code requires IG_GUI_LAYOUT to be defined due to extensive revisions of the origional code. [DKaplan]
    #endif
    /*===========================================================================*/

    class GUIMultiColumnListBox extends GUIListBoxBase
        HideCategories(Menu,Object)
    	native;

    cpptext
    {
    void PreDraw(UCanvas* Canvas);
    void UpdateComponent(UCanvas* Canvas);
    int MouseOverColumnBorder();
    UGUIComponent* UnderCursor(FLOAT MouseX, FLOAT MouseY);
    UBOOL MousePressed(UBOOL IsRepeat);
    UBOOL MouseReleased();
    }

    var(MultiColumnListBox)   Editinline EditConst array<GUIMultiColumnList>	MultiColumnList "The Array of lists of data";
    var(MultiColumnListBox)   config  array<String>   ListNames  "Name of the lists to polulate this MCLB";
    var(MultiColumnListBox)   config    int             ActiveIndex "Index of the active column";
    var(MultiColumnListBox)   editconst int             ActiveRowIndex "Index of the active row";
    var(MultiColumnListBox)   Editinline EditConst private  GUIButton ActiveButton;
    var(MultiColumnListBox)   Editinline EditConst private  array<GUIListElem> ActiveRow;
    #if IG_TRIBES3 // dbeswick: for key binding
    var(MultiColumnListBox)   config    int			LastClickedIndex;
    #endif
    var(MultiColumnListBox) config bool bResizable "If true, MultiColumnList box columns are resizable.";
    var(MultiColumnListBox) config float DragSpacing "Number of pixels of leeway allowed for column resizing";
    var(DEBUG) editconst int ColumnBorder;

    #if IG_TRIBES3 // Ryan: made sorting native
    final native function ReorderItems(int indices);
    #endif

    function OnConstruct(GUIController MyController)
    {
        local int i;

        Super.OnConstruct(MyController);

        for( i = 0; i < ListNames.Length; i++ )
        {
            AddComponent( "GUI.GUIMultiColumnList", self.Name$"_"$ListNames[i]);
        }
    }

    //initializes the MultiColumnListBox
    function InitComponent(GUIComponent MyOwner)
    {
        local int i;
    	Super.InitComponent(MyOwner);

        for( i = 0; i < ListNames.Length; i++ )
        {
            InitColumn( ListNames[i] );
        }

        ClearRow();
    }

    //initializes the given column
    private function InitColumn( string ListName )
    {
        local GUIMultiColumnList newList;
        newList=FindColumn( ListName, true );
        if( newList == None )
            newList = GUIMultiColumnList(AddComponent( "GUI.GUIMultiColumnList" ,self.Name$"_"$ListName, true));
        Assert( newList != None );

        newList.IndexID=MultiColumnList.Length;
        InitBaseList( newList.MCList );
        newList.MCList.OnChange=InternalOnChange;
        newList.MCList.OnAdjustTop=InternalOnAdjustTop;
        newList.MCList.SwapIndices=SwapMCLBIndices;
    #if IG_TRIBES3 // Ryan: made sorting native
    	newList.MCList.ReorderByIndices=ReorderItems;
    #endif
        newList.MCButton.OnClick=InternalOnClick;

        MultiColumnList[MultiColumnList.Length]=newList;

        if( ActiveIndex == newList.IndexID )
        {
            ActiveButton = newList.MCButton;
            SetActiveList( newList.MCList );
        }
    }

    //Sets the active column in the MultiColumnListBox
    function SetActiveColumn( string theName, optional bool bExact )
    {
        local GUIMultiColumnList column;
        column = FindColumn( theName, bExact );
        if( column == None )
            return;
        ActiveIndex = column.IndexID;
        ActiveButton = column.MCButton;
        SetActiveList( column.MCList );
    }

    //Get the column's list specified by the given header
    function GUIList GetColumn( string Header )
    {
        local GUIMultiColumnList GMCList;

        GMCList = FindColumn( Header );

        AssertWithDescription( GMCList != None, "Specified column \""$Header$"\" not found in "$self.name );

        return GMCList.MCList;
    }

    //modeled after FindComponent in GUIMultiComponent
    #if IG_TRIBES3	// rowan: need this public for tribes pages
    function GUIMultiColumnList FindColumn( string theName, optional bool bExact )
    #else
    private function GUIMultiColumnList FindColumn( string theName, optional bool bExact )
    #endif
    {
        local int i;

        for( i = 0; i < MultiColumnList.Length; i++ )
        {
            if( ( theName ~= string(MultiColumnList[i].Name) ) || ( !bExact && InStr(Caps(MultiColumnList[i].Name), Caps(theName)) >= 0 ) )
                return( MultiColumnList[i] );
        }
        return None;
    }

    //clears the entire MultiColumnListBox
    function Clear()
    {
        local int i;

        for( i = 0; i < MultiColumnList.Length; i++ )
        {
            MultiColumnList[i].MCList.Clear();
        }
    }

    //Handles clicking on a field in this MCLB
    private function InternalOnClick(GUIComponent Sender)
    {
        ActiveButton = GUIButton(Sender);
        ActiveIndex = GUIMultiColumnList(ActiveButton.MenuOwner).IndexID;
        if( MultiColumnList[ActiveIndex].bIgnoreHeader )
        {
            Click();
            return;
        }
        SetActiveList( MultiColumnList[ActiveIndex].MCList );

        if( GUIList(MyActiveList).bListIsDirty )
            GUIList(MyActiveList).Sort();
        else
            GUIList(MyActiveList).ReverseList();
        MyScrollBar.AlignThumb();
    	Click();
    }

    //Handles changes to this MCLB
    private function InternalOnChange(GUIComponent Sender)
    {
        local int i, curTop;

        SetActiveList( GUIListBase(Sender) );
        ActiveRowIndex = MyActiveList.Index;
        curTop = MyActiveList.Top;
        for( i = 0; i < MultiColumnList.Length; i++ )
        {
    #if IG_TRIBES3 // dbeswick: for key binding
    		if (MultiColumnList[i].MCList == Sender)
    		{
    			LastClickedIndex = i;
    		}
    #endif
            MultiColumnList[i].MCList.SetIndex( ActiveRowIndex, true );
            MultiColumnList[i].MCList.Top=curTop;
        }
        SetDirty();
    	OnChange(Self);
    }

    //Handles scrolling in the MCLB
    private function InternalOnAdjustTop(GUIComponent Sender)
    {
        local int i, curTop;

        SetActiveList( GUIListBase(Sender) );
        curTop = MyActiveList.Top;
        for( i = 0; i < MultiColumnList.Length; i++ )
        {
            MultiColumnList[i].MCList.Top=curTop;
        }
    }

    //////////////////////////////////////////////////////////////////////
    // Row Management
    //////////////////////////////////////////////////////////////////////
    function AddNewRowElement( string ColumnHeader, optional Object obj, optional string Str, optional int intData, optional bool bData )
    {
        AddRowElement( CreateElement( ColumnHeader, obj, Str, intData, bData ) );
    }

    function AddRowElement( GUIListElem theElem )
    {
        local int i;

        for( i = 0; i < MultiColumnList.Length; i++ )
        {
            if( Controller.FixGUIComponentName(self.Name$"_"$theElem.Item) ~= String(MultiColumnList[i].Name) )
                ActiveRow[i]=theElem;
            else if( i == ActiveRow.Length )
                ActiveRow.Insert( i, 1 );
        }
    }

    //Clears the row's active data
    function ClearRow()
    {
        ActiveRow.Remove(0,ActiveRow.Length);
    }

    //returns the index the row was inserted at
    function int PopulateRow( optional string DontReplaceHeader )
    {
        local int i, rowIndex;
        local GUIMultiColumnList column;

        if( DontReplaceHeader != "" )
        {
            column = FindColumn( DontReplaceHeader );
            if( column != None )
            {
                i = column.MCList.FindElement( ActiveRow[column.IndexID] );
                if( i >= 0 )
                    return i;
            }
        }

        // add w/ insertion sort
        rowIndex = MultiColumnList[ActiveIndex].MCList.AddElement( ActiveRow[ActiveIndex], false, true );
        if( rowIndex < 0 )
            return rowIndex;
        for( i = 0; i < MultiColumnList.Length; i++ )
        {
            if( i == ActiveIndex )
                continue;
            MultiColumnList[i].MCList.InsertElement( rowIndex, ActiveRow[i], false, true );
        }
        ClearRow();
        SetDirty();
        return rowIndex;
    }

    //////////////////////////////////////////////////////////////////////
    // Sorting (bubble sort)
    //////////////////////////////////////////////////////////////////////
    private function SwapMCLBIndices( int indexA, int indexB )
    {
        local int j;

        for( j = 0; j < MultiColumnList.Length; j++ )
        {
            MultiColumnList[j].MCList.Swap( indexA, indexB, j == ActiveIndex );
        }
    }

    //Sorts over the given column (or active column if none specified) maintaining row cohesion
    function Sort(optional string byColumn)
    {
        local int oldColumnIndex;

    	if (byColumn != "")
    	{
    		//save old active column
    		oldColumnIndex = ActiveIndex;
    		//set the column to sort by
    		SetActiveColumn( byColumn );
    	}
    	// MJ:  Removed this because it broke clicking to sort on different columns
    	//else
    	//	SetActiveColumn(String(MultiColumnList[ActiveIndex].Name));

        //sort based on current column
        GUIList(MyActiveList).Sort();

    	if (byColumn != "")
    	{
    		//restore old column
    		SetActiveColumn( string(MultiColumnList[oldColumnIndex].Name), true );
    	}
    }

    //Set the index of the currently active column (the row index)
    function int SetIndex( int ind )
    {
        SetDirty();
        return GUIList(MyActiveList).SetIndex( ind );
    }

    defaultproperties
    {
    	bVisibleWhenEmpty=True
        ActiveRowIndex=-1
    	bResizable=True
    	DragSpacing=5
    }

Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

Class file time: ne 5.9.2004 16:02:10.000 - Creation time: st 23.5.2018 00:10:43.853 - Created with UnCodeX