2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
22 #include <dali/public-api/animation/animation.h>
23 #include <dali/public-api/animation/constraint.h>
24 #include <dali/public-api/animation/time-period.h>
27 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
28 #include <dali-toolkit/devel-api/controls/scrollable/item-view/default-item-layout-property.h>
36 struct ItemLayout::Impl
38 Vector3 mItemSize; ///< The size of an item in the layout
39 ControlOrientation::Type mOrientation; ///< the orientation of the layout.
40 Property::Map mProperties;
41 bool mHasLayoutChanged;
44 ItemLayout::ItemLayout()
47 mImpl->mOrientation = ControlOrientation::Up;
50 ItemLayout::~ItemLayout()
55 void ItemLayout::SetOrientation(ControlOrientation::Type orientation)
57 mImpl->mOrientation = orientation;
60 ControlOrientation::Type ItemLayout::GetOrientation() const
62 return mImpl->mOrientation;
65 void ItemLayout::GetItemSize( unsigned int itemId, const Vector3& layoutSize, Vector3& itemSize ) const
67 // If item-size has not been set then get the default size
68 if ( mImpl->mItemSize == Vector3::ZERO )
70 GetDefaultItemSize( itemId, layoutSize, itemSize );
74 itemSize = mImpl->mItemSize;
78 void ItemLayout::SetItemSize( const Vector3& itemSize )
80 mImpl->mItemSize = itemSize;
83 float ItemLayout::GetClosestOnScreenLayoutPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize)
85 Vector3 itemPosition = GetItemPosition( itemID, currentLayoutPosition, layoutSize );
87 GetItemSize(itemID, layoutSize, itemSize);
88 Vector3 onScreenArea = (layoutSize - itemSize) * 0.5f;
89 if (itemPosition.x < -onScreenArea.x
90 || itemPosition.x > onScreenArea.x
91 || itemPosition.y < -onScreenArea.y
92 || itemPosition.y > onScreenArea.y)
94 // item not within viewable area
95 // safest thing to do here since we have no idea how the implementation will work is to return the scroll to position
96 return GetItemScrollToPosition(itemID);
98 return currentLayoutPosition;
101 int ItemLayout::GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
105 case Control::KeyboardFocus::LEFT:
106 case Control::KeyboardFocus::UP:
111 itemID = loopEnabled ? maxItems - 1 : 0;
115 case Control::KeyboardFocus::RIGHT:
116 case Control::KeyboardFocus::DOWN:
119 if( itemID >= maxItems )
121 itemID = loopEnabled ? 0 : maxItems - 1;
133 float ItemLayout::GetFlickSpeedFactor() const
135 // By default, the speed factor while dragging and swiping is the same.
136 return GetScrollSpeedFactor();
139 void ItemLayout::SetLayoutProperties(const Property::Map& properties)
141 for( unsigned int idx = 0, mapCount = properties.Count(); idx < mapCount; ++idx )
143 KeyValuePair propertyPair( properties.GetKeyValue( idx ) );
145 if(propertyPair.first == DefaultItemLayoutProperty::ITEM_SIZE)
147 SetItemSize(propertyPair.second.Get<Vector3>());
149 else if(propertyPair.first == DefaultItemLayoutProperty::ORIENTATION)
151 //Up, Left, Down, Right
152 int orientationType = propertyPair.second.Get<int>();
153 if(orientationType <= ControlOrientation::Right && orientationType >= ControlOrientation::Up)
155 SetOrientation(ControlOrientation::Type(orientationType));
159 mImpl->mHasLayoutChanged = true;
160 mImpl->mProperties = properties;
163 Property::Map ItemLayout::GetLayoutProperties()
165 return mImpl->mProperties;
168 bool ItemLayout::HasLayoutChanged()
170 return mImpl->mHasLayoutChanged;
173 void ItemLayout::ResetLayoutChangedFlag()
175 mImpl->mHasLayoutChanged = false;
178 } // namespace Toolkit