org.openlowcode.design.data.properties.basic

Class Widget

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.properties.basic.Widget

All Implemented Interfaces:

java.lang.Comparable<Widget>, NamedInterface

Direct Known Subclasses:

FileContent.AttachmentTableWidget, HasAutolink.WidgetForLeftOrCommonAutolink, HasAutolink.WidgetForRightAutolink, LeftForLink.LinkFromLeftTableWidget, LinkedFromChildren.ChildrenTable, ObjectWithWorkflow.ObjectWorkflowTable, RightForLink.LinkFromRightTable

public abstract class Widget
extends Named
implements java.lang.Comparable<Widget>

A widget is a graphical component put on a data object page for a property. Widgets are compared by priority

Author:

Open Lowcode SAS

Method Summary

Modifier and Type	Method and Description
int	compareTo(Widget otherwidget)
abstract void	generateWidgetCode(SourceGenerator sg, Module module, java.lang.String locationname) generates the widget code
abstract java.lang.String[]	getImportStatements()
abstract WidgetDisplayPriority	getWidgetPriority()

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Method Detail

getImportStatements

public abstract java.lang.String[] getImportStatements()

Returns:

the import statements for the widget code generation

generateWidgetCode

public abstract void generateWidgetCode(SourceGenerator sg,
                                        Module module,
                                        java.lang.String locationname)
                                 throws java.io.IOException

generates the widget code

Parameters:

sg - source generator

module - parent module

locationname - a prefix related to the location of this widget

Throws:

java.io.IOException - if anything bad happens writing the file

getWidgetPriority

public abstract WidgetDisplayPriority getWidgetPriority()

Returns:

the widget display priority if specified

compareTo

public int compareTo(Widget otherwidget)

Specified by:

compareTo in interface java.lang.Comparable<Widget>