Skip to content

Latest commit

 

History

History
277 lines (170 loc) · 4.33 KB

which-action-has-to-be-enabled-for-which-control-f269c0b.md

File metadata and controls

277 lines (170 loc) · 4.33 KB

Which Action Has to Be Enabled for Which Control?

There are various actions and recommendations for implementing them in different types of controls.

Here's an overview of actions and some recommendations in which type of controls to implement them:

Action

Description

Recommended For

remove

Remove or hide the control with all its children

Most controls

reveal

Make hidden/stashed controls visible for end users

Most controls

rename

Rename text properties of a control

Controls with textual properties that have a meaning to a user, such as:

  • Titles
  • Labels
  • Texts

move

Drag and drop / cut and paste elements inside containers/layouts

  • Containers
  • Composite controls (like Forms, Tables, Charts)
  • Layouts

addViaDelegate

Add properties from metadata via delegates attached to a control

  • Forms
  • Tables
  • Containers
  • Composite controls (like Forms, Tables, Charts)
  • Layouts
  • Charts

createContainer

Create a new (sub-)container to rearrange controls from a similar container

Container/layout controls with specific sub-containers, so it's clear what to provide as initial content for such a container

Examples: A form has groups, an object page layout has sections, sections have subsections.

localReset

Reset changes made on a particular scope, for example, inside a form, without resetting the other changes in the application

Containers

addIframe

Embed external content as iFrames

  • Containers
  • Layouts

settings

Modify additional control-specific settings in SAPUI5 flexibility

  • Controls that integrate additional settings using an own dialog
  • Controls that have personalization dialogs. Note: Personalization dialogs can be reused. We recommend to reuse them whenever it makes sense.

combine

Combine/join/group several controls into the first selected one

Especially form-related controls but also for other container, layout, or composite controls

split

Split combined controls into individual controls

Controls allowing the combine action

resize

Resize controls

It's currently only possible to change the width of controls.

Controls that aren't automatically sized, for example, table columns or pictures

In this section, we'll provide you with information on whether an action should be implemented on a composite control, even if it's already enabled for the individual controls used inside. Let's say a RadioButton control uses a Label control internally to present label functionality. Should the RadioButton control enable the rename action, or is it sufficient that the Label control enables it?

Here's the general guidance:

  • The action should be enabled by the plain control if it relies on the control itself, without changing the parent aggregation.

  • If the parent aggregation of the plain control is affected by the action, then the composite control should be enabled for the corresponding action.

  • If the inner control needs to behave differently within the context of a composite control, the design-time metadata/action should be propagated from the composite control to the inner control.