×

VCOO0012

OmniOutliner: Focus Mode

A set of commands for entering and exiting focus mode.

Scope and Syntax

Language: English (United States 🇺🇸 · Great Britain 🇬🇧 · Australia 🇦🇺 · Canada 🇨🇦)

Scope: OmniOutliner

Command phrase variations (words in [brackets] are optional):

Requirements

Video: Focus Commands
A set of commands for entering and exiting focus mode.
Video: Focus Mode
A set of commands for entering and exiting focus mode.

Downloads

Script Code

Here is the script code for the commands:

“Enter Focus Mode” • This command will enter focus mode.

Enter Focus Mode



(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource",message:"No outline document is open."}
		}

		var editor = document.editors[0]
		selectedItems = editor.selection.items
		
		if(selectedItems.length === 0){
			throw {
				name: "Selection Issue",
				message: "Please select one or more rows."
			}
		} else {
			editor.focusedItems = []
			editor.focusedItems = selectedItems
			
			utterance = createUtterance("Ready!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

“Exit Focus Mode” • This command will exit focus mode.

Exit Focus Mode



(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource",message:"No outline document is open."}
		}

		var editor = document.editors[0]
		editor.focusedItems = []
			
		utterance = createUtterance("Done!")
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

“Change Focus to Selection” • This command will exit focus mode and set the selection to the items that were focused.

Change Focus to Selection



(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource",message:"No outline document is open."}
		}

		// FOCUS TO SELECTION
		var editor = document.editors[0]
		itemIDs = editor.focusedItems.map(item => item.identifier)
		editor.focusedItems = []
		nodes = []
		itemIDs.forEach(id => {
			item = document.outline.itemWithIdentifier(id)
			nodes.push(editor.nodeForObject(item))
		})
		editor.select(nodes, false)
			
		utterance = createUtterance("Done!")
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

“Exit Focus with Retention” • This command will exit focus mode but maintain the selection of the items that were selected while focused.

Exit Focus with Retention



(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource",message:"No outline document is open."}
		}

		var editor = document.editors[0]
		var itemIDs = []
		editor.focusedItems.forEach(item => {
			node = editor.nodeForObject(item)
			if(node.isSelected){
				itemIDs.push(item.identifier)
			}
		})

		editor.focusedItems = []
		nodes = []
		itemIDs.forEach(id => {
			item = document.outline.itemWithIdentifier(id)
			nodes.push(editor.nodeForObject(item))
		})
		editor.select(nodes, false)
			
		utterance = createUtterance("Ready!")
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

 

 

 

LEGAL

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Mention of third-party websites and products is for informational purposes only and constitutes neither an endorsement nor a recommendation. OMNI-AUTOMATION.COM assumes no responsibility with regard to the selection, performance or use of information or products found at third-party websites. OMNI-AUTOMATION.COM provides this only as a convenience to our users. OMNI-AUTOMATION.COM has not tested the information found on these sites and makes no representations regarding its accuracy or reliability. There are risks inherent in the use of any information or products found on the Internet, and OMNI-AUTOMATION.COM assumes no responsibility in this regard. Please understand that a third-party site is independent from OMNI-AUTOMATION.COM and that OMNI-AUTOMATION.COM has no control over the content on that website. Please contact the vendor for additional information.