com.orchestranetworks.userservice

Interface UserServicePane

All Known Subinterfaces:

UserServiceRootTabbedPane, UserServiceTabbedPane

public interface UserServicePane

Interface that a user service pane must implement.

Since:

5.8.0

See Also:

UserServiceDisplayConfigurator.setContent(UserServicePane)

Method Summary

Modifier and Type	Method and Description
default boolean	isPaddingEnabled() This method allows this pane to declare that a padding must be applied on display.
void	writePane(UserServicePaneContext aPaneContext, UserServicePaneWriter aWriter) Specifies the HTML content of the pane.

Method Detail

writePane

void writePane(UserServicePaneContext aPaneContext,
               UserServicePaneWriter aWriter)

Specifies the HTML content of the pane.

Parameters:

aPaneContext - provides information on the context.

aWriter - the object to use to add built-in form rows, widgets, HTML and JavaScript.

isPaddingEnabled

default boolean isPaddingEnabled()

This method allows this pane to declare that a padding must be applied on display.

This applies to only root panes (panes that sticks to the workspace), and root tab panes (in a tabbed pane that sticks to the workspace).

The custom component designed with this pane is in charge to respect a free space around the workspace including the workspace footer, to have a graphical coherence with the rest of the UI.

UIJavaScriptWriter.addJS_addResizeWorkspaceListener(String) takes in account this declaration.

Default value returned is true.

Returns:

true if a padding must be applied (default), false if no padding must be applied.

Since:

5.9.0