ZFUIScrollerDefault Class Reference

default scroller of ZFUIScroller More...

#include <ZFUIScrollerDefault.h>

Inheritance diagram for ZFUIScrollerDefault:

Public Types
enum
Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info
virtual void	scrollOwnerSizeOnUpdate (zffloat ownerSize)
	called when owner scroll view's size changed, you should fix content frame to match bounds if necessary
virtual void	scrollBounceOnUpdate (zfbool scrollBounce, zfbool scrollBounceAlways)
	whether use bounce
virtual void	scrollAlignToPageOnUpdate (zfbool scrollAlignToPage)
	whether align to page
virtual void	scrollContentOnUpdate (zffloat contentOffset, zffloat contentSize)
	used to update scroll content, you should keep or update previous scroll animation if necessary
virtual void	scrollToFitRange (void)
	cancel over scroll and ensure content offset in range
virtual void	scrollWithoutAnimation (zffloat contentOffset)
	scroll without scroll animation, you should stop old scroll animation if necessary
virtual void	scrollByPoint (zffloat point)
	see ZFUIScrollView::scrollByPoint
virtual zffloat	scrollByPointEndPoint (void)
	return end position of scrollByPoint, must return current content offset if not scrolling
virtual void	scrollBySpeed (zffloat speed)
	see ZFUIScrollView::scrollBySpeed
virtual zffloat	scrollBySpeedCurrentSpeed (void)
	return current speed of scrollBySpeed
virtual zffloat	scrollBySpeedEndPointPredicted (void)
	return end position of scrollBySpeed, must return current content offset if not scrolling
virtual zffloat	scrollEndPointPredicted (void)
	return end position, must return current content offset if not scrolling
virtual zfbool	scrollRequireFocus (void)
	whether this direction's scroller want higher priority, typically true if currently under progress to scroll to align to page
virtual zffloat	scrollOwnerSize (void)
	used to get current owner size
virtual zffloat	scrollContentOffset (void)
	used to get current content offset
virtual zffloat	scrollContentSize (void)
	used to get current content size
virtual void	scrollOnDragBegin (zffloat mousePos, zftimet mouseTime)
	drag begin
virtual void	scrollOnDrag (zffloat mousePos, zftimet mouseTime)
	drag
virtual void	scrollOnDragEnd (zftimet mouseTime, zfbool needScrollAni)
	drag end
virtual void	scrollAniOnUpdate (zftimet time)
	called to update scroll animation
Public Member Functions inherited from ZFObject
zfindex	objectRetainCount (void)
	return the object's retain count
void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance
zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance
void	objectInfoT (zfstring &ret)
	see objectInfo
zfstring	objectInfo (void)
	return object info
zfidentity	objectHash (void)
	get hash of this object
ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare with anotherObj
ZFCompareResult	objectCompareValue (ZFObject *anotherObj)
	explicitly compare object by logical value, see objectCompare
