org.luwrain.core

Interface Luwrain

All Superinterfaces:

PropertiesBase

public interface Luwrain
extends PropertiesBase

The main bridge for applications and extensions purposed for communication with LUWRAIN core. This class is a central object to be used by applications and extensions to call system routines. Applications and extensions never have the access with the level deeper than this class. The packages like org.luwrain.controls or org.luwrain.popups always wrap the instance of Luwrain class (meaning, are unable to give more access to system core than provided with given instance of Luwrain class).

The core creates new instance of this class for each newly launched application or loaded extension. Therefore, the environment is always aware which application oor extension has issued the particular request. Applications get the object associated with them through onLaunch() method. Extensions get the corresponding instance through the argument for the methods they override (it is always the same instance provided this way just for convenience). Everybody is encouraged to keep provided instance in secret.

It could be slightly confusing that the extension and the applications launched by this extension get different instances of Luwrain class, but it's necessary to distinguish multiple instances of the particular application (while an extension can be loaded only once).

Various instance of Luwrain class may provide different level of access. It is necessary to make extensions using more accurate and transparent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Luwrain.AreaAttr
static class	Luwrain.AreaTextType
static class	Luwrain.HookStrategy
static class	Luwrain.JobFlags
static class	Luwrain.MessageType
static class	Luwrain.SpeakableTextType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DIR_DATA
static java.lang.String	PROP_DIR_JS
static java.lang.String	PROP_DIR_USERHOME

Method Summary

