Package com.bc.ceres.glayer.support

Class BackgroundLayer.Type

java.lang.Object
com.bc.ceres.core.ExtensibleObject
com.bc.ceres.glayer.LayerType
com.bc.ceres.glayer.support.BackgroundLayer.Type
All Implemented Interfaces:
Extensible
Enclosing class:
BackgroundLayer
@LayerTypeMetadata(name="BackgroundLayerType", aliasNames="com.bc.ceres.glayer.support.BackgroundLayer$Type") public static class BackgroundLayer.Type extends LayerType

  • Constructor Details

    • Type

      public Type()

  • Method Details

    • isValidFor

      public boolean isValidFor(LayerContext ctx)
      Description copied from class: LayerType
      Tests if this type can create layers for the given application provided context. Note that some applications may provide their context through the extension object interface (see ExtensibleObject.getExtension(Class)).
      Specified by:
      isValidFor in class LayerType
      Parameters:
      ctx - An application-dependent layer context.
      Returns:
      true if the type is valid with respect to the given context.

    • createLayerConfig

      public PropertySet createLayerConfig(LayerContext ctx)
      Description copied from class: LayerType
      Creates a default configuration instance for the type of layers this type can create. After a default configuration has been created it is usually modified to specify a layer's construction parameters, e.g. for an image layer this could be the file path to the image file. Then, an application will pass the configuration to the LayerType.createLayer(com.bc.ceres.glayer.LayerContext, com.bc.ceres.binding.PropertySet) method in order to create a new layer instance.
      Specified by:
      createLayerConfig in class LayerType
      Parameters:
      ctx - An application provided context, may be null. The parameter may be ignored by many layer types.
      Returns:
      A new layer (default) configuration.

    • createLayer

      public Layer createLayer(LayerContext ctx, PropertySet configuration)
      Description copied from class: LayerType
      Creates a layer instance for the given application provided context and the given layer configuration. The configuration may contain both, inmutable construction parameters passed to specific layer constructor as well as mutable layer properties.
      Specified by:
      createLayer in class LayerType
      Parameters:
      ctx - An application provided context, may be null. The parameter may be ignored by many layer types.
      configuration - The layer configuration.
      Returns:
      A new layer instance.