Package com.storedobject.ui

Class ObjectViewer

java.lang.Object

com.storedobject.ui.Executor

com.storedobject.ui.ObjectViewer

All Implemented Interfaces:

Executable, ObjectSetter<StoredObject>, AlertHandler, Runnable, Consumer<StoredObject>

public class ObjectViewer
extends Executor
implements ObjectSetter<StoredObject>, AlertHandler

The ObjectViewer class is a utility for viewing StoredObject instances within an application. This class extends Executor to provide execution functionalities and implements ObjectSetter to set objects for viewing and AlertHandler to handle alerts associated with StoredObject.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.ui.Executor

application

Constructor Summary

Constructors

Constructor	Description
ObjectViewer(Application a)	Constructs an ObjectViewer instance with the specified application.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the ObjectViewer by releasing associated resources and setting relevant fields to null.
void	execute()	Executes the primary action associated with the ObjectViewer by invoking the view method.
boolean	executing()	Checks if the viewer is currently executing an action.
String	getAlertCaption()	Get the caption name to be used on the alert action button.
String	getAlertIcon()	Retrieves the icon associated with alert notifications for the ObjectViewer.
void	handleAlert(StoredObject object)	Handles the alert action for the given StoredObject.
void	setObject(Id objectId)	Sets the object for the viewer using the given object ID.
void	setObject(StoredObject object)	Sets the specified StoredObject instance for this ObjectViewer.
void	view()	Triggers the default view behavior for the object or content managed by the viewer without any specific parameters.
void	view(Id objectId)	Displays the view associated with the specified object ID.
void	view(Id objectId, ObjectViewerButton<?>... buttons)	Opens a view for a specific object identified by its ID and allows optional buttons to be added for interaction.
void	view(Id objectId, String actionName, Consumer<StoredObject> action)	Executes an action on a stored object identified by the provided objectId.
void	view(StoredObject object)	Displays the specified stored object.
void	view(StoredObject object, ObjectViewerButton<?>... buttons)	Triggers the viewing process for the given StoredObject instance and optional viewer buttons.
void	view(StoredObject object, String actionName, Consumer<StoredObject> action)	Displays the specified StoredObject with an associated action.
void	view(ObjectViewerButton<?>... buttons)	Triggers the view functionality using the specified buttons for the ObjectViewer.
void	view(String caption)	Initiates the view process with the specified caption.
void	view(String caption, Id objectId)	Displays a view based on the given caption and object ID.
void	view(String caption, Id objectId, ObjectViewerButton<?>... buttons)	Displays a view of the specified object, identified by its ID, with the provided caption and optional buttons for additional actions.
void	view(String caption, Id objectId, String actionName, Consumer<StoredObject> action)	Displays a view with the specified parameters.
void	view(String caption, StoredObject object)	Displays a view using the specified caption and stored object.
void	view(String caption, StoredObject object, ObjectViewerButton<?>... buttons)	Displays the specified StoredObject in the ObjectViewer with a given caption and optional action buttons.
void	view(String caption, StoredObject object, String actionName, Consumer<StoredObject> action)	Displays a view with the specified caption and an action on the given stored object.
void	view(String caption, ObjectViewerButton<?>... buttons)	Opens a viewer for the specified object with the provided caption and optional buttons.
void	view(String caption, String actionName, Consumer<StoredObject> action)	Initiates the process of viewing an object with a specified action.
void	view(String actionName, Consumer<StoredObject> action)	Initiates a view operation using a specified action name and action logic.

Methods inherited from class com.storedobject.ui.Executor

getApplication, getTransactionManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.ui.AlertHandler

handleAlert

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.storedobject.common.Executable

act, run

Methods inherited from interface com.storedobject.core.ObjectSetter

accept, getObjectClass, isAllowAny

Constructor Details

ObjectViewer

public ObjectViewer(Application a)

Constructs an ObjectViewer instance with the specified application.

Parameters:

a - The application instance used to initialize the ObjectViewer.

Method Details

execute

public void execute()

Executes the primary action associated with the ObjectViewer by invoking the view method. This method triggers the default view behavior for the object or content managed by the viewer.

Specified by:

execute in interface Executable

setObject

public void setObject(StoredObject object)

Sets the specified StoredObject instance for this ObjectViewer.

Specified by:

setObject in interface ObjectSetter<StoredObject>

Parameters:

object - The StoredObject instance to be set.

setObject

public void setObject(Id objectId)

Sets the object for the viewer using the given object ID.

Specified by:

setObject in interface ObjectSetter<StoredObject>

Parameters:

objectId - The ID of the object to set.

view

public void view(String caption,
 String actionName,
 Consumer<StoredObject> action)

Initiates the process of viewing an object with a specified action.

Parameters:

caption - the title or heading for the view

actionName - the name of the action to perform in the view

action - the operation to be executed, provided as a Consumer of StoredObject

view

public void view(String caption,
 ObjectViewerButton<?>... buttons)

Opens a viewer for the specified object with the provided caption and optional buttons. If a viewer instance corresponding to the caption is found, it invokes the view mechanism on the associated object, adding the specified buttons to the interface.

Parameters:

caption - The caption to display for the object viewer. It is used to lookup or initialize the viewer instance.

buttons - Optional buttons of type ObjectViewerButton to enhance the viewer's functionality.

view

public void view()

