Package | flexlib.mdi.containers |
Class | public class MDIWindow |
Inheritance | MDIWindow ![]() |
Property | Defined by | ||
---|---|---|---|
closeBtn : Button [read-only]
Close window button.
| MDIWindow | ||
cornerHandleSize : Number = 10
Size of corner handles.
| MDIWindow | ||
draggable : Boolean = true
Flag determining whether or not this window is draggable.
| MDIWindow | ||
edgeHandleSize : Number = 4
Size of edge handles.
| MDIWindow | ||
hasFocus : Boolean | MDIWindow | ||
maximized : Boolean [read-only]
| MDIWindow | ||
maximizeRestoreBtn : Button [read-only]
Maximize/restore window button.
| MDIWindow | ||
minimizeBtn : Button [read-only]
Minimize window button.
| MDIWindow | ||
minimized : Boolean [read-only]
| MDIWindow | ||
minimizeHeight : Number [read-only]
| MDIWindow | ||
resizable : Boolean = true
Flag determining whether or not this window is resizable.
| MDIWindow | ||
savedWindowRect : Rectangle
Rectangle to represent window's size and position when resize begins
or window's size/position is saved.
| MDIWindow | ||
showCloseButton : Boolean | MDIWindow | ||
showControls : Boolean [write-only]
| MDIWindow | ||
titleBarOverlay : Canvas
Invisible shape laid over titlebar to prevent funkiness from clicking in title textfield.
| MDIWindow | ||
winContextMenu : ContextMenu = null
Window's context menu.
| MDIWindow | ||
windowControls : MDIWindowControlsContainer
Reference to class used to create windowControls property.
| MDIWindow | ||
windowManager : MDIManager
Reference to MDIManager instance this window is managed by, if any.
| MDIWindow | ||
windowStyleName : Object | MDIWindow |
Method | Defined by | ||
---|---|---|---|
Constructor
| MDIWindow | ||
close(event:MouseEvent = null):void
Close the window.
| MDIWindow | ||
getTitleIconObject():DisplayObject
Returns reference to titleIconObject which is mx_internal by default.
| MDIWindow | ||
getTitleTextField():UITextField
Returns reference to titleTextField which is protected by default.
| MDIWindow | ||
maximize():void
Maximize the window.
| MDIWindow | ||
maximizeRestore(event:MouseEvent = null):void
Called from maximize/restore button
| MDIWindow | ||
minimize(event:MouseEvent = null):void
Minimize the window.
| MDIWindow | ||
restore():void
Restores the window to its last floating position.
| MDIWindow | ||
restoreStyle():void
Restores style settings for restore and maximize
| MDIWindow | ||
saveStyle():void
Save style settings for minimizing.
| MDIWindow | ||
styleChanged(styleProp:String):void
Detects change to styleName that is executed by MDIManager indicating a change in focus.
| MDIWindow | ||
unMinimize(event:MouseEvent = null):void
Restore window to state it was in prior to being minimized.
| MDIWindow | ||
updateContextMenu():void
| MDIWindow |
Method | Defined by | ||
---|---|---|---|
createChildren():void
Create resize handles and window controls.
| MDIWindow | ||
getSelectorList():Array
| MDIWindow | ||
updateDisplayList(w:Number, h:Number):void
Position and size resize handles and window controls.
| MDIWindow |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the close button is clicked. | MDIWindow | |||
Dispatched while the window is being dragged. | MDIWindow | |||
Dispatched when the window stops being dragged. | MDIWindow | |||
Dispatched when the window starts being dragged. | MDIWindow | |||
Dispatched when the window loses focus and no longer has topmost z-index of MDIManager's children. | MDIWindow | |||
Dispatched when the window gains focus and is given topmost z-index of MDIManager's children. | MDIWindow | |||
Dispatched when the maximize button is clicked or when the window is in a normal state (not minimized or maximized) and the titleBar is double clicked. | MDIWindow | |||
Dispatched when the minimize button is clicked. | MDIWindow | |||
Dispatched while the mouse is down on a resize handle. | MDIWindow | |||
Dispatched when the mouse is released from a resize handle. | MDIWindow | |||
Dispatched when a resize handle is pressed. | MDIWindow | |||
If the window is minimized, this event is dispatched when the titleBar is clicked. | MDIWindow |
Constant | Defined by | ||
---|---|---|---|
CONTEXT_MENU_LABEL_CLOSE : String = "Close" [static]
| MDIWindow | ||
CONTEXT_MENU_LABEL_MAXIMIZE : String = "Maximize" [static]
| MDIWindow | ||
CONTEXT_MENU_LABEL_MINIMIZE : String = "Minimize" [static]
| MDIWindow | ||
CONTEXT_MENU_LABEL_RESTORE : String = "Restore" [static]
| MDIWindow |
closeBtn | property |
closeBtn:Button
[read-only]Close window button.
Implementation public function get closeBtn():Button
cornerHandleSize | property |
public var cornerHandleSize:Number = 10
Size of corner handles. Can be adjusted to affect "sensitivity" of resize area.
draggable | property |
public var draggable:Boolean = true
Flag determining whether or not this window is draggable.
edgeHandleSize | property |
public var edgeHandleSize:Number = 4
Size of edge handles. Can be adjusted to affect "sensitivity" of resize area.
hasFocus | property |
hasFocus:Boolean
[read-write]Implementation
public function get hasFocus():Boolean
public function set hasFocus(value:Boolean):void
maximized | property |
maximized:Boolean
[read-only]Implementation
public function get maximized():Boolean
maximizeRestoreBtn | property |
maximizeRestoreBtn:Button
[read-only]Maximize/restore window button.
Implementation public function get maximizeRestoreBtn():Button
minimizeBtn | property |
minimizeBtn:Button
[read-only]Minimize window button.
Implementation public function get minimizeBtn():Button
minimized | property |
minimized:Boolean
[read-only]Implementation
public function get minimized():Boolean
minimizeHeight | property |
minimizeHeight:Number
[read-only]Implementation
public function get minimizeHeight():Number
resizable | property |
public var resizable:Boolean = true
Flag determining whether or not this window is resizable.
savedWindowRect | property |
public var savedWindowRect:Rectangle
Rectangle to represent window's size and position when resize begins or window's size/position is saved.
showCloseButton | property |
showCloseButton:Boolean
[read-write]Implementation
public function get showCloseButton():Boolean
public function set showCloseButton(value:Boolean):void
showControls | property |
showControls:Boolean
[write-only]Implementation
public function set showControls(value:Boolean):void
titleBarOverlay | property |
public var titleBarOverlay:Canvas
Invisible shape laid over titlebar to prevent funkiness from clicking in title textfield. Making it public gives child components like controls container access to size of titleBar.
winContextMenu | property |
public var winContextMenu:ContextMenu = null
Window's context menu.
windowControls | property |
windowControls:MDIWindowControlsContainer
[read-write]Reference to class used to create windowControls property.
Implementation public function get windowControls():MDIWindowControlsContainer
public function set windowControls(value:MDIWindowControlsContainer):void
windowManager | property |
public var windowManager:MDIManager
Reference to MDIManager instance this window is managed by, if any.
windowStyleName | property |
windowStyleName:Object
[read-write]Implementation
public function get windowStyleName():Object
public function set windowStyleName(value:Object):void
MDIWindow | () | constructor |
public function MDIWindow()
Constructor
close | () | method |
public function close(event:MouseEvent = null):void
Close the window.
Parametersevent:MouseEvent (default = null )
|
createChildren | () | method |
protected override function createChildren():void
Create resize handles and window controls.
getSelectorList | () | method |
protected function getSelectorList():Array
Returns
Array |
getTitleIconObject | () | method |
public function getTitleIconObject():DisplayObject
Returns reference to titleIconObject which is mx_internal by default. Provided to allow MDIWindowControlsContainer subclasses as much freedom as possible.
ReturnsDisplayObject |
getTitleTextField | () | method |
public function getTitleTextField():UITextField
Returns reference to titleTextField which is protected by default. Provided to allow MDIWindowControlsContainer subclasses as much freedom as possible.
ReturnsUITextField |
maximize | () | method |
public function maximize():void
Maximize the window.
maximizeRestore | () | method |
public function maximizeRestore(event:MouseEvent = null):void
Called from maximize/restore button
Parametersevent:MouseEvent (default = null )
|
MouseEvent |
minimize | () | method |
public function minimize(event:MouseEvent = null):void
Minimize the window.
Parametersevent:MouseEvent (default = null )
|
restore | () | method |
public function restore():void
Restores the window to its last floating position.
restoreStyle | () | method |
public function restoreStyle():void
Restores style settings for restore and maximize
saveStyle | () | method |
public function saveStyle():void
Save style settings for minimizing.
styleChanged | () | method |
public override function styleChanged(styleProp:String):void
Detects change to styleName that is executed by MDIManager indicating a change in focus. Iterates over window controls and adjusts their styles if they're focus-aware.
ParametersstyleProp:String |
unMinimize | () | method |
public function unMinimize(event:MouseEvent = null):void
Restore window to state it was in prior to being minimized.
Parametersevent:MouseEvent (default = null )
|
updateContextMenu | () | method |
public function updateContextMenu():void
updateDisplayList | () | method |
protected override function updateDisplayList(w:Number, h:Number):void
Position and size resize handles and window controls.
Parametersw:Number |
|
h:Number |
close | event |
drag | event |
dragEnd | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the window stops being dragged.
dragStart | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the window starts being dragged.
focusEnd | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the window loses focus and no longer has topmost z-index of MDIManager's children.
focusStart | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the window gains focus and is given topmost z-index of MDIManager's children.
maximize | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the maximize button is clicked or when the window is in a normal state (not minimized or maximized) and the titleBar is double clicked.
minimize | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the minimize button is clicked.
resize | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched while the mouse is down on a resize handle.
resizeEnd | event |
flexlib.mdi.events.MDIWindowEvent
Dispatched when the mouse is released from a resize handle.
resizeStart | event |
restore | event |
flexlib.mdi.events.MDIWindowEvent
If the window is minimized, this event is dispatched when the titleBar is clicked. If the window is maxmimized, this event is dispatched upon clicking the restore button or double clicking the titleBar.
CONTEXT_MENU_LABEL_CLOSE | constant |
public static const CONTEXT_MENU_LABEL_CLOSE:String = "Close"
CONTEXT_MENU_LABEL_MAXIMIZE | constant |
public static const CONTEXT_MENU_LABEL_MAXIMIZE:String = "Maximize"
CONTEXT_MENU_LABEL_MINIMIZE | constant |
public static const CONTEXT_MENU_LABEL_MINIMIZE:String = "Minimize"
CONTEXT_MENU_LABEL_RESTORE | constant |
public static const CONTEXT_MENU_LABEL_RESTORE:String = "Restore"