Randomness/com.fwdekker.randomness

Package-level declarations

Entry point of the plugin. Contains main classes, shared classes, and helper classes.

Types

Box

data class Box<T : Any>(val generator: () -> T, var value: T? = null)

A lazily-instantiated reference to an object of type T.

Bundle

object Bundle

Simple accessor for working with internationalized strings.

CapitalizationMode

enum CapitalizationMode(val transform: (String, Random) -> String) : Enum<CapitalizationMode>

A mode in which a word should be capitalized.

DataGenerationException

class DataGenerationException(message: String? = null, cause: Throwable? = null) : Exception

Thrown if a random datum could not be generated.

DecoratorScheme

abstract class DecoratorScheme : Scheme

Transparently extends or alters the functionality of a Scheme with a decorating function.

ErrorReporter

class ErrorReporter : ErrorReportSubmitter

A report submitter that opens a pre-filled issue creation form on Randomness' GitHub repository.

Icons

object Icons

Basic Randomness icons.

InsertAction

abstract class InsertAction(val repeat: Boolean = false, val text: String, description: String? = null, icon: Icon? = null) : AnAction

Inserts strings in the editor.

Notifier

class Notifier : StartupActivity

Displays notifications when a project is opened.

OverlayedIcon

data class OverlayedIcon(val base: Icon, val overlays: List<Icon> = emptyList()) : Icon

An icon with various icons displayed on top of it as overlays.

OverlayIcon

data class OverlayIcon(val base: Icon, val background: Icon? = null) : Icon

An overlay icon, which can be displayed on top of other icons.

PersistentSettings

class PersistentSettings : PersistentStateComponent<Element>

The persistent Settings instance, stored as an Element to allow custom conversion for backwards compatibility.

PopupAction

class PopupAction : AnAction

Shows a popup for all available Randomness actions.

RadialColorReplacementFilter

class RadialColorReplacementFilter(val colors: List<Color>, val center: Pair<Int, Int>? = null) : RGBImageFilter

Replaces all colors with one of colors depending on the angle relative to center.

Scheme

abstract class Scheme : State

A scheme is a State that is also a configurable random number generator.

SchemeEditor

abstract class SchemeEditor<S : Scheme>(val scheme: S) : Disposable

An editor for a Scheme.

Settings

data class Settings(var version: String = CURRENT_VERSION, val templateList: TemplateList = TemplateList()) : State

Contains references to various State objects.

SimpleAbstractAction

private class SimpleAbstractAction(val myActionPerformed: (ActionEvent?) -> Unit) : AbstractAction

An AbstractAction that uses myActionPerformed as the implementation of its actionPerformed method.

State

abstract class State

A state holds variables that can be configured, validated, copied, and loaded.

Timely

object Timely

Functions relating to time-limited behavior.

TypeIcon

data class TypeIcon(val base: Icon, val text: String, val colors: List<Color>) : Icon

A colored icon with some text in it.

Functions

addProperty

fun Element.addProperty(name: String, value: String? = null)

Adds a property with given name and value.

getMultiProperty

fun Element.getMultiProperty(name: String): List<Element>

Returns all children with attribute name="[name]".

getProperty

fun Element.getProperty(name: String): Element?

Returns the single child with attribute name="[name]", or null if there is not exactly one such child.

getPropertyByPath

fun Element.getPropertyByPath(vararg names: String?): Element?

Traverses a path of Elements based on their names by monadically either calling getProperty (if the name is not null) or taking the single child (if the name is null).

getPropertyValue

fun Element.getPropertyValue(name: String): String?

Returns the value of the value attribute of property name, or null if the property does not exist or if the property has no value.

getSchemes

fun Element.getSchemes(): List<Element>

Assuming this is the Element representation of a Settings instance, returns the list of Elements of the contained com.fwdekker.randomness.Schemes.

getTemplateList

fun Element.getTemplateList(): Element?

Assuming this is the Element representation of a Settings instance, returns the Element of the contained com.fwdekker.randomness.template.TemplateList, or null if no such Element could be found.

getTemplates

fun Element.getTemplates(): List<Element>

Assuming this is the Element representation of a Settings instance, returns the list of Elements of the contained com.fwdekker.randomness.template.Templates.

matchesFormat

fun String.matchesFormat(format: String, vararg args: String): Boolean

Returns true if format is a format string for this string, optionally after inserting args into format.

registerModifierActions

fun ListPopupImpl.registerModifierActions(captionModifier: (ActionEvent?) -> String)

Registers actions such that actions can be selected while holding (combinations of) modifier keys.

renameProperty

fun Element.renameProperty(oldName: String, newName: String)

Renames the property from oldName to newName.

setAll

fun <E> MutableCollection<E>.setAll(collection: Collection<E>)

Removes all elements from this collection and adds all elements from collection.

setPropertyValue

fun Element.setPropertyValue(name: String, value: String)

Sets the value of the value attribute of property name, or adds the property if it does not exist.

times

private operator fun <E> List<List<E>>.times(other: List<List<E>>): List<List<E>>

Returns the cartesian product of this and other.

toRandomCase

private fun Char.toRandomCase(random: Random): Char

Randomly converts this character to uppercase or lowercase using random as a source of randomness.

toSentenceCase

private fun String.toSentenceCase(): String

Turns the first character uppercase while all other characters become lowercase.