public class nUIWindowDisplay extends nUIDisplayObject
Modifier and Type | Field and Description |
---|---|
static int |
SV_LEFT
A position constant for side view indicating the left side.
|
static int |
SV_RIGHT
A position constant for side view indicating the right side.
|
static int |
SV_STYLE_BELOW
A style for side view indicating the side view is located below the window.
|
static int |
SV_STYLE_OVER
A style for a side view indicating the side view is located over the window.
|
COLOR_BACKGROUND_NORMAL, COLOR_BLACK, COLOR_FOREGROUND_DARK, COLOR_FOREGROUND_LIGHT, COLOR_FOREGROUND_NORMAL, COLOR_TRANSPARENT, COLOR_WHITE, DIMENSIONS_IDENTIFIER_PARENT_DIMENSIONS
Constructor and Description |
---|
nUIWindowDisplay() |
nUIWindowDisplay(java.util.Hashtable properties) |
Modifier and Type | Method and Description |
---|---|
IGlobalPropertiesAndroid |
getAndroidGlobalProperties()
Retruns an interface to set some Android specific properties.
|
static int |
getDefaultSideViewPosition()
Returns the default side view position for the current platform.
|
static int |
getDefaultSideViewStyle()
Returns the default side view style for the current platform.
|
int |
getInnerX()
Space between the value of getX() and the internal bounding box of this window.
|
IGlobalPropertiesIOS |
getIOSGlobalProperties()
Retruns an interface to set some iOS specific properties.
|
int[] |
getPaneDimensions(int pane) |
void |
hideSideView(int aPosition)
Closes a side view at the given position.
|
boolean |
insertAt(int index,
nUIObject to_add)
Insert a nUIObject as a child of this one, at the given index.
|
boolean |
isSideViewSet(int aPosition)
Checks if a side view is set at the given position.
|
boolean |
isSideViewVisible()
Checks if a side view is visible(open).
|
boolean |
isSideViewVisible(int aPosition)
Checks if a side view is visible(open) at the given position.
|
int |
numPanes() |
void |
registerSideViewListener(ISideViewListener listener)
Nominate a class to recieve events related to the Side Views.
|
void |
resetSideView(int aPosition)
Removes a side view from the left or right side, so that it cannot be open.
|
void |
setFullscreen(boolean fullscreen) |
void |
setPaneDimensions(int pane,
int[] dimensions)
Deprecated.
use
setPaneDimensions(int, int[], String) instead. |
void |
setPaneDimensions(int pane,
int[] dimensions,
java.lang.String elementIdentifier)
Takes a copy of the supplied x/y/w/h dimensions and records them for this pane, along with an identifying name.
|
void |
setPaneIdentifier(int pane,
java.lang.String elementIdentifier)
Sets an identifier for an already existing pane.
|
void |
setSideView(float aWidth,
nUIViewDisplay aView)
Sets a side view at the the default position with the default style.
|
void |
setSideView(float aWidth,
nUIViewDisplay aView,
int aPosition,
int aStyle)
Sets a side view at the given position with the given style.
|
void |
showSideView(int aLocation)
Opens a side view at the given position.
|
void |
transitionFrom(nUIViewDisplay view)
Transition from an old view, with effect (DIS)"APPEAR" and default pane
|
void |
transitionFrom(nUIViewDisplay view,
int transition)
Transition from an old view, with default pane
|
void |
transitionFrom(nUIViewDisplay view,
int transition,
int pane)
Transition from an old view
|
void |
transitionTo(nUIViewDisplay view)
Transition to a new view, with effect "APPEAR" and in default pane
|
void |
transitionTo(nUIViewDisplay view,
int transition)
Transition to a new view, with default pane
|
void |
transitionTo(nUIViewDisplay view,
int transition,
int pane)
Transition to a new view
|
getBackgroundDrawable, getBottom, getElementIdentifier, getFocusable, getGesturable, getHeight, getInnerHeight, getInnerWidth, getInnerY, getLeft, getMaxChildX, getMaxChildY, getProperties, getProperty, getRight, getScreenInnerX, getScreenInnerY, getScreenX, getScreenY, getTop, getTopLevelParentView, getTopLevelParentWindow, getTriggerable, getWidth, getX, getY, insertAtInternal, isEnabled, isVisible, onRemoved, remove, setBackgroundDrawable, setBottom, setElementIdentifier, setEnabled, setFocusable, setGesturable, setHeight, setInnerHeight, setInnerWidth, setInnerX, setInnerY, setLeft, setProperties, setProperty, setRight, setTop, setTriggerable, setVisible, setWidth, setX, setY
add, addEventListener, childElementAt, childIndexOf, getFirstChild, getId, getLastChild, getNextSibling, getParent, getPrevSibling, getTag, insertAfter, insertBefore, outputChildHierarchy, remove, removeEventListener, replace, replace, setId, setTag, setUnlinkChildrenOnRemoval
public static final int SV_LEFT
public static final int SV_RIGHT
public static final int SV_STYLE_OVER
public static final int SV_STYLE_BELOW
public nUIWindowDisplay()
public nUIWindowDisplay(java.util.Hashtable properties)
public static int getDefaultSideViewPosition()
public static int getDefaultSideViewStyle()
SV_STYLE_BELOW
or SV_STYLE_OVER
.public void registerSideViewListener(ISideViewListener listener)
null
may be used to remove the current listener.listener
- a class conforming to ISideViewListener.public void resetSideView(int aPosition)
aPosition
- - which side view to remove, SV_LEFT
or SV_RIGHT
public void setSideView(float aWidth, nUIViewDisplay aView)
showSideView(int)
method.aWidth
- - width of the side view. The range (0, 1.0) will be used as percentage of the screen width,
the values greater than 1.0 will be cobsidered as absolute width in pixels.aView
- - view to be displayed by calling showSideView(int)
method.public void setSideView(float aWidth, nUIViewDisplay aView, int aPosition, int aStyle)
showSideView(int)
method.aWidth
- - width of the side view. The range (0, 1.0) will be used as percentage of the screen width,
the values greater than 1.0 will be cobsidered as absolute width in pixels.aView
- - view to be displayed by calling showSideView(int)
method.
Passing null
removes the previous set side view for the given position.aPosition
- - position of the given side view. It can be SV_LEFT
or SV_RIGHT
.aStyle
- - style of the given side view. it can be SV_STYLE_BELOW
or SV_STYLE_OVER
.public void hideSideView(int aPosition)
public boolean isSideViewSet(int aPosition)
public boolean isSideViewVisible(int aPosition)
public boolean isSideViewVisible()
true
if a side view is open, otherwise false
.public void showSideView(int aLocation)
public boolean insertAt(int index, nUIObject to_add)
public void setFullscreen(boolean fullscreen)
public int getInnerX()
getInnerX
in class nUIDisplayObject
public void transitionTo(nUIViewDisplay view, int transition, int pane)
view
- The view to transition totransition
- The transition effect to usepane
- The pane of this window the view should appear in (-1 if none)public void transitionTo(nUIViewDisplay view, int transition)
view
- The view to transition totransition
- The transition effect to usepublic void transitionTo(nUIViewDisplay view)
view
- The view to transition topublic void transitionFrom(nUIViewDisplay view, int transition, int pane)
view
- The view to transition fromtransition
- The transition effect to usepane
- The pane of this window the view should appear in (-1 if none)public void transitionFrom(nUIViewDisplay view, int transition)
view
- The view to transition fromtransition
- The transition effect to usepublic void transitionFrom(nUIViewDisplay view)
view
- The view to transition frompublic void setPaneDimensions(int pane, int[] dimensions)
setPaneDimensions(int, int[], String)
instead.pane
- dimensions
- int[4] array supplying x, y, w, h in pixel coordinatespublic void setPaneDimensions(int pane, int[] dimensions, java.lang.String elementIdentifier)
pane
- dimensions
- int[4] array supplying x, y, w, h in pixel coordinateselementIdentifier
- an identifier for this pane that can be used to locate it within the UI hierarchy. Passing null
gives the default behaviour from previous releases.public void setPaneIdentifier(int pane, java.lang.String elementIdentifier)
pane
- the number of the pane to identifyelementIdentifier
- an identifier for this pane that can be used to locate it within the UI hierarchy. Passing null
gives the default behaviour from previous releases.public int numPanes()
public int[] getPaneDimensions(int pane)
public IGlobalPropertiesIOS getIOSGlobalProperties()
public IGlobalPropertiesAndroid getAndroidGlobalProperties()