public class EnvProps extends PropCnr
The property also handles the capabilities of the client.
The environment has at least the following properties:
Modifier and Type | Class and Description |
---|---|
static class |
EnvProps.ClientCapability
Capabilities of a Client.
|
Modifier and Type | Field and Description |
---|---|
protected StringMapProp |
clientEnv
The client environment properties.
|
protected GeoProps |
geoProps
The Geolocation properties.
|
protected StringMapProp |
serverEnv
The server environment properties.
|
EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE
Modifier | Constructor and Description |
---|---|
protected |
EnvProps()
Creates the environment properties without a name.
|
|
EnvProps(Atom atom)
Creates the environment properties with a name.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addPredefinedProps()
Adds the predefined properties for this container.
|
boolean |
addScreenOrientationListener(IScreenOrientationListener listener)
Adds a screen orientation listener for the client session.
|
boolean |
addScreenSizeListener(IScreenSizeListener listener)
Adds a screen size listener for the client session.
|
boolean |
addStatusBarTapListener(IStatusBarTapListener listener)
Adds a status bar tap listener for the client session.
|
EnvProps |
clone()
Clones the environment properties.
|
boolean |
configureStatusBar(StatusBarConfig config)
Sets the client sessions status bar to the configuration specified.
|
<TYPE> TYPE |
getCachedValue(String name,
Class<TYPE> valueClass)
Gets a cached property of a certain type.
|
StringMapProp |
getClientEnv()
Gets the client environment properties.
|
IClientSessionGyro |
getClientSessionGyro()
Gets the client session gyro instance.
|
String |
getDeviceUUID()
Gets the device UUID.
|
String |
getDeviceUUID(boolean mustBeValid)
Gets the device UUID.
|
double |
getDPR()
The device pixel ratio of the client.
|
GeoProps |
getGeolocation()
Gets the Geolocation properties.
|
String |
getLanguageCode()
Gets the language code to use.
|
LocaleInfo |
getLocale()
Gets the client local info class instance.
|
ua_parser.Client |
getParsedUserAgent()
Gets the parsed user agent instance.
|
protected void |
getPredefinedProps()
Gets potential references to predefined properties for this container.
|
int |
getScreenHeight()
Gets the current screen height.
|
ScreenOrientation |
getScreenOrientation()
Gets the current screen orientation.
|
Size |
getScreenSize()
Gets the current screen size.
|
int |
getScreenWidth()
Gets the current screen width.
|
StringMapProp |
getServerEnv()
Gets the server environment properties.
|
SpeechRecognitionProp |
getSpeechRecognition()
Gets the speech recognition instance.
|
SpeechSynthesisProp |
getSpeechSynthesis()
Gets the speech synthesis instance.
|
boolean |
hasClientCapabilities(EnvProps.ClientCapability capability)
Checks if a client has the specified capabilities.
|
boolean |
iiziRunPresent()
Checks if iiziRun is present.
|
boolean |
isScreenOrientationLockSupported()
Checks if screen orientation locking is supported or not.
|
void |
onEventSelf(GEvent event)
Called when a property event is send to this property.
|
void |
onRemoteEvent(RemoteEvent event)
Called when a remote property event should be processed by this property.
|
IRemoteSessionControl |
registerSession(IClientSessionGyro clientGyro,
IRemoteSessionControlListener listener)
Assigns the application session control listener.
|
boolean |
removeScreenOrientationListener(IScreenOrientationListener listener)
Removes a screen orientation listener for the client session.
|
boolean |
removeScreenSizeListener(IScreenSizeListener listener)
Removes a screen size listener for the client session.
|
boolean |
removeStatusBarTapListener(IStatusBarTapListener listener)
Removes a status bar tap listener for the client session.
|
void |
setCachedValue(String name,
Object value)
Sets a cached property by name.
|
LocaleInfo |
setLocale(LocaleInfo locale)
Changes or sets the LocaleInfo for the environment.
|
boolean |
setScreenOrientation(ScreenOrientation orientation)
Locks the screen orientation.
|
protected boolean |
shouldSerializeToXML(int programType)
The EnvProps are never written to XML.
|
boolean |
unlockScreenOrientation()
Unlocks the screen orientation.
|
__transferChildProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning
getClass, hashCode, notify, notifyAll, wait, wait, wait
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning
protected StringMapProp clientEnv
protected GeoProps geoProps
protected StringMapProp serverEnv
protected EnvProps()
public EnvProps(Atom atom)
atom
- The atom name.public IClientSessionGyro getClientSessionGyro()
getClientSessionGyro
in interface IGProp<GProp<?>[]>
getClientSessionGyro
in class GProp<GProp<?>[]>
protected boolean shouldSerializeToXML(int programType)
shouldSerializeToXML
in class GProp<GProp<?>[]>
programType
- From PropFactory.getProgramType():
0=PropFactory.CLIENT
, 1=PropFactory.SERVER
or 2=PropFactory.EDITOR
.protected void addPredefinedProps() throws PropException
Properties added:
- client environment StringMapProp Atom.A_CLIENT - server environment StringMapProp Atom.A_SERVER
addPredefinedProps
in class PropCnr
PropException
- for property exceptions.protected void getPredefinedProps()
The method should get reference to using the getProp(...)
methods.
This allows the subclass to be able to retrieve the new instances to the properties created
during addPredefinedProps()
if stored in instance variables.
getPredefinedProps
in class PropCnr
public StringMapProp getServerEnv()
public StringMapProp getClientEnv()
public boolean iiziRunPresent()
public GeoProps getGeolocation()
public SpeechSynthesisProp getSpeechSynthesis()
public SpeechRecognitionProp getSpeechRecognition()
public LocaleInfo getLocale()
public LocaleInfo setLocale(LocaleInfo locale) throws PropTypeException
Note that this change does not fire any refresh to the client property tree,
use the
instead.IClientSessionGyro.setLocale(LocaleInfo)
locale
- localeInfo The locale information to use.PropTypeException
- If the property is read-only.public double getDPR()
public String getLanguageCode()
public void setCachedValue(String name, Object value)
name
- The name.value
- An object.public <TYPE> TYPE getCachedValue(String name, Class<TYPE> valueClass)
name
- The name.valueClass
- The value class to retrieve.public boolean hasClientCapabilities(EnvProps.ClientCapability capability)
capability
- The capability to query.public ua_parser.Client getParsedUserAgent() throws Exception
Exception
- An exception due to failure in performing the test, with a message why it failed.public IRemoteSessionControl registerSession(IClientSessionGyro clientGyro, IRemoteSessionControlListener listener)
This method is only intended for the framework and will throw an error if called.
clientGyro
- The client gyro instance.listener
- The control listener.IllegalStateException
- If not called from the framework.public void onRemoteEvent(RemoteEvent event)
A subclass can override this method to perform appropriate processing and is
not required to call super.onRemoteEvent(e)
.
The onRemoteEvent is NOT called when in a proxied property container, but rather the normal onEventSelf method.
onRemoteEvent
in interface IGProp<GProp<?>[]>
onRemoteEvent
in class GProp<GProp<?>[]>
event
- The remote event.public void onEventSelf(GEvent event)
A subclass can override this method to perform appropriate processing and is
not required to call super.onEventSelf(e)
.
onEventSelf
in interface IGProp<GProp<?>[]>
onEventSelf
in class GProp<GProp<?>[]>
event
- The property event.public boolean addScreenSizeListener(IScreenSizeListener listener)
listener
- The listener to add.NullPointerException
- If the listener is null
.public boolean removeScreenSizeListener(IScreenSizeListener listener)
listener
- The listener to remove.public int getScreenWidth()
public int getScreenHeight()
public Size getScreenSize()
public boolean addScreenOrientationListener(IScreenOrientationListener listener)
listener
- The listener to add.NullPointerException
- If the listener is null
.public boolean removeScreenOrientationListener(IScreenOrientationListener listener)
listener
- The listener to remove.public boolean isScreenOrientationLockSupported()
public ScreenOrientation getScreenOrientation()
ScreenOrientation.unknown
if not supported.public boolean setScreenOrientation(ScreenOrientation orientation)
Note that there may be a delay in the orientation change after calling this method. This could be due to slow client connection, disconnected client or just due to device lag.
orientation
- The orientation.IllegalArgumentException
- If orientation
is ScreenOrientation.unknown
.public boolean unlockScreenOrientation()
Note that there may be a delay in the orientation change after calling this method. This could be due to slow client connection, disconnected client or just due to device lag.
public String getDeviceUUID()
unknown
otherwise. It is always "browser" for browsers.public String getDeviceUUID(boolean mustBeValid)
mustBeValid
- Flag requiring device UUID to be from a valid device, otherwise null is returned.
When flag is false,mustBeValid
is false unknown
otherwise.
It is always "browser" for browsers when mustBeValid
is false. When
mustBeValid
is true, null is returned.public boolean configureStatusBar(StatusBarConfig config)
Note: this only works on devices using iiziRun.
config
- The configuration.public boolean addStatusBarTapListener(IStatusBarTapListener listener)
Status bar tap events are only fired for devices using iiziRun with status bars available, using iOS devices.
listener
- The listener to add.NullPointerException
- If the listener is null
.public boolean removeStatusBarTapListener(IStatusBarTapListener listener)
listener
- The listener to remove.iizi® is a registered trademark of Mindus SARL. © Copyright Mindus SARL, 2020. All rights reserved.