virtual zfauto	invoke (const zfstring &methodName)
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invoke (const zfstring &methodName, ZFObject *param0, ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfbool	invokeT (zfauto &ret, zfstring *errorHint, const zfstring &methodName, ZFObject *param0=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invokeDetail (const zfstring &methodName, const ZFCoreArray< zfauto > &params, zfbool *success=zft_zfnull, zfstring *errorHint=zft_zfnull)
	util method to perform ZFDI_invoke, do nothing if fail
zfbool	objectTagExist (void)
	see objectTag, true if this object has tag, and tag can be checked by objectTagGetAllKeyValue
void	objectTag (const zfstring &key, ZFObject *tag)
	used to hold a object for app's use, auto retained
zfany	objectTag (const zfstring &key)
	see objectTag
void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value
void	objectTagRemove (const zfstring &key)
	remove tag, same as set tag to null
zfauto	objectTagRemoveAndGet (const zfstring &key)
	remove tag, return removed tag or null if not exist
void	objectTagRemoveAll (void)
	remove all tag
void	observerAdd (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerAddForOnce (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerRemove (zfidentity eventId, const ZFListener &callback)
	see observerNotify
void	observerRemoveAll (zfidentity eventId)
	see observerNotify
void	observerRemoveAll (void)
	see observerNotify
zfbool	observerHasAdd (void)
	true if any observer has been added
zfbool	observerHasAdd (zfidentity eventId)
	true if any observer with eventId has been added
void	observerNotify (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	notify the observer with eventId
void	observerNotifyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReversely (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReverselyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
ZFObserver &	observerHolder (void)
	access the internal observer holder
void	on (const zfstring &eventName, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	on (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	onInit (const ZFListener &impl)
	util for script to achieve chained call
void	onDealloc (const ZFListener &impl)
	util for script to achieve chained call
zfbool	objectInstanceStateCheck (ZFObjectInstanceState state)
	object instance's state
zfbool	objectInitRunning (void)
	util method to check whether ZFObjectInstanceStateOnInit or ZFObjectInstanceStateOnInitFinish running
zfbool	objectDeallocRunning (void)
	util method to check whether ZFObjectInstanceStateOnDeallocPrepare or ZFObjectInstanceStateOnDealloc running
virtual zfbool	objectIsInternal (void)
	whether this object is internal object or its class is ZFClass::classIsInternal
virtual zfbool	objectIsInternalPrivate (void)
	whether this object is internal private object or its class is ZFClass::classIsInternalPrivate
Public Member Functions inherited from ZFUIScroller
virtual void	scrollStop (void)
	util method to stop scroll animation
Public Member Functions inherited from ZFInterface
virtual ZFObject *	toObject (void)=0
	convert to ZFObject type

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info
Static Public Member Functions inherited from ZFObject
static const ZFClass *	ClassData (void)
	get class info
static zfidentity	E_ObjectBeforeAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectAfterAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectBeforeDealloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnUpdate (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnReset (void)
	see ZFObject::observerNotify
Static Public Member Functions inherited from ZFUIScroller
static const ZFClass *	ClassData (void)
	get class info
Static Public Member Functions inherited from ZFInterface
static const ZFClass *	ClassData (void)
	get class info

Protected Types
typedef ZFObject	zfsuper
	class ref to super
typedef ZFUIScrollerDefault	zfself
	class ref to self
Protected Types inherited from ZFObject
typedef _ZFP_Obj_Base	zfsuper
	class ref to super
typedef ZFObject	zfself
	class ref to self
Protected Types inherited from ZFUIScroller
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)
typedef ZFUIScroller	zfself
	typedef for self
Protected Types inherited from ZFInterface
typedef _ZFP_ObjI_Base	zfsuper
	typedef for super (always ZFInterface for an interface type)
typedef ZFInterface	zfself
	typedef for self

Protected Member Functions
virtual void	objectOnInit (void)
	override this to init your object
virtual void	objectOnDealloc (void)
	override this to destroy your object
Protected Member Functions inherited from ZFObject
virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo
virtual void	objectInfoImplAppend (zfstring &ret)
	see objectInfo
virtual zfidentity	objectHashImpl (void)
	see objectHash
virtual ZFCompareResult	objectCompareImpl (ZFObject *anotherObj)
	see objectCompare
virtual ZFCompareResult	objectCompareValueImpl (ZFObject *anotherObj)
	see objectCompareValue
virtual void	observerOnAdd (zfidentity eventId)
	called when add first observer
virtual void	observerOnRemove (zfidentity eventId)
	called when remove last observer
virtual void	observerOnEvent (const ZFArgs &zfargs)
	notified when observerNotify
virtual void	objectOnInitFinish (void)
	called after objectOnInit, safe to call virtual functions here
virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here
virtual void	objectOnRetain (void)
	called to retain object
virtual void	objectOnRelease (void)
	called to release object
virtual void	objectPropertyValueOnUpdate (const ZFProperty *property, const void *oldValue)
	see E_ObjectPropertyValueOnUpdate
virtual void	objectPropertyValueOnReset (const ZFProperty *property)
	see E_ObjectPropertyValueOnReset

Additional Inherited Members
Public Attributes inherited from ZFUIScroller
ZFListener	scrollAniStartCallback
	used to start scroll animation's timer
ZFListener	scrollAniStopCallback
	used to stop scroll animation's timer

Detailed Description

default scroller of ZFUIScroller

Member Function Documentation

classData()

virtual const ZFClass * ZFUIScrollerDefault::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFObject.

objectOnInit()

virtual void ZFUIScrollerDefault::objectOnInit ( void )

protectedvirtual

override this to init your object

subclass must call superclass's objectOnInit before any other code if override
you may also declare objectOnInit with params like this:

zfclass Parent : ... {
    ...
protected:
    virtual void objectOnInit(void) {...};
};
zfclass Child : Parent {
protected:
    // override all parent's objectOnInit is also required,
    // because of function hiding of C++
    zfoverride
    virtual void objectOnInit(void) {
        zfsuper::objectOnInit();
    }
    // custom init entry
    virtual void objectOnInit(Params...) {
        // your extra init steps
        ...
    }
};

Warning

objectOnInit and objectOnDealloc is called as a virtual function, take good care of other virtual function call, use zfself::func() instead of this->func() if necessary, or use objectOnInitFinish/objectOnDeallocPrepare, or declare your own constructor with ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR

Note

(ZFTAG_LIMITATION) due to limitations of C++, if your parent type declared objectOnInit with different params, and your child type want to override part of those objectOnInit, then your child type must also override all objectOnInit that parent declared, otherwise, some may be hidden

for objects that designed not to be allocated by user, you should use ZFOBJECT_PRIVATE_ALLOC, typically usage:

zfclass MyObject : zfextend ZFObject {
    ZFOBJECT_DECLARE(MyObject, ZFObject)
    ZFOBJECT_PRIVATE_ALLOC("should be created by MyObject::instanceForXxx only")
 
public:
    static zfauto instanceForXxx(xxx) {
        // can only be allocated by reflection
        return zfself::ClassData()->newInstance();
    }
};
static void func(void) {
    // MyObject *obj = zfAlloc(MyObject); // would compile error
    zfauto obj = MyObject::instanceForXxx(xxx); // OK
}

Reimplemented from ZFObject.

objectOnDealloc()

virtual void ZFUIScrollerDefault::objectOnDealloc ( void )

protectedvirtual

override this to destroy your object

subclass must call superclass's objectOnDealloc after any other code if override
see objectOnInit for more info

Reimplemented from ZFObject.

scrollOwnerSizeOnUpdate()

virtual void ZFUIScrollerDefault::scrollOwnerSizeOnUpdate ( zffloat ownerSize )

virtual

called when owner scroll view's size changed, you should fix content frame to match bounds if necessary

Implements ZFUIScroller.

scrollBounceOnUpdate()

virtual void ZFUIScrollerDefault::scrollBounceOnUpdate ( zfbool scrollBounce, zfbool scrollBounceAlways )

virtual

whether use bounce

Implements ZFUIScroller.

scrollAlignToPageOnUpdate()

virtual void ZFUIScrollerDefault::scrollAlignToPageOnUpdate ( zfbool scrollAlignToPage )

virtual

whether align to page

Implements ZFUIScroller.

scrollContentOnUpdate()

virtual void ZFUIScrollerDefault::scrollContentOnUpdate ( zffloat contentOffset, zffloat contentSize )

virtual

used to update scroll content, you should keep or update previous scroll animation if necessary

Implements ZFUIScroller.

scrollToFitRange()

virtual void ZFUIScrollerDefault::scrollToFitRange ( void )

virtual

cancel over scroll and ensure content offset in range

Implements ZFUIScroller.

scrollWithoutAnimation()

virtual void ZFUIScrollerDefault::scrollWithoutAnimation ( zffloat contentOffset )

virtual

scroll without scroll animation, you should stop old scroll animation if necessary

Implements ZFUIScroller.

scrollByPoint()

virtual void ZFUIScrollerDefault::scrollByPoint ( zffloat point )

virtual

see ZFUIScrollView::scrollByPoint

Implements ZFUIScroller.

scrollByPointEndPoint()

virtual zffloat ZFUIScrollerDefault::scrollByPointEndPoint ( void )

virtual

return end position of scrollByPoint, must return current content offset if not scrolling

Implements ZFUIScroller.

scrollBySpeed()

virtual void ZFUIScrollerDefault::scrollBySpeed ( zffloat speed )

virtual

see ZFUIScrollView::scrollBySpeed

Implements ZFUIScroller.

scrollBySpeedCurrentSpeed()

virtual zffloat ZFUIScrollerDefault::scrollBySpeedCurrentSpeed ( void )

virtual

return current speed of scrollBySpeed

Implements ZFUIScroller.

scrollBySpeedEndPointPredicted()

virtual zffloat ZFUIScrollerDefault::scrollBySpeedEndPointPredicted ( void )

virtual

return end position of scrollBySpeed, must return current content offset if not scrolling

Implements ZFUIScroller.

scrollEndPointPredicted()

virtual zffloat ZFUIScrollerDefault::scrollEndPointPredicted ( void )

virtual

return end position, must return current content offset if not scrolling

Implements ZFUIScroller.

scrollRequireFocus()

virtual zfbool ZFUIScrollerDefault::scrollRequireFocus ( void )

virtual

whether this direction's scroller want higher priority, typically true if currently under progress to scroll to align to page

Implements ZFUIScroller.

scrollOwnerSize()

virtual zffloat ZFUIScrollerDefault::scrollOwnerSize ( void )

virtual

used to get current owner size

Implements ZFUIScroller.

scrollContentOffset()

virtual zffloat ZFUIScrollerDefault::scrollContentOffset ( void )

virtual

used to get current content offset

Implements ZFUIScroller.

scrollContentSize()

virtual zffloat ZFUIScrollerDefault::scrollContentSize ( void )

virtual

used to get current content size

Implements ZFUIScroller.

scrollOnDragBegin()

virtual void ZFUIScrollerDefault::scrollOnDragBegin ( zffloat mousePos, zftimet mouseTime )

virtual

drag begin

note drag events is not ensured paired

Implements ZFUIScroller.

scrollOnDrag()

virtual void ZFUIScrollerDefault::scrollOnDrag ( zffloat mousePos, zftimet mouseTime )

virtual

drag

note drag events is not ensured paired

Implements ZFUIScroller.

scrollOnDragEnd()

virtual void ZFUIScrollerDefault::scrollOnDragEnd ( zftimet mouseTime, zfbool needScrollAni )

virtual

drag end

note drag events is not ensured paired

if scroll animation is needed, use scrollAniStartCallback to start

Implements ZFUIScroller.

scrollAniOnUpdate()

virtual void ZFUIScrollerDefault::scrollAniOnUpdate ( zftimet time )

virtual

called to update scroll animation

Implements ZFUIScroller.

---

The documentation for this class was generated from the following file:

• ZFUIScrollerDefault.h