Modifier and Type	Method and Description
void	announceActiveArea()
void	announcement(java.lang.String text, java.lang.String announcementClass, java.lang.String announcementSubclass)
java.lang.Object	callUiSafely(java.util.concurrent.Callable callable)
void	closeApp()
void	crash(org.luwrain.app.crash.App app)
ScriptCallable	createScriptCallable(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> objs, java.lang.String dataDir)
void	executeBkg(java.util.concurrent.FutureTask task)
java.lang.String	getActiveAreaAttr(Luwrain.AreaAttr attr)
java.lang.String	getActiveAreaText(Luwrain.AreaTextType type, boolean issueErrorMessage)
java.lang.String[]	getAllShortcutNames()
java.nio.file.Path	getAppDataDir(java.lang.String appName) Returns a path to the directory where the application may safely store its auxiliary data.
int	getAreaVisibleHeight(Area area)
int	getAreaVisibleWidth(Area area)
Clipboard	getClipboard()
CmdLine	getCmdLine()
MediaResourcePlayer[]	getMediaResourcePlayers()
Player	getPlayer()
Registry	getRegistry()
int	getScreenHeight()
int	getScreenWidth()
ScriptFile[]	getScriptFilesList(java.lang.String componentName)
java.lang.String	getSpeakableText(java.lang.String text, Luwrain.SpeakableTextType type)
UniRefInfo	getUniRefInfo(java.lang.String uniRef)
I18n	i18n()
void	launchApp(java.lang.String shortcutName)
void	launchApp(java.lang.String shortcutName, java.lang.String[] args)
java.lang.String	loadScriptExtension(java.lang.String text)
Channel	loadSpeechChannel(java.lang.String engineName, java.lang.String params)
void	message(java.lang.String text)
void	message(java.lang.String text, Luwrain.MessageType messageType)
void	message(java.lang.String text, Sounds sound)
Job.Instance	newJob(java.lang.String name, java.lang.String[] args, java.lang.String dir, java.util.Set<Luwrain.JobFlags> flags, Job.Listener listener)
void	onAreaNewBackgroundSound(Area area)
void	onAreaNewContent(Area area) Notifies the environment that the area gets new content.
void	onAreaNewHotPoint(Area area) Notifies the environment that the area gets new position of the hot point.
void	onAreaNewName(Area area) Notifies the environment that the area gets new name.
void	onNewAreaLayout()
void	openFile(java.lang.String fileName)
void	openFiles(java.lang.String[] fileNames)
boolean	openHelp(java.lang.String sectName)
boolean	openUniRef(java.lang.String uniRef)
boolean	openUniRef(UniRefInfo uniRefInfo)
boolean	openUrl(java.lang.String url)
void	playSound(Sounds sound) /** Plays one of the system sounds.
void	popup(Popup popup)
boolean	registerExtObj(ExtensionObject extObj) Registers new extension object.
boolean	runCommand(java.lang.String command)
java.lang.Object	runLaterSync(java.util.concurrent.Callable callable)
java.util.concurrent.Callable	runScriptInFuture(Context context, java.io.File dataDir, java.lang.String text)
void	runUiSafely(java.lang.Runnable runnable)
boolean	runWorker(java.lang.String workerName)
void	sendBroadcastEvent(SystemEvent event)
void	sendInputEvent(InputEvent event)
void	setActiveArea(Area area) Sets the new active area of the application.
void	setEventResponse(EventResponse eventResponse)
void	showGraphical(Interaction.GraphicalMode graphicalMode)
void	silence()
void	speak(java.lang.String text)
void	speak(java.lang.String text, int pitch)
void	speak(java.lang.String text, int pitch, int rate)
void	speak(java.lang.String text, Sounds sound)
void	speakLetter(char letter)
void	speakLetter(char letter, int pitch)
void	speakLetter(char letter, int pitch, int rate)
java.lang.String	staticStr(org.luwrain.i18n.LangStatic id)
java.lang.String	suggestContentType(java.io.File file, ContentTypes.ExpectedType expectedType)
java.lang.String	suggestContentType(java.net.URL url, ContentTypes.ExpectedType expectedType)
boolean	unloadDynamicExtension(java.lang.String extId)
boolean	xCreatePropertyHook(java.lang.String propName, java.lang.String hookName)
void	xExecScript(java.io.File dataDir, java.lang.String text)
java.lang.String[]	xGetLoadedSpeechFactories()
OsInterface	xGetOsInterface()
int	xGetSpeechPitch()
int	xGetSpeechRate()
boolean	xQuit()
boolean	xRunHooks(java.lang.String hookName, java.lang.Object[] args, Luwrain.HookStrategy strategy)
void	xSetSpeechPitch(int value)
void	xSetSpeechRate(int value)

Methods inherited from interface org.luwrain.core.PropertiesBase

getFileProperty, getProperty

Field Detail

PROP_DIR_DATA

static final java.lang.String PROP_DIR_DATA

See Also:

Constant Field Values

PROP_DIR_JS

static final java.lang.String PROP_DIR_JS

See Also:

Constant Field Values

PROP_DIR_USERHOME

static final java.lang.String PROP_DIR_USERHOME

See Also:

Constant Field Values

Method Detail

announceActiveArea

void announceActiveArea()

callUiSafely

java.lang.Object callUiSafely(java.util.concurrent.Callable callable)

closeApp

void closeApp()

crash

void crash(org.luwrain.app.crash.App app)

announcement

void announcement(java.lang.String text,
                  java.lang.String announcementClass,
                  java.lang.String announcementSubclass)

getActiveAreaAttr

java.lang.String getActiveAreaAttr(Luwrain.AreaAttr attr)

getActiveAreaText

java.lang.String getActiveAreaText(Luwrain.AreaTextType type,
                                   boolean issueErrorMessage)

getAllShortcutNames

java.lang.String[] getAllShortcutNames()

getAppDataDir

java.nio.file.Path getAppDataDir(java.lang.String appName)

Returns a path to the directory where the application may safely store its auxiliary data. The returned directory, if it it isn't null, always exists and always belongs to the current user. Meaning, different users get different directories for the same application. Application must be identified with some short string. We discourage using application names starting with "luwrain.", because such names are usually used by the applications from LUWRAIN standard distribution.

Parameters:

appName - A short string for application identification, the same application name will result in the same directory

Returns:

The application data directory or null if the directory cannot be created

getAreaVisibleHeight

int getAreaVisibleHeight(Area area)

getAreaVisibleWidth

int getAreaVisibleWidth(Area area)

getClipboard

Clipboard getClipboard()

getCmdLine

CmdLine getCmdLine()

xGetLoadedSpeechFactories

java.lang.String[] xGetLoadedSpeechFactories()

getMediaResourcePlayers

MediaResourcePlayer[] getMediaResourcePlayers()

getPlayer

Player getPlayer()

getRegistry

Registry getRegistry()

getScreenWidth

int getScreenWidth()

getScreenHeight

int getScreenHeight()

getUniRefInfo

UniRefInfo getUniRefInfo(java.lang.String uniRef)

executeBkg

void executeBkg(java.util.concurrent.FutureTask task)

i18n

I18n i18n()

launchApp

void launchApp(java.lang.String shortcutName)

launchApp

void launchApp(java.lang.String shortcutName,
               java.lang.String[] args)

loadScriptExtension

java.lang.String loadScriptExtension(java.lang.String text)
                              throws ExtensionException

Throws:

ExtensionException

loadSpeechChannel

Channel loadSpeechChannel(java.lang.String engineName,
                          java.lang.String params)
                   throws SpeechException

Throws:

SpeechException

message

void message(java.lang.String text)

message

void message(java.lang.String text,
             Luwrain.MessageType messageType)

message

void message(java.lang.String text,
             Sounds sound)

onAreaNewBackgroundSound

void onAreaNewBackgroundSound(Area area)

onAreaNewHotPoint

void onAreaNewHotPoint(Area area)

Notifies the environment that the area gets new position of the hot point. This method causes updating of the visual position of the hot point on the screen for low vision users. Please keep in mind that this method doesn't produce any speech announcement of the new position and you should do that on your own, depending on the behaviour of your application.

Parameters:

area - The area which gets new position of the hot point

onAreaNewContent

void onAreaNewContent(Area area)

Notifies the environment that the area gets new content. This method causes updating of the visual representation of the area content on the screen for low vision users. Please keep in mind that this method doesn't produce any speech announcement of the changes and you should do that on your own, depending on the behaviour of your application.

Parameters:

area - The area which gets new content

onAreaNewName

void onAreaNewName(Area area)

Notifies the environment that the area gets new name. This method causes updating of the visual title of the area on the screen for low vision users. Please keep in mind that this method doesn't produce any speech announcement of name changes and you should do that on your own, depending on the behaviour of your application.

Parameters:

area - The area which gets new name

onNewAreaLayout

void onNewAreaLayout()

openFile

void openFile(java.lang.String fileName)

openFiles

void openFiles(java.lang.String[] fileNames)

openHelp

boolean openHelp(java.lang.String sectName)

openUniRef

boolean openUniRef(java.lang.String uniRef)

openUniRef

boolean openUniRef(UniRefInfo uniRefInfo)

openUrl

boolean openUrl(java.lang.String url)

playSound

void playSound(Sounds sound)

/** Plays one of the system sounds. This method takes an identifier of the system sound, stops any previous playing, if there was any, and plays. The exact sound is selected depending on user's settings. Please node that sounds playing isn't interfering with speech.

Parameters:

sound - The identifier of the sound to play

popup

void popup(Popup popup)

registerExtObj

boolean registerExtObj(ExtensionObject extObj)

Registers new extension object. This operation is allowed for highly privileged interfaces only, what, for example, can be useful for custom startup and shutdown procedures. Custom objects may be of any kind, they are registered as they would be a part of the core.

Parameters:

extObj - The object to register

Returns:

True if the object was successfully registered, false otherwise

Throws:

java.lang.RuntimeException - on any attempt to do this operation without enough privileged level

runCommand

boolean runCommand(java.lang.String command)

newJob

Job.Instance newJob(java.lang.String name,
                    java.lang.String[] args,
                    java.lang.String dir,
                    java.util.Set<Luwrain.JobFlags> flags,
                    Job.Listener listener)

runLaterSync

java.lang.Object runLaterSync(java.util.concurrent.Callable callable)

runScriptInFuture

java.util.concurrent.Callable runScriptInFuture(Context context,
                                                java.io.File dataDir,
                                                java.lang.String text)

createScriptCallable

ScriptCallable createScriptCallable(java.lang.String text,
                                    java.util.Map<java.lang.String,java.lang.Object> objs,
                                    java.lang.String dataDir)

runUiSafely

void runUiSafely(java.lang.Runnable runnable)

runWorker

boolean runWorker(java.lang.String workerName)

speak

void speak(java.lang.String text)

speak

void speak(java.lang.String text,
           Sounds sound)

speakLetter

void speakLetter(char letter)

speak

void speak(java.lang.String text,
           int pitch)

speak

void speak(java.lang.String text,
           int pitch,
           int rate)

speakLetter

void speakLetter(char letter,
                 int pitch)

sendBroadcastEvent

void sendBroadcastEvent(SystemEvent event)

sendInputEvent

void sendInputEvent(InputEvent event)

setActiveArea

void setActiveArea(Area area)

Sets the new active area of the application. This method asks the environment to choose another visible area as an active area of the application. This operation is applicable only to regular areas, not for popup areas, for which it is pointless. In contrast to onAreaNewHotPoint(), onAreaNewName() and onAreaNewContent() methods, this one produces proper introduction of the area being activated.

Parameters:

area - The area to choose as an active

setEventResponse

void setEventResponse(EventResponse eventResponse)

silence

void silence()

speakLetter

void speakLetter(char letter,
                 int pitch,
                 int rate)

staticStr

java.lang.String staticStr(org.luwrain.i18n.LangStatic id)

suggestContentType

java.lang.String suggestContentType(java.net.URL url,
                                    ContentTypes.ExpectedType expectedType)

getSpeakableText

java.lang.String getSpeakableText(java.lang.String text,
                                  Luwrain.SpeakableTextType type)

suggestContentType

java.lang.String suggestContentType(java.io.File file,
                                    ContentTypes.ExpectedType expectedType)

unloadDynamicExtension

boolean unloadDynamicExtension(java.lang.String extId)

xExecScript

void xExecScript(java.io.File dataDir,
                 java.lang.String text)

xQuit

boolean xQuit()

xSetSpeechRate

void xSetSpeechRate(int value)

xGetSpeechRate

int xGetSpeechRate()

xGetSpeechPitch

int xGetSpeechPitch()

xSetSpeechPitch

void xSetSpeechPitch(int value)

xRunHooks

boolean xRunHooks(java.lang.String hookName,
                  java.lang.Object[] args,
                  Luwrain.HookStrategy strategy)

xGetOsInterface

OsInterface xGetOsInterface()

xCreatePropertyHook

boolean xCreatePropertyHook(java.lang.String propName,
                            java.lang.String hookName)

showGraphical

void showGraphical(Interaction.GraphicalMode graphicalMode)

getScriptFilesList

ScriptFile[] getScriptFilesList(java.lang.String componentName)