crossmobile.ios.uikit

Class UIPageControl

java.lang.Object

crossmobile.ios.foundation.NSObject

crossmobile.ios.uikit.UIResponder

crossmobile.ios.uikit.UIView

crossmobile.ios.uikit.UIControl

crossmobile.ios.uikit.UIPageControl

All Implemented Interfaces:

UIAccessibilityIdentification, UIAppearance, UIAppearanceContainer

public class UIPageControl
extends UIControl

UIPageControl class defines an object that is used for custom control of presenting pages. Visually it is depicted as a sequence of dots that correspond to pages. The currently displayed page belongs to a white dot.

Field Summary

Fields inherited from class crossmobile.ios.uikit.UIView

NoIntrinsicMetric

Constructor Summary

Constructors

Constructor and Description
UIPageControl() Constructs a default UIPageControl object located at (0,0) with 0 weight and 0 height.
UIPageControl(CGRect rect) Constructs a UIPageControl object initialized with the dimensions and position specified in the rect parameter.

Method Summary

Modifier and Type	Method and Description
int	currentPage() Returns the number that corresponds to the current shown page(white dot).The number of the first page is 0.
UIColor	currentPageIndicatorTintColor() Returns the color of the page indicator.
boolean	defersCurrentPageDisplay() Returns a Boolean that controls whether indicator's current page is rendered.
void	drawRect(CGRect rect3) This method is implicitly called when a view is first displayed or when an event occurs that invalidates a visible part of the view and the view needs to be redrawn.
boolean	hidesForSinglePage() Returns a Boolean that shows whether the page control is hidden for one page.
int	numberOfPages() Returns the number of pages represented as dots.
UIColor	pageIndicatorTintColor() Returns the number of pages represented as dots.
void	setCurrentPage(int currentPage) Sets the current page shown as a white dot.
void	setCurrentPageIndicatorTintColor(UIColor currentPageIndicatorTintColor) Sets the color of the current page indicator.
void	setDefersCurrentPageDisplay(boolean defersCurrentPageDisplay) Sets a Boolean that controls whether indicator's current page is rendered.
void	setHidesForSinglePage(boolean hidesForSinglePage) Sets a Boolean that defines whether the page control is hidden for one page.
void	setNumberOfPages(int numberOfPages) Sets the number of pages represented as dots.
void	setPageIndicatorTintColor(UIColor pageIndicatorTintColor) Sets the color of the page indicator.
CGSize	sizeForNumberOfPages(int pageCount) Returns the size of this page control's bounds in order to accomodate the specified number of pages.
void	updateCurrentPageDisplay() Updates the page indicator so that matches with the current page.

Methods inherited from class crossmobile.ios.uikit.UIControl

addTarget, allTargets, contentHorizontalAlignment, contentVerticalAlignment, hitTest, isEnabled, isHighlighted, isSelected, removeTarget, sendActionsForControlEvents, setContentHorizontalAlignment, setContentVerticalAlignment, setEnabled, setHighlighted, setSelected, state, touchesBegan, touchesCancelled, touchesEnded, touchesMoved

Methods inherited from class crossmobile.ios.uikit.UIView

accessibilityIdentifier, addConstraint, addConstraints, addGestureRecognizer, addLayoutGuide, addSubview, alpha, animateWithDuration, animateWithDuration, animateWithDuration, areAnimationsEnabled, autoresizesSubviews, autoresizingMask, backgroundColor, bottomAnchor, bounds, bringSubviewToFront, center, centerXAnchor, centerYAnchor, clipsToBounds, constraints, contentCompressionResistancePriorityForAxis, contentHuggingPriorityForAxis, contentMode, convertPointFromView, convertPointToView, convertRectFromView, convertRectToView, didAddSubview, didMoveToSuperview, didMoveToWindow, frame, gestureRecognizers, heightAnchor, insertSubview, insetsLayoutMarginsFromSafeArea, intrinsicContentSize, invalidateIntrinsicContentSize, isHidden, isMultipleTouchEnabled, isOpaque, isUserInteractionEnabled, layer, layoutIfNeeded, layoutMargins, layoutMarginsDidChange, layoutMarginsGuide, layoutSubviews, leadingAnchor, leftAnchor, maskView, needsUpdateConstraints, nextResponder, overrideUserInterfaceStyle, pointInside, preservesSuperviewLayoutMargins, removeConstraint, removeConstraints, removeFromSuperview, removeGestureRecognizer, removeLayoutGuide, requiresConstraintBasedLayout, restorationIdentifier, rightAnchor, safeAreaInsets, safeAreaLayoutGuide, sendSubviewToBack, setAccessibilityIdentifier, setAlpha, setAnimationBeginsFromCurrentState, setAnimationCurve, setAnimationDelay, setAnimationDuration, setAnimationRepeatAutoreverses, setAnimationRepeatCount, setAnimationsEnabled, setAnimationStartDate, setAutoresizesSubviews, setAutoresizingMask, setBackgroundColor, setBounds, setCenter, setClearsContextBeforeDrawing, setClipsToBounds, setContentCompressionResistancePriority, setContentHuggingPriority, setContentMode, setFrame, setGestureRecognizers, setHidden, setInsetsLayoutMarginsFromSafeArea, setLayoutMargins, setMaskView, setMultipleTouchEnabled, setNeedsDisplay, setNeedsLayout, setNeedsUpdateConstraints, setOpaque, setOverrideUserInterfaceStyle, setPreservesSuperviewLayoutMargins, setRestorationIdentifier, setTag, setTintAdjustmentMode, setTintColor, setTransform, setTranslatesAutoresizingMaskIntoConstraints, setUserInteractionEnabled, sizeThatFits, sizeToFit, subviews, superview, tag, tintAdjustmentMode, tintColor, tintColorDidChange, topAnchor, toString, trailingAnchor, transform, transitionWithView, translatesAutoresizingMaskIntoConstraints, updateConstraints, updateConstraintsIfNeeded, userInterfaceLayoutDirection, viewForFirstBaselineLayout, viewForLastBaselineLayout, widthAnchor, willMoveToSuperview, willMoveToWindow, willRemoveSubview, window

