cz.ues.core.sysc.dto

Class WidgetSetAttributes

java.lang.Object

cz.ues.core.sysc.dto.WidgetSetAttributes

@DTO
public class WidgetSetAttributes
extends java.lang.Object

DTO for command Widget#setAttributes(UESURI, WidgetSetAttributes).

Since:

UES8-15

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code The new code of the widget.
private java.lang.String	controllerUrlPath Path at which the widget's controller is deployed.
private java.lang.String	description The new description of the widget.
private java.lang.Boolean	editorAvailable Describes whether the widget will be in the list of available widgets in editor.
private java.lang.Integer	height Default height of the widget in content.
private UESURI	iconUri UESURI of the widget.
private java.lang.String	name The new name of the widget.
private java.lang.Integer	placeholderHeight Height of the widget placeholder in editor.
private PlaceholderImage	placeholderImage Placeholder image of the widget in editor.
private java.lang.Integer	placeholderWidth Width of the widget placeholder in editor.
private UESSecurityLevel	securityLevel Security level of the widget.
private java.lang.Boolean	trusted Describes whether the widget will by inserted into the HTML directly or in the iframe.
private java.lang.Integer	width Default width of the widget in content.

Constructor Summary

Constructors

Constructor and Description
WidgetSetAttributes() Creates a new instance of WidgetSetAttributes.
WidgetSetAttributes(java.lang.String name, java.lang.String code, java.lang.String description, UESSecurityLevel securityLevel, UESURI iconUri, java.lang.String controllerUrlPath, java.lang.Boolean trusted, java.lang.Boolean editorAvailable, PlaceholderImage placeholderImage, java.lang.Integer width, java.lang.Integer height, java.lang.Integer placeholderWidth, java.lang.Integer placeholderHeight) Creates a new instance of WidgetSetAttributes.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

private name

The new name of the widget. If nil is set, the name is not modified.

Since:

UES8-15

code

private code

The new code of the widget. If nil is set, the code is not modified.

Since:

UES8-15

description

private description

The new description of the widget. If nil is set, the description is not modified.

Since:

UES8-15

securityLevel

private securityLevel

Security level of the widget. If nil is set, the security level is not modified.

Since:

UES8-15

iconUri

private iconUri

UESURI of the widget. If nil is set, the icon is not modified. If nil URI ("ues:[-1]:[-1]:") is set, the widget icon is removed and the widget uses icon from meta artifact. An example of icon URI: 'ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_077}'.

Since:

UES8-15

controllerUrlPath

private controllerUrlPath

Path at which the widget's controller is deployed. The value can be a relative or absolute URL (absolute URL has to be in format https://<something>.plus4u.net/). If an absolute URL is set, it is used as entered, without adding any postfix (e.g. /render which is added for relative URL). If it is not set, the widget cannot be used in the sheet content.

Since:

UES8-15

trusted

private trusted

Describes whether the widget will by inserted into the HTML directly or in the iframe. If nil is set, the security level is not modified.

Since:

UES8-15

editorAvailable

private editorAvailable

Describes whether the widget will be in the list of available widgets in editor. If nil is set, the security level is not modified.

Since:

UES8-15

placeholderImage

private placeholderImage

Placeholder image of the widget in editor. If nil is set, the security level is not modified.

Since:

UES8-15

width

private width

Default width of the widget in content.

Since:

UES8-15

height

private height

Default height of the widget in content.

Since:

UES8-15

placeholderWidth

private placeholderWidth

Width of the widget placeholder in editor. It is defined for widgets for which it is not possible to set width and height.

Since:

UES8-15

placeholderHeight

private placeholderHeight

Height of the widget placeholder in editor. It is defined for widgets for which it is not possible to set width and height.

Since:

UES8-15

Constructor Detail

WidgetSetAttributes

public WidgetSetAttributes()

Creates a new instance of WidgetSetAttributes.

Since:

UES8-15

WidgetSetAttributes

public WidgetSetAttributes(java.lang.String name,
java.lang.String code,
java.lang.String description,
UESSecurityLevel securityLevel,
UESURI iconUri,
java.lang.String controllerUrlPath,
java.lang.Boolean trusted,
java.lang.Boolean editorAvailable,
PlaceholderImage placeholderImage,
java.lang.Integer width,
java.lang.Integer height,
java.lang.Integer placeholderWidth,
java.lang.Integer placeholderHeight)

Creates a new instance of WidgetSetAttributes.

Since:

UES8-15