IRWindow

it.unipmn.di.Meeting.UIObjects.RWindow.IRWindow
it.unipmn.di.Meeting.UIObjects.RWindow.RWindow

The IRWindow interface allows a component to communicate with the window containing it.

L’interfaccia IRWindow permette al componente di comunicare con la finestra che lo contiene.

Summary
IRWindowThe IRWindow interface allows a component to communicate with the window containing it.
Functions
addEventListenerAdds a listener for a given event.
newErrorGenerates an error message and shows it in the popup area if the popup argument is True.
pushStatusBarMessageAdds a message in the window status bar.
popStatusBarMessageRemoves the last message from the window status bar.
needToHideContentOnMoveSays if the content is hidden while moving the window.
needToHideContentOnResizeSays if the content is hidden while resizing the window.
hideHides the window and its content.
hideContentHides only the window content.
showContentIt is the opposite of hideContent.
showIt is the opposite of hide.
getTitleReturns the window title.
isTrasparentReturns True if the window is transparent.
getTrasparentReturns True if the window is transparent.
setTrasparentSets the window transparence.
getWindowStyleReturns the window style.
setWindowStyleSets the window style.
getStateReturns the current window state.
setStateSets the window state.
getTypeNOT YET IMPLEMENTED
setTypeNOT YET IMPLEMENTED
setFocusGives the current focus to this window.
getSizeReturns the window size.
getLastPositionReturns the last window position.
setLastPositionSets the window position
getPositionReturns the current window position.
setUrgencyHintSets the window blink.
setFullscreenMakes the window the only one visible on the screen, removing status bar or something.
setPositionMoves the window to the specified position.
moveToMoves the window to the specified coordinates.
setSizeIt is called when the window is asked to change its size.
getMenuReturns the window menu in the standard format used by the Menu class.
setMenuSets the window menu in the standard format used by the Menu class.
closeCloses the window.

Functions

addEventListener

function addEventListener(eventType: String,
listener: Object):Void

Adds a listener for a given event.

Aggiunge un listener per un dato evento.

Parameters

eventType{String} event name / nome dell’evento
listener{Object} listener object / oggetto listener

newError

function newError(err,
popup,
level,
id):Void

Generates an error message and shows it in the popup area if the popup argument is True.

Genera un messaggio di errore e lo mostra nell’area di popup se l’argomento popup è True.

Parameters

err{String} error message / messaggio di errore
popup{Boolean} says if it has to be a popup or not
level{String} not used / non usato
id{int} not used / non usato

pushStatusBarMessage

function pushStatusBarMessage(msg: String):Void

Adds a message in the window status bar.

Aggiunge un messaggio nella status bar della finestra.

Parameter

msg{String} the message to add / il messaggio da aggiungere

popStatusBarMessage

function popStatusBarMessage():Void

Removes the last message from the window status bar.

Elimina l’ultimo messaggio dalla status bar della finestra.

needToHideContentOnMove

function needToHideContentOnMove():Boolean

Says if the content is hidden while moving the window.

Dice se il contenuto viene nascosto quando si muove la finestra.

Returns

{Boolean} True | False

needToHideContentOnResize

function needToHideContentOnResize():Boolean

Says if the content is hidden while resizing the window.

Dice se il contenuto viene nascosto quando si ridimensiona la finestra.

Returns

{Boolean} True o False

hide

function hide():Void

Hides the window and its content.

Nasconde la finestra e il suo contenuto.

hideContent

function hideContent():Void

Hides only the window content.

Useful while moving or resizing a window to avoid frequent updates of the content.

Nasconde solo il contenuto della finestra.

Utile nelle operazioni di spostamento o ridimensionamento per evitare il continuo aggiornamento del contenuto.

showContent

function showContent():Void

It is the opposite of hideContent.  It shows the window content back.

È opposto a hideContent.  Fà apparire nuovamente il contenuto della finestra.

show

function show():Void

It is the opposite of hide.  It shows back the window and its content.

È opposto a hide.  Fà apparire nuovamente la finestra ed il suo contenuto.

getTitle

function getTitle():String

Returns the window title.

Ritorna il titolo della finestra.

Returns

{String} the window title / il titolo della finestra

isTrasparent

function isTrasparent():Boolean

Returns True if the window is transparent.

Ritorna True se la finestra è trasparente.

Returns

{Boolean} True | False

See Also

getTrasparent

getTrasparent

function getTrasparent():Boolean

Returns True if the window is transparent.

Ritorna True se la finestra è trasparente.

Returns

{Boolean} True | False

See Also

isTrasparent

setTrasparent

function setTrasparent(value: Boolean):Void

Sets the window transparence.

Imposta la trasparenza della finestra.

Parameter

value{Boolean} True | False

getWindowStyle

function getWindowStyle():Object

Returns the window style.

Ritorna lo stile della finestra.

Returns

{Object} the window style / lo stile della finestra

See Also

<it.unipmn.di.Meeting.UIObjects.Style>

setWindowStyle

function setWindowStyle(newStyle: Object):Void

Sets the window style.

Imposta lo stile della finestra.

Parameter

newStyle{Object} the window style / lo stile della finestra

See Also

<it.unipmn.di.Meeting.UIObjects.IRWindow.Style>

getState

function getState():String

Returns the current window state.

Ritorna lo stato corrente della finestra.

Returns

{String} the name of the current window state / il nome dello stato corrente della finestra

setState

function setState(newState: String):Void

Sets the window state.

