All Classes and Interfaces

Class
Description
 
 
Abstract base class for creating specific subtypes of charts that requires more axes.
 
 
 
Base class for the representation of color.
 
 
 
 
Representation of data as a List.
A view that is used for creating "data entry forms" for a particular type of object.
A view that is used for creating "data entry forms".
For internal use only.
Abstract data provider interface.
A crude Number comparator that can be used for data that is of Number type.
A data provider implementation to provide data from a Stream.
Represents abstract "data zoom" component.
An editable grid.
Class to represent a "data entry form".
Abstract Gantt chart is the base class for GanttChart and ActivityChart.
 
 
 
Represents abstract base for the label used by other parts such as Axis, Chart etc.
 
 
 
The base field for accepting a StoredObject instance.
 
Methods used by fields for inputting StoredObjects or Ids.
Represents an abstract ComponentPart with some common base properties.
 
An abstract base class that implements some useful attributes and methods for defining a project.
Abstract base implementation of ComponentProperty.
 
 
 
 
Abstract "resourced component" that knows how to register/unregister the resource during attach/detach events.
 
 
 
 
 
A class that defines basic style details.
Abstract base class for the representation of tasks/activities used within Project instances and ActivityList instances.
 
 
 
 
 
Represents an abstract unit within a system.
 
 
 
This class represents an Account.
 
 
 
This class is used to configure accounts for posting transactions such as purchase and sales invoices.
 
Entity class used by the accounting system.
 
 
Account Statement.
A virtual account to support multiple titles for a real account.
Accumulator function that is used to accumulate values (for example, a sum or a product) of a series of values.
 
Action form is used to execute some action if the user confirms it by pressing a "Yes" button.
A grid to be shown in a window with "Yes/No" buttons and an action is carried out if the "Yes" button is pressed.
A TextField that triggers a Consumer action (when value changed or "Enter" key is pressed).
Activity chart is like a GanttChart but instead of a Project instance as its data, it uses an ActivityList instance as its data.
Class to represent a list of activities (instances of ActivityList.Activity).
Class to check and manipulate mailing address information.
 
 
AE Address
line[0]: Code for the emirate (0: Abu Dhabi, 1: Dubai, 2: Sharjah, 3: Ajman, 4: Um Al Quwain, 5: Ras Al Khaimah, 6: Fujairah)
 
 
 
 
Slightly enhanced version of Vaadin's Notification.
 
Alert Generator.
Alert handler.
Representation of Alignment property (both horizontal and vertical).
Anchor that acts like a button.
 
Representation of angle axis.
 
Class to support animation related properties.
 
 
 
 
Application is the base class for creating a 'single page' web applications.
You can insert an entry in this data class for handling application alerts.
Application can set up an environment that controls certain behaviours of the application.
 
An implementation of ApplicationLayout using Vaadin's AppLayout.
 
 
Application requires an instance of this class to determine the "layout" of its page.
 
 
Interface that defines the "menu" area of the Application.
Application menu item definition.
A special menu item that has sub-menus in it.
 
 
 
 
The class that defines the content view of the Application.
 
The AQI class represents the Air Quality Index, a measure used to communicate how polluted the air currently is or how polluted it is forecast to become.
Defines an arc shape that can be added to SOChart.
Shape that partially defines an arc.
Represents an area (mostly a rectangular block).
 
 
Area-style.
An array implementation with variable size.
Enhanced array list.
An ArrayList that has the properties of a Set (Only one instance will appear even if duplicate elements are added).
 
 
Field to accept an item that is fitted on an assembly.
 
 
 
 
 
 
Component to play audio streams.
A special Audio class that gets input from the client Computer's mic.
Audit trail..
 
 
 
Interface for defining an external authenticator.
 
A list of AutoCloseable objects.
 
Abstract representation of an axis.
Represents ticks on an axis line.
Represents the grid-areas drawn by the axis.
Represents the grid-lines drawn by the axis.
Represents the label used by Axis.
A base class for various types of lines used in axis and coordinate systems.
Represents the minor grid-lines drawn by the axis.
Represents the minor tick on the axis line.
Represents the axis-pointer shown by the axis.
Represent the handle that can be used with an axis-pointer.
Represents the label displayed by the axis-pointer.
Definition of pointer types.
Represents the tick on the axis line.
A component that is decorated like a badge.
Icons with badge style.
Bar chart.
Barcode (Based on the xzing package).
 
 
 
 
 
 
 
 
 
 
 
BasicComboBox is a specific implementation of a ComboField allowing for the creation of combo boxes with various constructors for initialization.
A generic combo box component that extends the ListBox class.
A basic data provider that can be extended to create customized data providers.
A basic data provider that can be extended to create customized internal data providers.
Defines Bezier curve that can be added to SOChart.
Field to edit BigDecimal values.
An object that keeps a BigDecimal value.
Anything that generates some sort of binary "content".
 
 
 
 
Represents a Block (or a Building or something similar), which is a specific unit of functionality or data in the application framework, extending the capabilities of AbstractUnit.
 
 
 
BlockView represents a view specifically designed to handle block entities and relevant updates in the IoT system.
Field to edit Boolean values.
Boolean field displayed like a radio field.
 
Represents a border.
 
Using this class one can draw a "box" around any Vaadin component.
 
