2 * Copyright (c) 2018 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.
17 #include <dali/integration-api/debug.h>
19 #include <dali/public-api/animation/animation.h>
20 #include <dali/public-api/object/type-registry-helper.h>
21 #include <dali-toolkit/public-api/controls/control.h>
22 #include <dali-toolkit/devel-api/layouting/layout-item-impl.h>
23 #include <dali-toolkit/devel-api/layouting/layout-group-impl.h>
24 #include <dali-toolkit/internal/layouting/layout-item-data-impl.h>
29 #if defined(DEBUG_ENABLED)
30 Debug::Filter* gLayoutFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_LAYOUT" );
33 const char* WIDTH_SPECIFICATION_NAME( "widthSpecification" );
34 const char* HEIGHT_SPECIFICATION_NAME( "heightSpecification" );
36 const float DEFAULT_TRANSITION_DURATION( 0.5f );
46 LayoutItem::LayoutItem()
47 : mImpl( new LayoutItem::Impl() ),
52 LayoutItem::~LayoutItem()
54 // An object with a unique_ptr to an opaque structure must define it's destructor in the translation unit
55 // where the opaque structure is defined. It cannot use the default method in the header file.
58 LayoutItemPtr LayoutItem::New( Handle& owner )
60 LayoutItemPtr layoutPtr = new LayoutItem();
64 void LayoutItem::Initialize( Handle& owner, const std::string& containerType )
66 mImpl->mOwner = &(owner.GetBaseObject());
67 RegisterChildProperties( containerType );
68 OnInitialize(); // Ensure direct deriving class gets initialized
72 Handle LayoutItem::GetOwner() const
74 return Handle::DownCast(BaseHandle(mImpl->mOwner));
77 void LayoutItem::Unparent()
79 // Enable directly derived types to first remove children
82 // Remove myself from parent
83 LayoutParent* parent = GetParent();
86 parent->Remove( *this );
89 // Remove parent reference
96 void LayoutItem::SetAnimateLayout( bool animateLayout )
98 auto owner = GetOwner();
99 auto actor = Actor::DownCast(owner);
101 DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::SetAnimateLayout animateLayout(%s) owner(%s)\n", (animateLayout)?"true":"false",
102 ( ( Actor::DownCast( owner) ) ? Actor::DownCast(owner).GetName().c_str() : "Invalid Actor" ) );
104 mImpl->mAnimated = animateLayout;
106 OnAnimationStateChanged( animateLayout );
109 bool LayoutItem::IsLayoutAnimated() const
111 return mImpl->mAnimated;
114 void LayoutItem::RegisterChildProperties( const std::string& containerType )
116 // Call on derived types
117 auto typeInfo = TypeRegistry::Get().GetTypeInfo( containerType );
120 Property::IndexContainer indices;
121 typeInfo.GetChildPropertyIndices( indices );
123 if( std::find( indices.Begin(), indices.End(), Toolkit::LayoutItem::ChildProperty::WIDTH_SPECIFICATION ) ==
126 ChildPropertyRegistration( typeInfo.GetName(), WIDTH_SPECIFICATION_NAME,
127 Toolkit::LayoutItem::ChildProperty::WIDTH_SPECIFICATION, Property::INTEGER );
129 ChildPropertyRegistration( typeInfo.GetName(), HEIGHT_SPECIFICATION_NAME,
130 Toolkit::LayoutItem::ChildProperty::HEIGHT_SPECIFICATION, Property::INTEGER );
133 OnRegisterChildProperties( containerType );
137 void LayoutItem::OnRegisterChildProperties( const std::string& containerType )
142 void LayoutItem::Measure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec )
144 DALI_LOG_TRACE_METHOD( gLayoutFilter );
146 const bool forceLayout = mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
148 const bool specChanged =
149 ( widthMeasureSpec != mImpl->mOldWidthMeasureSpec ) ||
150 ( heightMeasureSpec != mImpl->mOldHeightMeasureSpec );
152 const bool isSpecExactly =
153 ( widthMeasureSpec.GetMode() == MeasureSpec::Mode::EXACTLY ) &&
154 ( heightMeasureSpec.GetMode() == MeasureSpec::Mode::EXACTLY );
156 const bool matchesSpecSize =
157 ( GetMeasuredWidth() == widthMeasureSpec.GetSize() ) &&
158 ( GetMeasuredHeight() == heightMeasureSpec.GetSize() );
160 const bool needsLayout = specChanged && ( !isSpecExactly || !matchesSpecSize );
162 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::Measure("<<widthMeasureSpec<<", "<<heightMeasureSpec<<") Owner:"
163 <<Actor::DownCast(GetOwner()).GetName() <<" forceLayout="<<forceLayout
164 <<", specChanged="<<specChanged<<", isSpecExactly="<<isSpecExactly
165 <<", matchesSpecSize="<<matchesSpecSize
166 <<", needsLayout="<<needsLayout <<(forceLayout||needsLayout?" Remeasuring":" NoChange"));
168 if( forceLayout || needsLayout )
170 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET );
172 // measure ourselves, this should set the measured dimension flag back
173 #if defined(DEBUG_ENABLED)
174 std::ostringstream o;
175 o<<widthMeasureSpec<<","<<heightMeasureSpec;
176 DALI_LOG_INFO( gLayoutFilter, Debug::General, "LayoutItem::Measure Calling %s OnMeasure( %s )\n", Actor::DownCast(GetOwner()).GetName().c_str(), o.str().c_str());
178 OnMeasure( widthMeasureSpec, heightMeasureSpec );
179 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT );
181 // flag not set, setMeasuredDimension() was not invoked, we raise an exception to warn the developer
182 DALI_ASSERT_ALWAYS( mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET ) &&
183 "Layout's OnMeasure() Measured dimension flag not set" );
184 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED );
187 mImpl->mOldWidthMeasureSpec = widthMeasureSpec;
188 mImpl->mOldHeightMeasureSpec = heightMeasureSpec;
191 void LayoutItem::Layout( LayoutLength l, LayoutLength t, LayoutLength r, LayoutLength b )
193 DALI_LOG_TRACE_METHOD( gLayoutFilter );
195 if( mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT ) )
197 OnMeasure( mImpl->mOldWidthMeasureSpec, mImpl->mOldHeightMeasureSpec );
198 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_MEASURE_NEEDED_BEFORE_LAYOUT );
201 bool changed = SetFrame( l, t, r, b );
203 if( changed || mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED ) )
205 OnLayout( changed, l, t, r, b );
206 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_LAYOUT_REQUIRED );
209 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
210 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_IS_LAID_OUT );
213 LayoutLength LayoutItem::GetMinimumWidth() const
215 return mImpl->mMinimumSize.GetWidth();
218 LayoutLength LayoutItem::GetMinimumHeight() const
220 return mImpl->mMinimumSize.GetHeight();
223 void LayoutItem::SetMinimumWidth( LayoutLength minimumWidth )
225 mImpl->mMinimumSize.SetWidth( minimumWidth );
229 void LayoutItem::SetMinimumHeight( LayoutLength minimumHeight )
231 mImpl->mMinimumSize.SetHeight( minimumHeight );
235 Extents LayoutItem::GetPadding() const
237 Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
240 Extents padding = control.GetProperty<Extents>( Toolkit::Control::Property::PADDING );
242 DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::Padding for %s : (%d,%d,%d,%d) \n",
243 control.GetName().c_str(),
244 padding.start, padding.end, padding.top, padding.bottom
254 Extents LayoutItem::GetMargin() const
256 Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
259 return control.GetProperty<Extents>( Toolkit::Control::Property::MARGIN );
267 LayoutLength LayoutItem::GetDefaultSize( LayoutLength size, MeasureSpec measureSpec )
269 LayoutLength result = size;
270 auto specMode = measureSpec.GetMode();
271 auto specSize = measureSpec.GetSize();
273 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::GetDefaultSize MeasureSpec("<<measureSpec<< ") size:" << size << "\n" );
277 case MeasureSpec::Mode::UNSPECIFIED:
282 case MeasureSpec::Mode::AT_MOST:
284 // Ensure the default size does not exceed the spec size unless the default size is 0.
285 // Another container could provide a default size of 0.
286 LayoutLength tmp = specSize;
288 // Do not set size to 0, use specSize in this case as could be a legacy container
289 if( size < tmp && size > LayoutLength( 0 ) )
299 case MeasureSpec::Mode::EXACTLY:
305 DALI_LOG_STREAM( gLayoutFilter, Debug::General, "LayoutItem::GetDefaultSize setting default size:" << result << "\n" );
309 void LayoutItem::OnMeasure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec)
311 DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::OnMeasure\n");
313 // GetDefaultSize will limit the MeasureSpec to the suggested minimumWidth and minimumHeight
314 SetMeasuredDimensions( GetDefaultSize( GetSuggestedMinimumWidth(), widthMeasureSpec ),
315 GetDefaultSize( GetSuggestedMinimumHeight(), heightMeasureSpec ) );
318 void LayoutItem::OnLayout( bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom )
322 void LayoutItem::SetParent( LayoutParent* parent )
324 mImpl->mLayoutParent = parent;
325 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_SET_FRAME );
328 LayoutParent* LayoutItem::GetParent()
330 return mImpl->mLayoutParent;
333 void LayoutItem::RequestLayout()
335 Toolkit::Control control = Toolkit::Control::DownCast( mImpl->mOwner );
338 DALI_LOG_INFO( gLayoutFilter, Debug::Verbose, "LayoutItem::RequestLayout %s\n", control.GetName().c_str());
340 // @todo Enforce failure if called in Measure/Layout passes.
341 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
342 Toolkit::LayoutController layoutController = Toolkit::LayoutController::Get();
343 layoutController.RequestLayout( Toolkit::LayoutItem(this) );
346 bool LayoutItem::IsLayoutRequested() const
348 return mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
351 void LayoutItem::SetLayoutRequested()
353 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_LAYOUT );
356 bool LayoutItem::IsResizePolicyRequired() const
358 return mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_USE_RESIZE_POLICY );
361 void LayoutItem::SetResizePolicyRequired( bool resizePolicyRequired )
363 if( resizePolicyRequired )
365 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_USE_RESIZE_POLICY );
369 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_USE_RESIZE_POLICY );
373 void LayoutItem::SetMeasuredDimensions( MeasuredSize measuredWidth, MeasuredSize measuredHeight )
376 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::SetMeasuredDimensions width(" << measuredWidth.GetSize() << ") height(" << measuredHeight.GetSize() << ") Control:" <<
377 ( ( Actor::DownCast( GetOwner()) ) ? Actor::DownCast(GetOwner()).GetName().c_str() : "Invalid Actor" ) << "\n" );
379 mImpl->SetPrivateFlag( Impl::PRIVATE_FLAG_MEASURED_DIMENSION_SET );
380 mImpl->mMeasuredWidth = measuredWidth;
381 mImpl->mMeasuredHeight = measuredHeight;
384 LayoutLength LayoutItem::GetMeasuredWidth() const
386 // Get the size portion of the measured width
387 return mImpl->mMeasuredWidth.GetSize();
390 LayoutLength LayoutItem::GetMeasuredHeight() const
392 return mImpl->mMeasuredHeight.GetSize();
395 MeasuredSize LayoutItem::GetMeasuredWidthAndState() const
397 return mImpl->mMeasuredWidth;
400 MeasuredSize LayoutItem::GetMeasuredHeightAndState() const
402 return mImpl->mMeasuredHeight;
405 LayoutLength LayoutItem::GetSuggestedMinimumWidth() const
407 auto owner = GetOwner();
408 auto actor = Actor::DownCast(owner);
409 auto naturalSize = actor ? actor.GetNaturalSize() : Vector3::ZERO;
411 return std::max( mImpl->mMinimumSize.GetWidth(), LayoutLength( naturalSize.width ) );
414 LayoutLength LayoutItem::GetSuggestedMinimumHeight() const
416 auto owner = GetOwner();
417 auto actor = Actor::DownCast(owner);
418 auto naturalSize = actor ? actor.GetNaturalSize() : Vector3::ZERO;
420 return std::max( mImpl->mMinimumSize.GetHeight(), LayoutLength( naturalSize.height ) );
423 MeasuredSize LayoutItem::ResolveSizeAndState( LayoutLength size, MeasureSpec measureSpec, MeasuredSize::State childMeasuredState )
425 auto specMode = measureSpec.GetMode();
426 LayoutLength specSize = measureSpec.GetSize();
431 case MeasureSpec::Mode::AT_MOST:
435 result = MeasuredSize( specSize, MeasuredSize::MEASURED_SIZE_TOO_SMALL );
439 result.SetSize( size );
444 case MeasureSpec::Mode::EXACTLY:
446 result.SetSize( specSize );
450 case MeasureSpec::Mode::UNSPECIFIED:
453 result.SetSize( size );
458 result.SetState( childMeasuredState );
463 bool LayoutItem::SetFrame( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom )
465 bool changed = false;
467 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::SetFrame enter(" << left << ", " << top << ", " << right << ", " << bottom << ")\n" );
469 if( mImpl->mLeft != left || mImpl->mRight != right || mImpl->mTop != top || mImpl->mBottom != bottom || mImpl->GetPrivateFlag( Impl::PRIVATE_FLAG_FORCE_SET_FRAME ) )
473 LayoutLength oldWidth = mImpl->mRight - mImpl->mLeft;
474 LayoutLength oldHeight = mImpl->mBottom - mImpl->mTop;
475 LayoutLength newWidth = right - left;
476 LayoutLength newHeight = bottom - top;
477 bool sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
481 mImpl->mRight = right;
482 mImpl->mBottom = bottom;
484 mImpl->ClearPrivateFlag( Impl::PRIVATE_FLAG_FORCE_SET_FRAME );
487 // Reflect up to parent control
488 auto owner = GetOwner();
489 auto actor = Actor::DownCast(owner);
492 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::SetFrame owner(" << left << ", " << top << ", " << right << ", " << bottom << ")\n" );
494 if( mImpl->mAnimated )
496 auto animation = Animation::New( 0.5f );
497 animation.AnimateTo( Property( actor, Actor::Property::POSITION_X ), left.AsInteger() );
498 animation.AnimateTo( Property( actor, Actor::Property::POSITION_Y ), top.AsInteger() );
500 animation.AnimateTo( Property( actor, Actor::Property::SIZE_WIDTH ), newWidth.AsInteger() );
501 animation.AnimateTo( Property( actor, Actor::Property::SIZE_HEIGHT ), newHeight.AsInteger() );
503 animation.FinishedSignal().Connect( mSlotDelegate, &LayoutItem::OnLayoutAnimationFinished );
508 // @todo Collate into list of Property & Property::Value pairs.
509 actor.SetX( left.AsInteger() );
510 actor.SetY( top.AsInteger() );
511 actor.SetProperty( Actor::Property::SIZE_WIDTH, newWidth.AsInteger() );
512 actor.SetProperty( Actor::Property::SIZE_HEIGHT, newHeight.AsInteger() );
518 SizeChange( LayoutSize( newWidth, newHeight ), LayoutSize( oldWidth, oldHeight ) );
522 DALI_LOG_STREAM( gLayoutFilter, Debug::Verbose, "LayoutItem::SetFrame exit(" << left << ", " << top << ", " << right << ", " << bottom << ")\n" );
527 void LayoutItem::OnLayoutAnimationFinished( Animation& animation )
529 auto owner = GetOwner();
530 auto actor = Actor::DownCast(owner);
533 actor.SetSize( Vector3( mImpl->mRight.AsInteger() - mImpl->mLeft.AsInteger(), mImpl->mBottom.AsInteger() - mImpl->mTop.AsInteger(), 0.0f ) );
537 void LayoutItem::SizeChange( LayoutSize newSize, LayoutSize oldSize)
539 OnSizeChanged( newSize, oldSize );
543 void LayoutItem::OnSizeChanged( LayoutSize newSize, LayoutSize oldSize )
547 void LayoutItem::OnInitialize()
552 } // namespace Internal
553 } // namespace Toolkit