Triggers the default view behavior for the object or content managed by the viewer without any specific parameters. Delegates to the overloaded view(String, String, Consumer<StoredObject>) method with all parameters set to null.

view

public void view(ObjectViewerButton<?>... buttons)

Triggers the view functionality using the specified buttons for the ObjectViewer. This method invokes a secondary view method with a null caption and the provided buttons.

Parameters:

buttons - An array of ObjectViewerButton instances that define actions or behaviors during the view operation.

view

public void view(String actionName,
 Consumer<StoredObject> action)

Initiates a view operation using a specified action name and action logic.

Parameters:

actionName - The name of the action to be performed.

action - A Consumer representing the logic to be executed on the StoredObject.

view

public void view(String caption)

Initiates the view process with the specified caption. This method is a convenience method that internally calls the overloaded view method with the given caption, a null action name, and no action.

Parameters:

caption - The caption to be displayed for the view.

view

public void view(StoredObject object)

Displays the specified stored object.

Parameters:

object - the StoredObject instance to be displayed. If null is passed, the method may handle it as per its implementation.

view

public void view(StoredObject object,
 String actionName,
 Consumer<StoredObject> action)

Displays the specified StoredObject with an associated action.

Parameters:

object - The StoredObject instance to be displayed.

actionName - The name of the action associated with the displayed object.

action - A Consumer that defines the action to be performed on the StoredObject.

view

public void view(StoredObject object,
 ObjectViewerButton<?>... buttons)

Triggers the viewing process for the given StoredObject instance and optional viewer buttons. The additional buttons can allow for extended actions or interactions during the viewing process.

Parameters:

object - The StoredObject instance to be viewed.

buttons - Optional ObjectViewerButton instances to include additional actions or controls.

view

public void view(String caption,
 StoredObject object)

Displays a view using the specified caption and stored object.

Parameters:

caption - the title or label of the view

object - the stored object to be displayed in the view

view

public void view(String caption,
 StoredObject object,
 String actionName,
 Consumer<StoredObject> action)

Displays a view with the specified caption and an action on the given stored object.

Parameters:

caption - the title or label for the view

object - the stored object to be displayed in the view

actionName - the name of the action to be performed

action - a consumer defining the action to be executed on the stored object

view

public void view(String caption,
 StoredObject object,
 ObjectViewerButton<?>... buttons)

Displays the specified StoredObject in the ObjectViewer with a given caption and optional action buttons.

Parameters:

caption - The caption to display in the viewer.

object - The StoredObject instance to be viewed.

buttons - Optional buttons of type ObjectViewerButton to add custom actions in the viewer.

view

public void view(String caption,
 Id objectId)

Displays a view based on the given caption and object ID.

Parameters:

caption - The caption or title to display in the view.

objectId - The ID of the object to be viewed.

view

public void view(String caption,
 Id objectId,
 String actionName,
 Consumer<StoredObject> action)

Displays a view with the specified parameters.

Parameters:

caption - The caption to be displayed in the view.

objectId - The ID of the object to set for the view.

actionName - The name of the action to be associated with the view.

action - A consumer that defines the action to be performed on the StoredObject.

view

public void view(String caption,
 Id objectId,
 ObjectViewerButton<?>... buttons)

Displays a view of the specified object, identified by its ID, with the provided caption and optional buttons for additional actions.

Parameters:

caption - The caption to display in the view.

objectId - The ID of the object to be viewed.

buttons - Optional buttons to provide additional actions to perform in the view.

view

public void view(Id objectId)

Displays the view associated with the specified object ID. This method utilizes the default caption for the view.

Parameters:

objectId - The ID of the object to be viewed.

view

public void view(Id objectId,
 String actionName,
 Consumer<StoredObject> action)

Executes an action on a stored object identified by the provided objectId. Delegates the actual processing by invoking an overloaded version of the view method.

Parameters:

objectId - the identifier of the stored object to be acted upon

actionName - the name of the action to be performed on the stored object

action - the consumer that defines the specific action to apply to the stored object

view

public void view(Id objectId,
 ObjectViewerButton<?>... buttons)

Opens a view for a specific object identified by its ID and allows optional buttons to be added for interaction.

Parameters:

objectId - the ID of the object to be viewed

buttons - a varargs parameter allowing optional interactive buttons to be included in the view

executing

public boolean executing()

Checks if the viewer is currently executing an action.

Returns:

true if a viewer exists and it is executing an action, false otherwise.

close

public void close()

Closes the ObjectViewer by releasing associated resources and setting relevant fields to null. If the underlying viewer is not null, it will invoke the `close()` method of the viewer before resetting the viewer and related object fields to null.

handleAlert

public void handleAlert(StoredObject object)

Handles the alert action for the given StoredObject.

Specified by:

handleAlert in interface AlertHandler

Parameters:

object - The StoredObject instance for which the alert is handled.

getAlertIcon

public String getAlertIcon()

Retrieves the icon associated with alert notifications for the ObjectViewer.

Specified by:

getAlertIcon in interface AlertHandler

Returns:

A string representing the identifier of the alert icon.

getAlertCaption

public String getAlertCaption()

Description copied from interface: AlertHandler

Get the caption name to be used on the alert action button. By default, "Process" is used.

Specified by:

getAlertCaption in interface AlertHandler

Returns:

Alert button caption.