Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.webcentric.layout

WebcentricLayoutService

A Webcentric implementation of the caplin.layout.LayoutService interface. This class is assigned to the caplin.layout-service alias when using the caplin.webcentric-service-aliases alias group.

Constructor Summary

Attributes Name and Description
caplin.webcentric.layout.WebcentricLayoutService()

Method Summary

Attributes Name and Description
void close( layout)

See caplin.layout.LayoutService#close.
void dispose( layout)

See caplin.layout.LayoutService#dispose.
void getAvailable()

See caplin.layout.LayoutService#getAvailable.
void getOpen()

See caplin.layout.LayoutService#getOpen.
void getSelected()

See caplin.layout.LayoutService#getSelected.
void getTemplates()

See caplin.layout.LayoutService#getTemplates.
void open( layout)

See caplin.layout.LayoutService#open.
void openNew( layoutTemplate)

See caplin.layout.LayoutService#openNew.
void save(caplin.webcentric.layout.WebcentricLayout layout)

Saves the layout to the Webcentric servlet.
void saveAs(caplin.webcentric.layout.WebcentricLayout layout, String name)

Saves a copy of the layout to the Webcentric servlet with a given name.
void select( layout)

See caplin.layout.LayoutService#select.

Constructor Detail

► caplin.webcentric.layout.WebcentricLayoutService()

Method Detail

► void close( layout)

See caplin.layout.LayoutService#close.

Parameters
layout
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout.
caplin.core.Error
If the page cannot be found.

► void dispose( layout)

See caplin.layout.LayoutService#dispose.

Parameters
layout
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout.

► void getAvailable()

See caplin.layout.LayoutService#getAvailable.

► void getOpen()

See caplin.layout.LayoutService#getOpen.

► void getSelected()

See caplin.layout.LayoutService#getSelected.

► void getTemplates()

See caplin.layout.LayoutService#getTemplates.

► void open( layout)

See caplin.layout.LayoutService#open.

Parameters
layout
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout.

► void openNew( layoutTemplate)

See caplin.layout.LayoutService#openNew.

Parameters
layoutTemplate
Throws
caplin.core.Error
If the layout template is not an instance of caplin.webcentric.layout.WebcentricLayoutTemplate.

► void save(caplin.webcentric.layout.WebcentricLayout layout)

Saves the layout to the Webcentric servlet. Calling this method with a layout that is not selected will first select it.

Parameters
caplin.webcentric.layout.WebcentricLayout layout The Webcentric layout to be saved.
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout or if the layout is not open.

► void saveAs(caplin.webcentric.layout.WebcentricLayout layout, String name)

Saves a copy of the layout to the Webcentric servlet with a given name. Calling this method with a layout that is not selected will first select it.

Parameters
caplin.webcentric.layout.WebcentricLayout layout The Webcentric layout to be saved.
String name The desired name of the newly created Webcentric layout.
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout or if the layout is not open.

► void select( layout)

See caplin.layout.LayoutService#select.

Parameters
layout
Throws
caplin.core.Error
If the layout is not an instance of caplin.webcentric.layout.WebcentricLayout.
caplin.core.Error
If the page cannot be found.