TreeTableViewWithSwift是用Swift編寫的樹形結構顯示的TableView控件莫秆。
TreeTableViewWithSwift的由來
在開發(fā)企業(yè)通訊錄的時候需要層級展示。之前開發(fā)Android的時候有做過類似的功能茅茂,也是通過一些開源的內容進行改造利用矿微。此次,在做ios的同類產品時,調研發(fā)現(xiàn)樹形結構的控件并不是很多坝疼,雖然也有但大多看起來都比較負責,而且都是用OC編寫的谆沃。介于我的項目是Swift開發(fā)的钝凶,并且TreeTableView貌似沒有人用Swift編寫過(也可能是我沒找到)。所以打算自己動手寫一個管毙,從而豐衣足食腿椎。
TreeTableViewWithSwift簡介
開發(fā)環(huán)境:Swift 2.0,XCode版本:7.0.1夭咬,ios 9.0升級到 swift 3.0啃炸, Xcode 8.2.1
代碼:GitHub代碼
1、運行效果
2卓舵、關鍵代碼的解讀
TreeTableViewWithSwift其實是對tableview的擴展南用。在此之前需要先創(chuàng)建一個TreeNode類用于存儲我們的數(shù)據(jù)
publicclassTreeNode {
staticletNODE_TYPE_G: Int =0//表示該節(jié)點不是葉子節(jié)點
staticletNODE_TYPE_N: Int =1//表示節(jié)點為葉子節(jié)點
vartype: Int?
vardesc: String?//對于多種類型的內容,需要確定其內容
varid: String?
varpId: String?
varname: String?
varlevel: Int?
varisExpand: Bool = false
varicon: String?
varchildren: [TreeNode] = []
varparent: TreeNode?
init(desc: String?, id:String? , pId: String? , name: String?) {
self.desc= desc
self.id= id
self.pId= pId
self.name= name
}
//是否為根節(jié)點
funcisRoot() -> Bool{
returnparent == nil
}
//判斷父節(jié)點是否打開
funcisParentExpand() -> Bool {
ifparent == nil {
returnfalse
}
return(parent?.isExpand)!
}
//是否是葉子節(jié)點
funcisLeaf() -> Bool {
returnchildren.count==0
}
//獲取level,用于設置節(jié)點內容偏左的距離
funcgetLevel() -> Int {
returnparent == nil ?0: (parent?.getLevel())!+1
}
//設置展開
funcsetExpand(isExpand: Bool) {
self.isExpand= isExpand
if!isExpand {
for(vari=0;i
children[i].setExpand(isExpand)
}
}
}
}
這里需要講解一下,id和pId分別對于當前Node的ID標示和其父節(jié)點ID標示裹虫。節(jié)點直接建立關系它們是很關鍵的屬性肿嘲。children是一個TreeNode的數(shù)組筑公,用來存放當前節(jié)點的直接子節(jié)點。通過children和parent兩個屬性匣屡,就可以很快的找到當前節(jié)點的關系節(jié)點封救。
為了能夠操作我們的TreeNode數(shù)據(jù),我還創(chuàng)建了一個TreeNodeHelper類捣作。
classTreeNodeHelper {
//單例模式
classvarsharedInstance: TreeNodeHelper {
structStatic {
staticvarinstance: TreeNodeHelper?
staticvartoken: dispatch_once_t =0
}
dispatch_once(&Static.token) {//該函數(shù)意味著代碼僅會被運行一次誉结,而且此運行是線程同步
Static.instance= TreeNodeHelper()
}
returnStatic.instance!
}
TreeNodeHelper是一個單例模式的工具類。通過TreeNodeHelper.sharedInstance就能獲取類實例
//傳入普通節(jié)點券躁,轉換成排序后的Node
funcgetSortedNodes(groups: NSMutableArray, defaultExpandLevel: Int) -> [TreeNode] {
varresult: [TreeNode] = []
varnodes = convetData2Node(groups)
varrootNodes = getRootNodes(nodes)
foriteminrootNodes{
addNode(&result, node: item, defaultExpandLeval: defaultExpandLevel, currentLevel:1)
}
returnresult
}
getSortedNodes是TreeNode的入口方法惩坑。調用該方法的時候需要傳入一個Array類型的數(shù)據(jù)集。這個數(shù)據(jù)集可以是任何你想用來構建樹形結構的內容也拜。在這里我雖然只傳入了一個groups參數(shù)以舒,但其實可以根據(jù)需要重構這個方法,傳入多個類似groups的參數(shù)搪泳。例如稀轨,當我們需要做企業(yè)通訊錄的時候,企業(yè)通訊錄的數(shù)據(jù)中存在部門集合和用戶集合岸军。部門之間有層級關系奋刽,用戶又屬于某個部門。我們可以將部門和用戶都轉換成TreeNode元數(shù)據(jù)艰赞。這樣修改方法可以修改為:
func getSortedNodes(groups: NSMutableArray, users: NSMutableArray, defaultExpandLevel: Int) -> [TreeNode]
是不是感覺很有意思呢佣谐?
//過濾出所有可見節(jié)點
funcfilterVisibleNode(nodes: [TreeNode]) -> [TreeNode] {
varresult: [TreeNode] = []
foriteminnodes {
ifitem.isRoot() || item.isParentExpand() {
setNodeIcon(item)
result.append(item)
}
}
returnresult
}
//將數(shù)據(jù)轉換成書節(jié)點
funcconvetData2Node(groups: NSMutableArray) -> [TreeNode] {
varnodes: [TreeNode] = []
varnode: TreeNode
vardesc: String?
varid: String?
varpId: String?
varlabel: String?
vartype: Int?
foritemingroups {
desc = item["description"]as? String
id = item["id"]as? String
pId = item["pid"]as? String
label = item["name"]as? String
node = TreeNode(desc: desc, id: id, pId: pId, name: label)
nodes.append(node)
}
/**
*設置Node間,父子關系;讓每兩個節(jié)點都比較一次方妖,即可設置其中的關系
*/
varn: TreeNode
varm: TreeNode
for(vari=0; i
n = nodes[i]
for(varj=i+1; j
m = nodes[j]
ifm.pId== n.id{
n.children.append(m)
m.parent= n
}elseifn.pId== m.id{
m.children.append(n)
n.parent= m
}
}
}
foriteminnodes {
setNodeIcon(item)
}
returnnodes
}
convetData2Node方法將數(shù)據(jù)轉換成TreeNode狭魂,同時也構建了TreeNode之間的關系。
//獲取根節(jié)點集
funcgetRootNodes(nodes: [TreeNode]) -> [TreeNode] {
varroot: [TreeNode] = []
foriteminnodes {
ifitem.isRoot() {
root.append(item)
}
}
returnroot
}
//把一個節(jié)點的所有子節(jié)點都掛上去
funcaddNode(inoutnodes: [TreeNode], node: TreeNode, defaultExpandLeval: Int, currentLevel: Int) {
nodes.append(node)
ifdefaultExpandLeval >= currentLevel {
node.setExpand(true)
}
ifnode.isLeaf() {
return
}
for(vari=0; i
addNode(&nodes, node: node.children[i], defaultExpandLeval: defaultExpandLeval, currentLevel: currentLevel+1)
}
}
//設置節(jié)點圖標
funcsetNodeIcon(node: TreeNode) {
ifnode.children.count>0{
node.type= TreeNode.NODE_TYPE_G
ifnode.isExpand{
//設置icon為向下的箭頭
node.icon="tree_ex.png"
}elseif!node.isExpand{
//設置icon為向右的箭頭
node.icon="tree_ec.png"
}
}else{
node.type= TreeNode.NODE_TYPE_N
}
}
}
剩下的代碼難度不大党觅,很容易理解雌澄。需要多說一句的TreeNode.NODE\_TYPE\_G和TreeNode.NODE\_TYPE\_N是用來告訴TreeNode當前的節(jié)點的類型。正如上面提到的企業(yè)通訊錄杯瞻,這個兩個type就可以用來區(qū)分node數(shù)據(jù)镐牺。
TreeTableView我的重頭戲來了。它繼承了UITableView魁莉,UITableViewDataSource睬涧,UITableViewDelegate募胃。
functableView(tableView: UITableView, cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {
//通過nib自定義tableviewcell
letnib = UINib(nibName:"TreeNodeTableViewCell", bundle: nil)
tableView.registerNib(nib, forCellReuseIdentifier: NODE_CELL_ID)
varcell = tableView.dequeueReusableCellWithIdentifier(NODE_CELL_ID)as! TreeNodeTableViewCell
varnode: TreeNode = mNodes![indexPath.row]
//cell縮進
cell.background.bounds.origin.x = -20.0* CGFloat(node.getLevel())
//代碼修改nodeIMG---UIImageView的顯示模式.
ifnode.type== TreeNode.NODE_TYPE_G{
cell.nodeIMG.contentMode= UIViewContentMode.Center
cell.nodeIMG.image= UIImage(named: node.icon!)
}else{
cell.nodeIMG.image= nil
}
cell.nodeName.text= node.name
cell.nodeDesc.text= node.desc
returncell
}
tableView:cellForRowAtIndexPath方法中,我們使用了UINib,因為我通過自定義TableViewCell,來填充tableview畦浓。這里也使用了cell的復用機制痹束。
下面我們來看控制樹形結構展開的關鍵代碼
func tableView(tableView: UITableView, didSelectRowAtIndexPath indexPath: NSIndexPath) {
var parentNode = mNodes![indexPath.row]
var startPosition = indexPath.row+1
var endPosition = startPosition
if parentNode.isLeaf() {//點擊的節(jié)點為葉子節(jié)點
// do something
} else {
expandOrCollapse(&endPosition, node: parentNode)
mNodes = TreeNodeHelper.sharedInstance.filterVisibleNode(mAllNodes!) //更新可見節(jié)點
//修正indexpath
var indexPathArray :[NSIndexPath] = []
var tempIndexPath: NSIndexPath?
for (var i = startPosition; i < endPosition ; i++) {
tempIndexPath = NSIndexPath(forRow: i, inSection: 0)
indexPathArray.append(tempIndexPath!)
}
//插入和刪除節(jié)點的動畫
if parentNode.isExpand {
self.insertRowsAtIndexPaths(indexPathArray, withRowAnimation: UITableViewRowAnimation.None)
} else {
self.deleteRowsAtIndexPaths(indexPathArray, withRowAnimation: UITableViewRowAnimation.None)
}
//更新被選組節(jié)點
self.reloadRowsAtIndexPaths([indexPath], withRowAnimation: UITableViewRowAnimation.None)
}
}
//展開或者關閉某個節(jié)點
func expandOrCollapse(inout count: Int, node: TreeNode) {
if node.isExpand { //如果當前節(jié)點是開著的讶请,需要關閉節(jié)點下的所有子節(jié)點
closedChildNode(&count,node: node)
} else { //如果節(jié)點是關著的,打開當前節(jié)點即可
count += node.children.count
node.setExpand(true)
}
}
//關閉某個節(jié)點和該節(jié)點的所有子節(jié)點
func closedChildNode(inout count:Int, node: TreeNode) {
if node.isLeaf() {
return
}
if node.isExpand {
node.isExpand = false
for item in node.children { //關閉子節(jié)點
count++ //計算子節(jié)點數(shù)加一
closedChildNode(&count, node: item)
}
}
}
我們點擊某一個非葉子節(jié)點的時候抹蚀,將該節(jié)點的子節(jié)點添加到我們的tableView中,并給它們加上動畫钞诡。這就是我們需要的樹形展開視圖湃崩。首先我們要計算出該節(jié)點的子節(jié)點數(shù)(在關閉節(jié)點的時候攒读,還需要計算對應的子節(jié)點的子節(jié)點的展開節(jié)點數(shù)),然后獲取這些子節(jié)點的集合剪返,通過tableview的insertRowsAtIndexPaths和deleteRowsAtIndexPaths方法進行插入節(jié)點和刪除節(jié)點脱盲。
tableview:didSelectRowAtIndexPath還算好理解日缨,關鍵是expandOrCollapse和closedChildNode方法匣距。
expandOrCollapse的作用是打開或者關閉點擊節(jié)點。當操作為打開一個節(jié)點的時候尚卫,只需要設置該節(jié)點為展開焕毫,并且計算其子節(jié)點數(shù)就可以。而關閉一個節(jié)點就相對麻煩邑飒。因為我們要計算子節(jié)點是否是打開的,如果子節(jié)點是打開的县匠,那么子節(jié)點的子節(jié)點的數(shù)也要計算進去撒轮√馍剑可能這里聽起來有點繞口,建議運行程序后看著實例進行理解玖姑。
3慨菱、鳴謝
借鑒的資料有:
*[swift可展開可收縮的表視圖](http://www.reibang.com/p/706dcc4ccb2f)
*[Android打造任意層級樹形控件考驗你的數(shù)據(jù)結構和設計](http://blog.csdn.net/lmj623565791/article/details/40212367)
有興趣的朋友也可以參考以上兩篇blog符喝。
License
All source code is licensed under the MIT License.