Breadcrumbs component.
Component that represents a "breadcrumb".
Listener interface for "breadcrumb removal listener".
Breadcrumb Tree component.
Listener that can be added to the BreadcrumbsTree for monitoring the visibility changes of the nodes (and its associated components).
 
 
An invisible component to grab messages sent to the browser window.
Bubble chart.
 
 
 
Business entity - Used by EntityAccount.
Enhancements to Vaadin Button.
Vaadin Flow wrapper around the Web Component: Paper Icon Button.
A responsive layout that can be used to display components (typically Buttons horizontally).
 
 
Candlestick chart.
Data representation for CandlestickChart.
A structure to represent a data point in the candlestick chart.
 
Make a component to appear like an "elevated card" on the screen.
 
A list-based data provider for category data.
Category data is typically non-numeric kind of (string) data that can be used in many charts like in the X-axis of a BarChart.
 
A simple layout that can be used as a component of the View.
CH Address
A thin wrapper class that warps the details of value changed in a field (HasValue.
A thin wrapper class that warps the details of value changed in a field (HasValue.
 
 
 
 
 
 
Chart.
Class to represent the Emphasis effect.
Definition of the "fading out" of other elements when emphasizing.
Definition of how the "fade out" is spread across other elements.
Value-label that can be customized for a chart.
Position indicator for labels used in charts.
Represents an event that occurs in a chart.
Functional interface to listen to events occurring on a chart or its part.
Represents the type of event that can occur on a chart / part.
Exception that may be raised by the chart package.
Use this class instead of Image because it supports images from MediaFile and other resources.
Chart type.
 
 
 
 
 
 
A class used to check/ compare the current value with the previous value in a series of values and returns a boolean result.
 
A ComboBox style field with an Integer value type.
A field that allows you to select multiple values from a fixed list of Strings.
 
Circle shape class that can be added to SOChart.
Shape that partially defines a circle.
 
Class attribute of a StoredObject class contains metadata information about the class that is not applicable to normal Java classes.
 
Represents a common interface for objects that have a clickable functionality.
A wrapped class to make any Vaadin component "clickable".
Interface that handles mouse clicks (typically on Button).
Create a click event from another event.
Specialized implementation of the Listeners class that manages and notifies event listeners specifically for handling ComponentEvents.
Slightly enhanced version of Vaadin's ClickNotifier.
Client for the SO Platform Connector.
Structure to wrap an InputStream and its content-type.
A simple clock.
In order to display a "closeable vew", View creates a special "menu item" with a "Close" icon and the View can be closed by clicking on that icon.
 
 
Representation of color.
Representation of color gradient.
Annotation used to specify the features of a field (attribute of a Data Class).
 
For internal use only.
For internal use only.
 
Components that support spanning of columns.
A class that allows you to combine multiple other reports into a single report.
A thin wrapper around Vaadin's ComboBox.
 
 
Chart component.
Representation of a group of Components put together.
Represents a part used by chart Components.
Represents some combined attributes/properties owned by a Component or ComponentPart.
A component container that supports slotted components.
A part whose properties can be composed of a few configuration variables.
A field that always returns its value as null.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A confirm button is a button whose "click handler" will be invoked only after a further confirmation obtained from the user.
 
 
 
 
 
A listener that can be added to classes such as AbstractDataForm, HasColumns etc.
Represents consumption data associated with a specific resource, item, and a time period.
 
A functional interface for calculating consumption values over a specified time period.
 
 
 
Return items from a consumption location (return balance quantity after consumption).
 
 
 
 
Content coming from an InputStream that can be viewed or downloaded (via Device.view(String, ContentProducer) or Device.download(ContentProducer)).
Anything that generates some sort of "content".
 
 
An interface that helps search for value(s) using a string pattern.
 
A simple layout with a "header" portion and a scrollable "body" portion.
 
 
 
 
Abstract coordinate system.
Represents "data zoom" component that works inside a coordinate system.
 
 
 
 
Representation of a Country.
Field to accept a country's ISO code (2 characters) as a value.
CRAM (Challenge Response Authentication Mechanism) field.
 
 
Basic implementation of the CSS Grid layout.
Enums for positions.
CSV creator.
 
 
A field to accept a valid currency code.
 
 
 
 
 
Slightly enhanced version of Vaadin's CustomField.
 
 
 
A "custom field" where the value is represented as a "text" using an internal text field.
Daemon job is a special Job and its Job.execute() method will be invoked only once, and it runs forever in the background.
Represents daily consumption data tied to a specific item, resource, year, and day.
The DailyStatistics class represents daily statistical data and provides methods to define column structure, indices, and retrieve specific daily statistics details.
 
Dashboard is a "view" that can show multiple embedded "sub-views".
 
Numeric data.
Base class that represents data values that belong to a Unit.
Class that is internally handling Vaadin's Binder.
 
Structure to hold time and value.
 
The abstract database class.
 
 
 
The database driver interface.
 
This class represents a "data stream" stored in the database.
For internal use only
Represents a data change event for a specific object.
Enum representing the types of changes that can occur.
This interface represents a data change notifier.
This class handles the logic related to notifying changes in data.
The DataChangeProcessor class extends the DaemonJob class and represents a job that processes data changes.
Data channel opens up a channel to push data on to a SOChart once rendered.
 
 
 
A View that is used for creating a "data entry form" with "Save"/"Cancel" buttons.
This class is used to accept some quick data from the users.
 
Enhancement to Vaadin's Grid to handle Java Beans in a specialized way.
A list data structure with a "refresh" listener.
Definition of refresh listener that can be added to the DataList.
 
An abstract class that deals with data classes and their respective logic classes.
Represents a matrix of data.
 
Provider of numeric data.
An interface that defines some sort of data with attributes.
 
 
 
 
 
 
 
 
 
 
A data provider implementation to provide data from a Stream.
 
 
Enhancement to Vaadin's TreeGrid to handle Java Beans in a specialized way.
Type of data that can be used by charts.
 
 
Represents "data zoom" component.
Used to style the data shadow.
Used to style the handle.
Date data provider.
Data provider of date values.
A field to edit Date.
 
 
A date data provider implementation to provide data from a Stream.
Date utility functions.
 
 
 
 
 
 
Transaction.
 
Class that represents a decimal number value with a defined number of decimals digits.
 
 
 
 
 
 
 
 
The interface to denote that a StoredObject class is keeping details of a "master" StoredObject class.
A component with a "header" and a "detail" part.
Class that represents the "toggled event".
Interface for the toggle listener.
 
 
 
 
Servlet class for handling SO Developer Service
 
 
 
 
Method implementation for disabling paste feature in fields.
Denote that something is displayable.
 
 
 
 
 
 
 
 
Donut chart.
A field to edit Double.
 
 
 
 
 
 
 
Methods for "editable" data grids.
An editable grid that can be used to edit a list of objects of any type.
API for an "editable list".
 
An editable grid of objects.
 
 
 
 
 
Effect scatter chart.
 
 
 
 
A class that enables handling and notifying click events for a specified component.
Class used to check email address format.
 
Class to support properties related "emphasis".
 
Provides a message that is human readable and end-user friendly.
Enhanced version of Vaadin's ClickEvent class.
This class represents a legal business entity.
 
EntityAccount is a subclass of com.storedobject.core.Account that represents an account associated with an entity.
 
 
An editor for EntityRole in which the fields of the Entity get merged seamlessly with the fields of the EntityRole.
 
 
 
 
 
Error logger.
 
 
 
 
Upload data contain in an Excel file and typically create entries in the system.
 
 
An interface that to defines that a Runnable class has an "execute" method.
An interface used by "displayable" classes such as View.
A static class that can be used to execute commands and tasks.
 
 
 
 
 
 
Unlike Authenticator, if this is plugged in as the external authenticator, it will be used only as a fallback authenticator.
Represents a fault or error condition in the system.
Field customizer may be set on ObjectForm.
Interface for handling field values dynamically.
A file-mapped data buffer with index-based access to data for writing and then, for reading.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Interface defining filter methods to be used while loading objects from the DB.
Filter provider is used to define a provider of some sort of "filter condition".
The Financial interface represents a financial entity that can post ledger transactions.
 
Component for drawing flow diagrams.
 
A responsive layout that can contain only sizeable components (HasSize).
Defines Font.
Represents font-family.
Represents font-size.
Represents font-stretch.
Represents font styles.
Represents font variants.
Represents font-weight.
 
Class to represent a "data entry form".
Enhanced version of Vaadin's FormLayout.
Component that can submit HTML form-data to another site.
 
 
A field that accepts free format text and converts it into a value of specific type.
 
A marker interface to denote that a View or its component (View.getComponent()) has to be rendered full-screen.
Representation of data as a mathematical function of another data or stream of values.
Funnel chart.
Gantt chart.
Gauge chart.
Axis line used in GaugeChart.
Needle property of the gauge chart.
 
 
Create an image.
Representation of Geolocation.
 
 
 
 
 
 
 
 
 
This class keeps extra information about Grid.Column.
A layout for arranging components in a grid style.
 
Utility class to handle join operations of header and footer row cells.
A class that represents a single cell of the row.
 
GRN - Create, edit and process GRNs.
 
 
GUI helper class.
Interface to denote that a ComponentPart supports animation.
Interface to mark that a class has theme styles of badge.
If a StoredObject class implements this interface, while adding/removing/updating the link object instances the following validation methods will be invoked: StoredObject.validateChildAttach(StoredObject, int) StoredObject.validateChildDetach(StoredObject, int) StoredObject.validateChildUpdate(StoredObject, int)
Common interface for DataGrid and DataTreeGrid.
This class takes care of creation of the columns in the grid.
Definition of "contact" interface.
An interface to denote that the class contains a HasComponents (component container) embedded in it.
Interface to denote that a ComponentPart owns some data.
Slight enhancements to Vaadin's HasElement interface.
Interface to denote that a ComponentPart supports animation.
An implementation of DataSet using an internal HashMap.
Element that has an Icon.
Denotes that something has an Id.
Represents an entity that has an associated inventory item and provides methods to access it.
The HasInventoryItemType interface defines a contract for classes that have an associated inventory item type (P/N).
Interface to denote that a ComponentPart has ItemStyle.
Interface to denote that a ComponentPart has Label.
Interface to define whether a class has a related Logic or not.
Something that has got a name.
represents something that has a name.
Interface to denote that a ComponentPart has Padding.
If a StoredObject class implements this interface, while adding/removing/updating the link object instances the following validation methods will be invoked: StoredObject.validateParentAttach(StoredObject, int) StoredObject.validateParentDetach(StoredObject, int) StoredObject.validateParentUpdate(StoredObject, int)
Interface to denote that a ComponentPart has PolarProperty.
Interface to denote that a ComponentPart has Position.
 
 
Interface to denote that a UI class has a HasRefresh.refresh() method to refresh the screen.
Represents something that has a short-name.
Enhancement to Vaadin's HasSize interface.
Element that has a square shape (equal width and height).
The HasStreamData functional interface represents entities that provide access to an instance of StreamData.
Same as HasStyle but can be applied to an "internal element" specified.
Interface representing a component that can have a textual value along with additional features like size, text transformation, spell check, and autocomplete.
Interface to mark that a class has theme styles.
 
Interface that determines whether an object (typically a "field") has visibility or not.
Heatmap chart.
 
 
This is a marker interface to denote that a View, once displayed, should not be removed and should remain as a "home view" (unless it is programmatically removed).
The HourlyConsumption class represents consumption data aggregated at an hourly level.
The HourlyStatistics class extends the Statistics class and adds functionality specific to hourly data.
An interface that generate HTML text.
Abstract base class for a component that is initialized based on the contents of an HTML template.
 
Callback for creating an input stream on demand.
 
Build HTML text.
 
Create a View from some HTML content.
Simple HTTP utility.
The HTTP2 class facilitates HTTP/2 client-server communication with helper methods and a builder pattern for request customization.
This class provides a builder pattern for constructing HTTP requests.
IBAN utilities.
Enhancements to Vaadin's Icon to handle other collections in a generic way.
 
A unique id generator that can be used to set a unique id for components.
ID Address
line[0]: City/Town (required)
line[1]: Province (optional)
 
Interface to identify a SystemUser.
Fields that can input Id values.
 
Component that represents an HTML iframe element.
Image that can be added to SOChart.
 
Enhancement to Vaadin's Image component with proper resource handling.
A button that shows only an icon.
Anything that generates some sort of image "content".
An image component with clickable rectangular areas.
A clickable rectangular area in an image map.
Event fired when an area is clicked.
 
Image manipulation utility.
 
A Home View that shows an image (typically used to show a background image).
A View that shows a background image, a parent image and other overlay-components relative to the parent image.
IN Address
line[0]: Post Office
line[1]: District code
line[2]: State code
 
An interface used by AbstractForm and AbstractDataForm classes to determine if a field can be added to the form or not.
 
 
For internal use only.
 
An information message to be shown to the user.
A marker interface denoting that a View is used only for displaying some sort of information on the screen.
A class that combines an InputStream and an OutputStream.
This class is for internal purpose only.
 
Field to edit Integer.
 
 
A marker interface to combine the interfaces AbstractDataProvider and InternalDataProvider.
A wrapper class to convert any instance of AbstractDataProvider to an instance of InternalDataProvider.
A marker interface to denote that an AbstractDataProvider is internal to some chart that handles its data internally and that can't be shared with other charts.
This interface represents an internal element structure.
 
 
 
 
The InvalidLinkError class is an error handler that extends the RouteNotFoundError class and is used to manage invalid or non-existent application links.
APN (Alternate Part Number) of a "Part Number".
An item can be an assembly, composed of one or more sub-items and each sub-item can also be an assembly.
Represents a bin within a store where items can be stocked.
Represents an inventory location where the item is in the custody of some personnel.
Represents a "fitment position" (a position where an item can be fitted) of an assembled item.
GRN class.
Items in a GRN.
Denotes an item in the inventory.
An inventory item type denotes a "part number".
 
Represents a location where an item can be located or sourced.
Base class for creating Purchase Orders (POs).
 
 
 
 
 
 
Represents a store where items can stocked at the bin locations (InventoryBin) of the store.
The whole "inventory store" can be considered as on "huge" bin and this class represents that.
Utility class to create inventory transactions (movement of items from one location to another).
 
 
 
Represents all types of virtual locations for inventory items.
Create an InputStream such that whatever is read from this stream should be the same as whatever written to an associated OutputStream!
Create an OutputStream such that whatever is written to it will appear in an associated InputStream!
Create a Reader such that whatever is read from it should be the same as whatever written to an associated Writer!
Create a Writer such that whatever is written to it will appear in an associated Reader!
A marker interface to denote that a Component is invisible (doesn't have width and height).
 
Generic Input/Output routines.
Field to edit an IPv6 addresses.
A specialized text field component for IPv6 address input.
Field to edit an IP addresses.
Represents a specialized text field designed for validated input of IPv4 addresses.
 
 
 
 
 
 
 
Field to accept an instance of the InventoryItem with provision to input part number.
Field to accept an instance of the InventoryItem from direct search words.
Fields that can input a given type of InventoryItem value.
 
 
 
Interface for listening on selected items (especially in Grid.
Interface for listening on selected items (especially in Grid.
 
Item style.
 
 
 
 
Representation of "Java Class".
 
Class loaded used internally by the platform to load classes from the database.
Representation of "Java Inner Logic".
This class is a filtered writer to format Java source code.
 
A logic that extends this class is called a "Job".
 
 
Represents a Journal Voucher (JV).
Represents a ledger entry of the JV.
 
 
Class to keep track of the JVs to be exchanged with foreign financial systems.
 
A simple wrapper around JSON processing classes.
Extended JSON class with more extract methods for the core-specific attribute types.
Type of JSON values.
 
 
 
 
 
 
 
 
 
 
 
Interface to denote that a ContentProducer instance such as a report supports JSON parameter.
 
Interface defining the JSON Service interface.
 
 
 
 
 
 
Representation of special combination keys on the keyboard.
Represents base for the label used by other parts such as Axis, Chart etc.
A field that shows text from a list and the index of the list is treated as it value (So, AbstractField.getValue() returns an Integer).
A field that displays one item from a list.
 
 
Languages supported.
 
Representation of a set of entries in the "Transaction Ledger".
Representation of a single entry in the Ledger.
Representation of a "window" of entries (instances of LedgerEntry) of the "Transaction Ledger".
A field to edit legacy Date.
Representation of legend.
 
 
 
Defines a line segment that can be added to SOChart.
Line chart.
Line-style.
Line-type.
 
 
 
 
A field that shows text from a list and the index of the list is treated as it value (So, AbstractField.getValue() returns an Integer).
This class can be used to edit a list of any kind of Object instances.
Abstract base class for managing and notifying a collection of listeners.
Slightly enhanced version of Vaadin's Select.
A grid that implements a List data model.
 
 
 
This is a simple base component to create a Vaadin component from a LitElement that supports easy execution of Javascript.
A component that extends the functionality of LitComponent and implements the HasSize interface to support setting size-related properties such as width, height, minimum size, and maximum size.
ID Address
 
For locating stocks of a given "Part Number" and its APNs.
Representation of a location.
Location field for accepting inventory locations.
 
 
 
Used for defining a menu option.
To represent logical operators.
Used for grouping of menu items (Logic.
 
This is a special exception that can be thrown from the constructors of logic classes to redirect the logic execution to some other logic.
This class is used to handle the process of logging into the platform.
This is a template-based login screen and its template can be defined in the TextContent named "com.storedobject.ui.LoginForm".
 
 
Field to edit Long.
 
 
A collections interface that extends Iterator and Iterable interfaces
Field to accept valid MAC address.
A specialized text field for handling MAC address input and validation.
Represents a Mail providing capabilities to manage and send emails with support for handling addresses, CC, sender information, message types, attachments, and error handling.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A combo field where the values are set as a "map" (key-value pairs).
Mark area.
A block represents an area of the MarkArea.
A StoredObject class that actually hosts its data in a master database should implement this marker interface.
 
 
 
 
 
 
 
 
 
Math utility functions
Create a field to accept a specific measurement Quantity.
 
A field for inputting MeasurementUnits.
Base class for other media classes such as Audio, Video etc.
Interface that defines capturing of streams from devices such as video camera, mic etc.
Interface to be implemented in order to receive data from the MediaCapture as a stream like audio/video/image etc.
Interface to implement to receive capturing status changes of a MediaCapture.
Utility methods related to handling media access from within CSS styles.
 
 
The MediaStreamVariable class implements the StreamVariable interface to handle streaming data with associated MIME type provided by a MediaCapture.DataReceiver.
 
 
 
 
 
 
 
 
 
This component provides the same functionality of Vaadin's MenuBar.
Represents a "menu bar item" or its "sub-menu".
Default implementation of ApplicationMenuItem and ApplicationMenuItemGroup.
 
 
 
 
A grid to be shown in a window with an "Ok" button and it will be closed when the button is pressed.
 
 
Message sender.
 
 
 
 
 
 
 
 
A component for rendering 3D models using the `@google/model-viewer` library.
 
 
An image based menu to be created from the logic defined via an ApplicationModule instance.
Class that represents a monetary value.
A class representing a list of currency values.
Field to accept monetary values (Money).
 
 
 
Represents a monthly consumption entity that extends the base Consumption class.
Represents a statistical record for a specific month.
 
Definition of MQTT connector.
 
 
 
 
 
A grid to be shown in a window with "Proceed/Cancel" buttons to select multiple entries.
Select stock multiple entries from a list of given stock items.
MY Address
line[0]: Postal town
line[1]: State code
 
 
 
Interface to generate new object of a specific type.
 
Nightingale Rose chart.
 
 
 
To indicate whether a field non-displayable ore not.
Annotation to ignore a getXXX method of a "host" set in an ObjectForm while building fields.
 
 
An interface that denotes that notifications can be received.
An abstract class representing a numeric text field with support for various configurations, such as grouping, allowance of negative values, formatting, and specified width constraints.
 
 
 
A utility editor class to dynamically create and add a new StoredObject instance to an ObjectInput field.
 
 
 
 
 
 
"Object Changed" listener to track changes to the object.
 
In many situations, a StoredObject instance may contain a code attribute (a String attribute that looks like a code - part number of an inventory item for example) and this field accept such codes for inputting the object instance.
Interface that defines the "column creator" for DataGrid and DataTreeGrid.
 
 
 
Converter that converts an object instance to another type.
 
The concrete base class for creating CRUD views for StoredObject classes.
"Object Editor" listener to track changes of the editor.
Provider of ObjectEditor.
An implementation of ObjectChangedListener that refreshes the editor whenever changes are saved.
A field that can be used to accept Id values.
Type of the object field.
A class that implements this interface determines how fields (HasValue) are created for editing an "object".
 
 
 
 
 
 
 
 
 
 
Class to represent a "data entry form" for a particular type of object.
 
A field to accept instances of StoredObjects that are searchable using some keywords.
The ObjectGetField requires a "get provider" to provide objects or list of objects based on a search text.
Implementation of ObjectGetField.GetProvider for normal StoredObject classes.
Implementation of ObjectGetField.GetProvider for StoredObject classes where additional type information is required (For example, InventoryItem requires an instance of the InventoryItemType while searching in order to narrow down the search).
Definition of an "object getter" - classes that provide an object of a specific type.
 
 
Create a PDF report from the grid rows.
 
 
Strictly for internal use only.
Fields that can input a given type of StoredObject value.
Helper class that allows you to iterate through objects retrieved from the DB.
 
 
 
Generate a PDF with a list of objects.
A list report that lists StoredObjects.
This class can be used to edit a list of StoredObjects.
 
Generate an Excel with list of objects.
 
Grid that can be used show a list of StoredObject instances.
 
 
Methods for loading instances of StoredObject.
 
Class that maintains filter conditions and associated details that can be used in StoredObject's query/list/get methods and ObjectLoaders.
Grid that can be used show a list of StoredObject instances.
 
 
 
 
Provider of sme sort of object.
 
A grid-view that is typically used for searching and setting a particular instance of a StoredObject.
 
 
 
 
 
Denotes consumer of an object.
 
ObjectTable is similar to ObjectGrid but instead of the Grid, it uses Table to render the rows.
Definition of a type that can be used as an attribute in StoredObject class.
 
Interface to convert a StoredObject to String.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
PDFObjectReport and ODTObjectReport are used to define report logic to be used in PrintLogicDefinition.
 
 
 
 
 
 
 
Represents orientation property.
 
 
 
 
Padding.
Create an image from an AWT image painted on a Graphics2D.
Image type.
Create an image resource from an AWT image painted on a Graphics2D.
A class that provides multithreaded synchronized Accumulator functionality
 
Parameter-driven web service interface.
 
 
Represents an abstract text input field enforcing a specific pattern or format for its content.
This class is used to create PDF output.
Represents a "cell" of the PDFTable.
Representation of "PDF chunk".
Represents a "PDF color".
PDF content coming from an InputStream that can be viewed or downloaded (via Device.view(String, ContentProducer) or Device.download(ContentProducer)).
Representation of "PDF element".
 
Representation of "PDF font".
Font family.
Font styles.
Languages.
 
PDFObjectReport and ODTObjectReport are used to define report logic to be used in PrintLogicDefinition.
 
Representation of "PDF phrase".
 
 
Representation of "PDF rectangle".
A PDF class used for generating reports.
Table object that can be added to PDF document.
A PDF viewer component that uses browser's native object tag.
 
 
 
 
 
 
 
Personal entity - Used by EntityAccount.
 
An editor for PersonRole in which the fields of the Person get merged seamlessly with the fields of the PersonRole.
Field to accept phone numbers.
Class used to check phone number validity.
A valid phone number starts with a "+" symbol followed by dialing digits with optional space separators.
Pie chart.
This class represents a PIN stored in the system corresponding to a StoredObject.
IN Address
line[0]: Place name within the district
line[1]: District code
line[2]: Province code
 
 
 
 
Represents the symbol used to draw a point on the chart.
Represents the symbol type used to draw a point on the chart.
 
 
Representation of polar coordinate system with an angle axis and a radius axis.
Polar property is visible in PieChart, PolarCoordinate, RadarCoordinate etc. where an angular and a radial element exist.
Defines a polygon shape that can be added to SOChart.
Defines a polyline that can be added to SOChart.
Popup emulated using Vaadin's ContextMenu.
A button that can pop up some other set of components when clicked.
Enhancement to TextField to pop up a window to accept multiline text.
Representation of a position within the chart display.
If class that implements this interface is configured, it will be instantiated and queried when the user logs in.
Presentation runner to present multiple UI logic in sequence.
 
 
A "print button" is created automatically by ObjectEditors and ObjectBrowsers if one or more PrintLogicDefinitions exist for the StoredObject class.
Define "print logic" instances to be associated with a StoredObject class.
 
 
 
 
 
An interface to represent some sort of process.
 
Tag a logic to denote that it produces GRN entries.
 
 
Class to represent a project.
 
 
 
 
 
 
 
Class that represents a quantity.
Generic field to accept Quantity values.
 
Represents a combination of a quantity and its associated cost, encapsulated within a record for simplicity and immutability.
The Query class provides a mechanism to iterate over rows in a SQL result set.
A builder class for constructing queries and retrieving StoredObject instances based on various criteria.
A grid populated from a Query or a ResultSet.
Query result corresponding to a row of the grid.
Interface to send out an SMS quickly.
Interface to send out an SMS quickly.
Representation of radius axis.
Radar chart.
Radar coordinate is used by RadarChart.
Radio choice field.
Radio field of choices from a list of items.
Representation of radius axis.
 
 
Class that represents a rate value such as currency rate etc.
 
 
This class is for internal purpose only.
 
 
 
Receive material from another location.
 
 
 
Return items from an external organization / custody that were sent to them earlier (Sent for repairs, rented out, custody etc.)
 
 
Rectangular shape class that can be added to SOChart.
Representation of rectangular (cartesian) coordinate system with X and Y axes.
Class used to redirect the user to another site via SAML authentication.
An executable that allows to call its Executable.execute() method again (even from another Thread) while it is already executing.
 
 
 
 
 
 
 
 
 
Report format determines various aspects of reports that are generated by the system.
 
 
Custom interface to denote that value in a field is required or not.
A marker interface to denote that a data class requires approval.
 
An interface to monitor resizing of the browser page of the Application or its content.
 
 
A component that requires a resource.
Resource disposal class.
An implementation of a simple ResourceOwner.
Usage note: A reference to the instance of this class must be kept inside the class where the instance is used.
Defines an object that owns an auto-closeable resource.
A class to support resource handling.
 
 
 
When styling any text using TextStyle, parts of the text can be separately styled.
A ring shape (donut shape) that can be added to SOChart.
 
Rubik's Cube (created by wrapping Scarygami's @scarygami/scary-cube).
 
 
 
Sankey chart.
Class that defines an edge between 2 Sankey nodes.
Sankey data node class.
A concrete implementation of SankeyDataProvider as an ArrayList of Nodes.
Data provider interface for the SankeyChart.
Scatter chart.
 
 
 
 
Servlet class for checking te status of SO Scheduler Service and for handling parameter services.
A simple wrapper class to execute scripting languages from Java.
Supported languages.
Make any Vaadin component scrollable.
 
A text field that can be used for triggering search action.
 
 
Cipher keys used for encryption/decryption.
Definition of the Master Key supplier.
Defines a sector shape that can be added to SOChart.
 
A grid to be shown in a window with "Proceed/Cancel" buttons to select an entry.
 
Select stock entry from a list of given stock items.
 
Base class for those charts that do not require a CoordinateSystem to plot on and supports its own positioning.
Base class for those special charts that do not require a CoordinateSystem to plot on and supports its own positioning.
 
 
 
 
 
 
 
 
 
 
Implementation of serially increasing/decreasing numbers as data.
Implementation of serially increasing/decreasing date values as data.
 
 
 
 
Implementation of serially increasing/decreasing time values as data.
 
 
 
 
 
 
 
 
 
 
 
 
SG Address
line[0]: Post office (required if Post Box is specified)
Represents a shadow.
Shape class that can be added to SOChart.
Representation of a (x, y) point used in shapes.
Class to specify the style of a Shape instance.
Shapes can be grouped together using this class.
 
 
 
 
Interface to denote that the Detail interface allows only a single instance.
A marker interface to denote that a logic (typically a UI logic) should be instantiated only once per session when executed via ApplicationServer's ApplicationServer.execute(Logic) method.
Represents a Site entity that stores detailed information such as name, project affiliation, time zone, unique code, and its associated attributes.
 
Representation of "size" value.
 
 
 
 
SOAP client - A simple SOAP utility for sending/receiving/manipulating SOAP messages.
SOAP Version
Chart is a Vaadin Component so that you can add it to any layout component for displaying it.
Represents a StoredObject class type.
 
 
 
 
 
 
 
 
 
 
A button that can be used to toggle "speak" option of the Application.
 
 
Interface to denote that some text-input based component can switch on/off spell-check feature.
The database driver interface.
 
For internal use only
Square shape class that can be added to SOChart.
 
 
Represents statistical data pertaining to units and periods.
 
A Data Form for editing one or more objects that has multiple steps of content views.
A Form for editing an object that has multiple steps of content views.
Stepped View allows you to create a multi-stepped View.
 
Container class containing the header and content component of a step also handles firing step events.
Interface with default implementation to make an Element stick to the top of its container.
Class to represent stock of an item.
 
 
 
 
 
 
This interface defines a string value of something that is stored somewhere, typically, in databases.
The base class for all "data classes" - all object stored in the database.
 
 
For internal use only.
 
 
 
 
 
 
 
Stream data provider that provides data to StreamData objects.
The StringCollector class reads input data asynchronously from a given Reader or InputStream and collects it into a single concatenated string.
Interface to denote that a class has got "string filling" capability.
A FilterReader that applies "string filling" (see StringUtility.fill(String, StringFiller)) to its lines.
A FilterWriter that applies "string filling" (see StringUtility.fill(String, StringFiller)) to its lines.
A class to keep a list of Strings.
String utility functions.
Additional static string utility methods useful in the context of the platform.
 
Build something with "styles".
 
Representation of HTML style.
 
 
 
A component to show HTML text.
 
 
Sunburst chart.
 
 
 
 
 
 
 
 
 
An interface to denote that a class supports "window mode" and can create a Window when asked for.
SVG creator.
 
 
 
 
 
This class represents an entity whose accounting system exists in this server.
This class can be used for logging adhoc information.
 
 
The SystemProcess class facilitates the execution of system-level commands within a Java application.
 
This class represents a person who is also a system user.
 
 
Editor for SystemUser.
 
 
 
Annotation used to specify the features of a Data Class.
 
 
 
Header-definition for a PDFTable.
This class wraps Vaadin's Tabs with a Div.
The event class that will be fired when tab selection changes.
TaskExecutor is responsible for scheduling and executing tasks at specific times.
 
This class is used to configure tax accounts.
 
 
 
 
 
An output stream that simultaneously writes output to 2 different output streams.
 
 
 
 
 
Template component can be used to define generic HTML-template based elements via HTML text-content.
 
A Component based on a template.
This is equivalent of the DataForm class except that the content is based on HTML-template.
 
A layout Component based on a template stored in the DB as an HTML like file - It should be stored as TextContent.
Template string that can be evaluated.
Template string that can be evaluated.
An ExecutableView that uses a TemplateLayout as its sole component.
 
 
Text that can be added to SOChart.
Slightly enhanced version of Vaadin's TextArea.
Represents text-border.
Text Content
 
 
Anything that generates some sort of text "content".
 
Slightly enhanced version of Vaadin's TextField.
 
As the name indicates, "text style" is for styling texts.
 
A utility class to handle "theme" attribute of an Element.
Time data provider.
Data provider to provide time values.
 
 
 
 
 
A simple component to use as an up/down counter.
Listener interface for the TimerComponent class.
 
Field to accept Timestamp values.
 
 
A time data provider implementation to provide data from a Stream.
 
 
Title for the chart.
Toggle button (wrapper around paper-toggle-button web component).
A field that allows you to select multiple values from a fixed list of Strings.
A custom field extending MultiSelectComboBox to support token-based multi-selection of items.
Toolbox provides certain utilities (Example: "Download the chart display as an image").
 
Download tool button.
Restore tool button.
Zoom tool button.
This is the base class for creating "toolbox buttons" that can be added to Toolbox.
 
Tooltip to display.
Type of tooltips.
 
An interface that converts some type of object to a String.
TOTP implementation.
The TradeType interface represents the type of purchase/sale.
SO transaction interface.
 
 
 
Transaction commit listener.
 
 
 
A class that can create a transaction (typically a pseudo transaction).
 
A structure that encapsulates all the objects (including links) involved in a transaction.
 
 
 
 
 
 
 
A field that translates value from the value of an internal field.
A FilterInputStream that translates its stream on-the-fly.
A FilterOutputStream that translates its stream on-the-fly while writing.
A FilterReader that translates its stream on-the-fly.
A FilterWriter that translates its stream on-the-fly while writing.
Tree chart.
An implementation of TreeDataProvider.
Representation of tree-type data.
Label used within the TreeDataProvider class.
Treemap chart.
 
Trial Balance.
 
A functional interface that accepts 3 arguments of type T1, T2, T3 for performing an operation with no return value.
A functional interface that implements TriFunction.
A marker interface to denote that the StoredObject class that implements this will trigger an event when a change is made to its instance data.
 
 
 
 
Represents a unit with various attributes and methods for handling its statistics, ordinality, block association, and other operations.
 
 
 
 
 
 
 
 
 
A field for inputting MeasurementUnits.
A class to process uploaded content.
 
US Address
line[0]: Code for the state.
 
 
 
 
 
 
 
General utility methods.
Enahancemet to HasValue.ValueChangeListener that wraps the changed field (HasValue and its value into ChangedValues and invoke (default implementation) ValueChangeHandler.valueChanged(ChangedValues).
 
 
 
 
 
 
Interface for "Value Required" feature of a field (HasValue).
 
Verify OTP.
 
Component to play video streams.
A special Video class that gets input from the client Computer's camera.
View represents an independent piece of information (typically a "data entry form" or some information dashboard) to be displayed in the content area of the Application.
 
 
This listener can be added to View so that ViewClosedListener.viewClosed(View) will be invoked whenever the view is closed/aborted.
 
 
 
Interface that suggests that a class dependent on some View.
A helper View class that is used to view a single component.
A link that can be clicked to view some sort of content.
 
 
 
A grid to be shown in a window with an "Exit" button for viewing the rows of the grid.
This listener can be added to View so that ViewOpenedListener.viewOpened(View) will be invoked whenever the view is executed.
This can be implemented by a View so that its ViewSelected.viewSelected() method is invoked whenever it is selected to make it appear on the screen.
 
Represents an abstract ComponentPart with some common base properties.
Define features to visually highlight portions of the chart.
 
 
 
 
 
 
 
The WeeklyConsumption class extends the Consumption class to represent consumption data on a weekly basis.
The WeeklyStatistics class extends the Statistics class and provides functionality for managing and retrieving weekly statistical data.
 
 
 
 
 
 
 
A slightly enhanced version of Dialog that can not be closed by pressing Esc key or clicking outside.
A component that can be added to Window as the first component so that it will look like a window header.
 
This is a marker interface to denote that a ComponentPart can only be used from within a wrapper and thus, its direct Id value should not be used when encoding the JSON.
A View that is wrapped in an ExecutableView.
Representation of X axis.
 
 
Simple XML utility for XPath element extraction.
 
 
X-range chart.
Generic address.
 
Representation of XY axis (base for both XAxis and YAxis).
Basic XY-type chart - mostly plotted on a RectangularCoordinate system.
Representation of Y axis.
Represents the yearly resource consumption details.
Represents statistics that are aggregated on a yearly basis.
Component to play YouTube video.
This is written as a Vaadin Flow wrapper around "@google-web-components/google-youtube"