com.im.ijc.core.api.views
Interface WidgetContainer

public interface WidgetContainer

Description of a widget container that provides enough data for printing.

Method Summary

Iterable<? extends WidgetContainer>	getContainers(boolean onlyVisible) Provides all sub-containers.
VisualWidgetHandle	getContainerWidget() Associated widget if this is a nested container or null.
Dimension	getDimension() Information about view width and length to enable proper scaling.
Insets	getInsets() Information about insets used in this container.
String	getName() Name of a container.
DFResultSet	getResultSet() Printed data.
Iterable<? extends VisualWidgetHandle>	getWidgets(boolean onlyVisible) Provides all widgets in this container.

Method Detail

getName

String getName()

Name of a container.

getWidgets

Iterable<? extends VisualWidgetHandle> getWidgets(boolean onlyVisible)

Provides all widgets in this container. It does not descend recursively. Only widgets managed by this container's scene are returned.

Parameters:

onlyVisible - only currently visible widgets will be returned (it is up to implementation to decide what to return if the container is not shown)

getContainers

Iterable<? extends WidgetContainer> getContainers(boolean onlyVisible)

Provides all sub-containers.

Parameters:

onlyVisible - only currently visible widgets will be returned (it is up to implementation to decide what to return if the container is not shown)

getContainerWidget

VisualWidgetHandle getContainerWidget()

Associated widget if this is a nested container or null.

getDimension

Dimension getDimension()

Information about view width and length to enable proper scaling.

getInsets

Insets getInsets()

Information about insets used in this container. Useful for computation of widget location if it is placed into a nested container.

Returns:

widget padding information.

getResultSet

DFResultSet getResultSet()

Printed data.