Imposta lo stato della finestra.

Parameter

newState{String} the name of the window state to set / il nome dello stato della finestra da impostare

getType

function getType():String

NOT YET IMPLEMENTED

NON ANCORA IMPLEMENTATO

setType

function setType(newType: String):Void

NOT YET IMPLEMENTED

NON ANCORA IMPLEMENTATO

setFocus

function setFocus():Void

Gives the current focus to this window.

Assegna il focus alla finestra.

getSize

function getSize():Size

Returns the window size.

Ritorna la dimensione della finestra.

Returns

{Size} the window size as a Size object / la dimensione della finestra come oggetto Size

See Also

<it.unipmn.it.Meeting.Utils.Size>

getLastPosition

function getLastPosition():Position

Returns the last window position.

Ritorna l’ultima posizione della finestra.

Returns

{Position} the last window position as a Position object / l’ultima posizione della finestra come oggetto Position

See Also

<it.unipmn.it.Meeting.Utils.Position>

setLastPosition

function setLastPosition(pos: Position):Void

Sets the window position

Imposta la posizione della finestra.

Parameter

pos{Position} the window position as a Position object / la posizione della finestra come oggetto Position

See Also

<it.unipmn.it.Meeting.Utils.Position>

getPosition

function getPosition():Position

Returns the current window position.

Ritorna la posizione corrente della finestra.

Returns

{Position} the current window position as a position object / la posizione corrente della finestra come oggetto Position

See Also

<it.unipmn.it.Meeting.Utils.Position>

setUrgencyHint

function setUrgencyHint(value: Boolean):Void

Sets the window blink.

Imposta il lampeggio della finestra.

Parameter

value{Boolean} True | False

setFullscreen

function setFullscreen(value: Boolean):Void

Makes the window the only one visible on the screen, removing status bar or something.

Rende la finestra l’unica visibile sullo schermo, eliminando barre di stato o altro.

Parameter

value{Boolean} True | False

setPosition

function setPosition(pos: Position):Void

Moves the window to the specified position.

Colloca la finestra alla posizione indicata.

Parameter

pos{Position} position on the screen in WindowManager coordinates / posizione nello schermo in coordinate del WindowManager

See Also

<it.unipmn.di.Meeting.Utils.Position>

moveTo

function moveTo(x: Number,
y: Number):Void

Moves the window to the specified coordinates.

Colloca la finestra alle coordinate indicate.

Parameters

x{Number} x coordinate / coordinata x
y{Number} y coordinate / coordinata y

setSize

function setSize(newWidth: Number,
newHeight: Number):Void

It is called when the window is asked to change its size.

Viene richiamato quando viene richiesta la modifica delle dimensioni della finestra.

Parameters

newWidth{Number} new width / nuova larghezza
newHeight{Number} new height / nuova altezza

getMenu

function getMenu():XML

Returns the window menu in the standard format used by the Menu class.

Ritorna il menu della finestra nel formato standard usato dalla classe Menu.

Returns

{XML} the window menu / il menu della finestra

setMenu

function setMenu(newMenu: XML):Void

Sets the window menu in the standard format used by the Menu class.

Imposta il menu della finestra nel formato standard usato per la classe Menu.

Parameter

newMenu{XML} the new window menu / il nuovo menu della finestra

close

function close():Void

Closes the window.

Chiude la finestra.

function addEventListener(eventType: String,
listener: Object):Void
Adds a listener for a given event.
function newError(err,
popup,
level,
id):Void
Generates an error message and shows it in the popup area if the popup argument is True.
function pushStatusBarMessage(msg: String):Void
Adds a message in the window status bar.
function popStatusBarMessage():Void
Removes the last message from the window status bar.
function needToHideContentOnMove():Boolean
Says if the content is hidden while moving the window.
function needToHideContentOnResize():Boolean
Says if the content is hidden while resizing the window.
function hide():Void
Hides the window and its content.
function hideContent():Void
Hides only the window content.
function showContent():Void
It is the opposite of hideContent.
function show():Void
It is the opposite of hide.
function getTitle():String
Returns the window title.
function isTrasparent():Boolean
Returns True if the window is transparent.
function getTrasparent():Boolean
Returns True if the window is transparent.
function setTrasparent(value: Boolean):Void
Sets the window transparence.
function getWindowStyle():Object
Returns the window style.
function setWindowStyle(newStyle: Object):Void
Sets the window style.
function getState():String
Returns the current window state.
function setState(newState: String):Void
Sets the window state.
function getType():String
NOT YET IMPLEMENTED
function setType(newType: String):Void
NOT YET IMPLEMENTED
function setFocus():Void
Gives the current focus to this window.
function getSize():Size
Returns the window size.
function getLastPosition():Position
Returns the last window position.
function setLastPosition(pos: Position):Void
Sets the window position
function getPosition():Position
Returns the current window position.
function setUrgencyHint(value: Boolean):Void
Sets the window blink.
function setFullscreen(value: Boolean):Void
Makes the window the only one visible on the screen, removing status bar or something.
function setPosition(pos: Position):Void
Moves the window to the specified position.
function moveTo(x: Number,
y: Number):Void
Moves the window to the specified coordinates.
function setSize(newWidth: Number,
newHeight: Number):Void
It is called when the window is asked to change its size.
function getMenu():XML
Returns the window menu in the standard format used by the Menu class.
function setMenu(newMenu: XML):Void
Sets the window menu in the standard format used by the Menu class.
function close():Void
Closes the window.