Methods inherited from class crossmobile.ios.uikit.UIResponder

becomeFirstResponder, isFirstResponder, resignFirstResponder

Methods inherited from class crossmobile.ios.foundation.NSObject

addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UIPageControl

public UIPageControl()

Constructs a default UIPageControl object located at (0,0) with 0 weight and 0 height.

UIPageControl

public UIPageControl(CGRect rect)

Constructs a UIPageControl object initialized with the dimensions and position specified in the rect parameter.

Parameters:

rect - CGRect that defines dimension and position of UIPageControl.

Method Detail

sizeForNumberOfPages

public CGSize sizeForNumberOfPages(int pageCount)

Returns the size of this page control's bounds in order to accomodate the specified number of pages.

Parameters:

pageCount - The number of pages.

Returns:

The size required to display appropriate dots for the specified number of pages.

updateCurrentPageDisplay

public void updateCurrentPageDisplay()

Updates the page indicator so that matches with the current page.

currentPage

public int currentPage()

Returns the number that corresponds to the current shown page(white dot).The number of the first page is 0.

Returns:

The number that corresponds to the current shown page.

setCurrentPage

public void setCurrentPage(int currentPage)

Sets the current page shown as a white dot.

Parameters:

currentPage - The current page shown as a white dot.

defersCurrentPageDisplay

public boolean defersCurrentPageDisplay()

Returns a Boolean that controls whether indicator's current page is rendered.

Returns:

A Boolean that controls whether the current page of the indicator is displayed or not.TRUE delays rendering updateCurrentPageDisplay is called.

setDefersCurrentPageDisplay

public void setDefersCurrentPageDisplay(boolean defersCurrentPageDisplay)

Sets a Boolean that controls whether indicator's current page is rendered.

Parameters:

defersCurrentPageDisplay - A Boolean that controls whether the current page of the indicator is displayed or not.TRUE delays rendering updateCurrentPageDisplay is called.

hidesForSinglePage

public boolean hidesForSinglePage()

Returns a Boolean that shows whether the page control is hidden for one page.

Returns:

A Boolean that shows whether the page control is hidden for one page.

setHidesForSinglePage

public void setHidesForSinglePage(boolean hidesForSinglePage)

Sets a Boolean that defines whether the page control is hidden for one page.

Parameters:

hidesForSinglePage - A Boolean that defines whether the page control is hidden for one page.

numberOfPages

public int numberOfPages()

Returns the number of pages represented as dots.

Returns:

The number of pages represented as dots.

setNumberOfPages

public void setNumberOfPages(int numberOfPages)

Sets the number of pages represented as dots.

Parameters:

numberOfPages - The number of pages the receiver shows

pageIndicatorTintColor

public UIColor pageIndicatorTintColor()

Returns the number of pages represented as dots.

Returns:

The number of pages represented as dots.

setPageIndicatorTintColor

public void setPageIndicatorTintColor(UIColor pageIndicatorTintColor)

Sets the color of the page indicator.

Parameters:

pageIndicatorTintColor - The color of the page indicator.

currentPageIndicatorTintColor

public UIColor currentPageIndicatorTintColor()

Returns the color of the page indicator.

Returns:

The color of the page indicator.

setCurrentPageIndicatorTintColor

public void setCurrentPageIndicatorTintColor(UIColor currentPageIndicatorTintColor)

Sets the color of the current page indicator.

Parameters:

currentPageIndicatorTintColor - The color of the current page indicator.

drawRect

public final void drawRect(CGRect rect3)

Description copied from class: UIView

This method is implicitly called when a view is first displayed or when an event occurs that invalidates a visible part of the view and the view needs to be redrawn.

Overrides:

drawRect in class UIView

Parameters:

rect3 - The part of the view that need to be redrawn.