| Package | lunas.components.labels |
| Class | public class PaginationLabel |
| Inheritance | PaginationLabel  Label CoreComponent Background CoreSprite flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
 | align : uint
The alignement of the background. | Background | |
| autoSize : Boolean
Indicates if the background is resizing when the stage resize event is invoked. | Background | |
| border : EdgeMetrics
Indicates the thickness, in pixels, of the four edge regions around a visual component. | CoreComponent | |
| bottomLeftRadius : Number
The radius of the bottom-left corner, in pixels. | Background | |
| bottomRightRadius : Number
The radius of the bottom-right corner, in pixels. | Background | |
| bubbles : Boolean = true
Indicates if the events use bubbling when are dispatched. | CoreComponent | |
| builder : Builder
Indicates the Builder reference of this instance. | CoreComponent | |
| componentInspectorSetting : Boolean
Initialize when the Flash component settings are initialized (only in Flash with a compiled component). | CoreComponent | |
| currentPage : uint
Indicates the current page number. | PaginationLabel | ||
| direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null). | Background | |
| enabled : Boolean
Indicates the enabled state of the component. | CoreComponent | |
| enabledKey : Boolean = true
Indicates if the key controller is enabled. | PaginationLabel | ||
| fill : IFillStyle
Determinates the IFillStyle reference of this display. | Background | |
| firstLabel : String
Indicates the first label value of this display. | PaginationLabel | ||
| gradientMatrix : Matrix
The matrix value to draw the gradient fill. | Background | |
| gradientRotation : Number = 0
The rotation value to draw the gradient fill. | Background | |
| gradientTranslation : Point
The translation vector to draw the gradient fill. | Background | |
| group : Boolean
Indicates with a boolean if this object is grouped. | CoreComponent | |
| groupName : String
Indicates the name of the group of this object. | CoreComponent | |
| h : Number
Determinates the virtual height value of this component. | Background | |
| isFull : Boolean
Indicates if the background use full size (use Stage.stageWidth and Stage.stageHeight to resize the background). | Background | |
| label : String
Indicates the label value of this display. | Label | |
| lastLabel : String
Indicates the last label value of this display. | PaginationLabel | ||
| layout : Layout
Determinates the layout of this container. | CoreComponent | |
| limitPage : uint
Indicates the limit until the current pages. | PaginationLabel | ||
| line : ILineStyle
Determinates the ILineStyle reference of this display. | Background | |
| logger : Logger
Determinates the internal ILogger reference of this Logable object. | CoreSprite | |
| maxHeight : Number
This property defined the maximum height of this display. | Background | |
| maxWidth : Number
Defines the maximum width of this display. | Background | |
| minHeight : Number
This property defined the mimimun height of this display (This value is >= 0). | Background | |
| minWidth : Number
This property defined the mimimun width of this display (This value is >= 0). | Background | |
| nextLabel : String
Indicates the next label value of this display. | PaginationLabel | ||
| pages : Array [read-only]
Indicates the array representation of all page numbers with the current navigator values. | PaginationLabel | ||
| pagination : PageByPageModel
Return the _pagination reference. | PaginationLabel | ||
| previousLabel : String
Indicates the previous label value of this display. | PaginationLabel | ||
| style : Style
Returns the style of this component. | CoreComponent | |
| title : String
Indicates the title value of this display. | PaginationLabel | ||
| topLeftRadius : Number
The radius of the upper-left corner, in pixels. | Background | |
| topRightRadius : Number
The radius of the upper-right corner, in pixels. | Background | |
| totalPage : uint
Indicates the pages total number. | PaginationLabel | ||
| useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle). | Background | |
| w : Number
Determinates the virtual height value of this component. | Background | |
| Method | Defined By | ||
|---|---|---|---|
PaginationLabel(w:Number = 610, h:Number = 22)
Creates a new PaginationTitle instance. | PaginationLabel | ||
| doLater():void
Launch an event with a delayed interval. | Background | |
| draw(... arguments):void
Draw the display. | Background | |
getBuilderRenderer():Class [override]
Returns the IBuilder constructor use to initialize this component. | PaginationLabel | ||
getStyleRenderer():Class [override]
Returns the Style constructor use to initialize this component. | PaginationLabel | ||
| groupPolicyChanged():void
Invoked when the group property or the groupName property changed. | CoreComponent | |
| hide():void
Hides the component. | CoreComponent | |
| initBackgroundPen(graphic:* = null):IPen
Init the pen to draw the background of this display. | Background | |
| initialize():void
Initialize the component. | CoreComponent | |
| isLocked():Boolean
Returns true if the object is locked. | CoreSprite | |
| isVisible():Boolean
Returns true if the component is visible. | CoreComponent | |
| lock():void [override]
Locks the object. | CoreComponent | |
| move(x:Number, y:Number):void
Moves the component. | CoreComponent | |
notifyChange(page:Number):void
Notify a change with the current selected page. | PaginationLabel | ||
| notifyChanged():void
Notify a change in this component. | CoreComponent | |
| notifyEnabled():void
Notify an event when the enabled property is changed. | CoreComponent | |
| notifyResized():void
Notify an event when you resize the component. | Background | |
| refresh(init:*):void
Refresh and initialize the display with a generic object and invoke the "update" method. | Background | |
| registerView(scope:DisplayObjectContainer = null):void
Registers the view of this component. | CoreComponent | |
| resetLock():void
Reset the lock security of the display. | CoreSprite | |
| resize(e:Event = null):void
Resize and update the background. | Background | |
| scope():DisplayObject
Returns the real scope reference of this component. | CoreComponent | |
| setCornerRadius(n:Number):void
Defines all corner radius of the background (upper-left, upper-right, bottom-left and bottom-right). | Background | |
setNavigator(current:uint = 1, total:uint = 1, limit:uint = 5):void
Sets the pagination navigator inside the title. | PaginationLabel | ||
| setSize(w:Number, h:Number):void
Sets the virtual width (w) and height (h) values of the component. | Background | |
| setStyle(... args):void
Sets the style property on the style declaration or object. | CoreComponent | |
| show():void
Shows the component. | CoreComponent | |
| unlock():void [override]
Unlocks the display. | CoreComponent | |
| unregisterView():void
Unregisters the view of this component. | CoreComponent | |
| update():void [override]
Updates the component. | CoreComponent | |
| viewChanged():void
This method is invoked after the draw() method in the update() method. | Background | |
| viewDestroyed(e:Event = null):void
Invoked when the component is removed. | CoreComponent | |
| viewEnabled():void [override]
Invoked when the enabled property of the component change. | Label | |
| viewResize():void
Invoked when the component is resized. | Background | |
| viewStyleChanged(e:Event = null):void [override]
Invoked when the component Style changed. | Label | |
| viewStyleSheetChanged():void
Invoked when the StyleSheet in the Style is changed. | Label | |
| Method | Defined By | ||
|---|---|---|---|
addedToStage(e:Event = null):void [override]
Invoked when the display is added to the stage. | PaginationLabel | ||
| addedToStageResize(e:Event = null):void
Invoked when the display is removed from the stage to enable the autoSize mode. | Background | |
| fireComponentEvent(type:String):void
Dispatchs a ComponentEvent with the specified type. | CoreComponent | |
keyDown(e:KeyboardEvent = null):void
Invoked when a key is down in the stage. | PaginationLabel | ||
removedFromStage(e:Event = null):void [override]
Invoked when the display is removed from the stage. | PaginationLabel | ||
| removedFromStageResize(e:Event = null):void
Invoked when the display is removed from the stage to disable the autoSize mode. | Background | |
| renderLayout(layout:Layout = null):void
Receives a message when the layout emit when is rendered. | CoreComponent | |
| updateLayout(layout:Layout = null):void
Receives a message when the layout emit when is updated. | CoreComponent | |
| currentPage | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescurrentPage:uintIndicates the current page number.
public function get currentPage():uint public function set currentPage(value:uint):void| enabledKey | property |
public var enabledKey:Boolean = trueIndicates if the key controller is enabled.
| firstLabel | property |
firstLabel:StringIndicates the first label value of this display.
public function get firstLabel():String public function set firstLabel(value:String):void| lastLabel | property |
lastLabel:StringIndicates the last label value of this display.
public function get lastLabel():String public function set lastLabel(value:String):void| limitPage | property |
limitPage:uintIndicates the limit until the current pages.
public function get limitPage():uint public function set limitPage(value:uint):void| nextLabel | property |
nextLabel:StringIndicates the next label value of this display.
public function get nextLabel():String public function set nextLabel(value:String):void| pages | property |
pages:Array [read-only] Indicates the array representation of all page numbers with the current navigator values.
public function get pages():Array| pagination | property |
pagination:PageByPageModelReturn the _pagination reference.
public function get pagination():PageByPageModel public function set pagination(value:PageByPageModel):void| previousLabel | property |
previousLabel:StringIndicates the previous label value of this display.
public function get previousLabel():String public function set previousLabel(value:String):void| title | property |
title:StringIndicates the title value of this display.
public function get title():String public function set title(value:String):void| totalPage | property |
totalPage:uintIndicates the pages total number.
public function get totalPage():uint public function set totalPage(value:uint):void| PaginationLabel | () | Constructor |
public function PaginationLabel(w:Number = 610, h:Number = 22)Creates a new PaginationTitle instance.
Parametersw:Number (default = 610) | |
h:Number (default = 22) |
| addedToStage | () | method |
override protected function addedToStage(e:Event = null):voidInvoked when the display is added to the stage.
Parameters
e:Event (default = null) |
| getBuilderRenderer | () | method |
override public function getBuilderRenderer():ClassReturns the IBuilder constructor use to initialize this component.
ReturnsClass — the IBuilder constructor use to initialize this component.
|
| getStyleRenderer | () | method |
override public function getStyleRenderer():ClassReturns the Style constructor use to initialize this component.
ReturnsClass — the Style constructor use to initialize this component.
|
| keyDown | () | method |
protected function keyDown(e:KeyboardEvent = null):voidInvoked when a key is down in the stage.
Parameters
e:KeyboardEvent (default = null) |
| notifyChange | () | method |
public function notifyChange(page:Number):voidNotify a change with the current selected page.
Parameters
page:Number |
| removedFromStage | () | method |
override protected function removedFromStage(e:Event = null):voidInvoked when the display is removed from the stage.
Parameters
e:Event (default = null) |
| setNavigator | () | method |
public function setNavigator(current:uint = 1, total:uint = 1, limit:uint = 5):voidSets the pagination navigator inside the title.
Parameters
current:uint (default = 1) | |
total:uint (default = 1) | |
limit:uint (default = 5) |