imageBackground

Home > Books > NetKernel API and Services Reference > Accessor Listing > Image Resource Model > imageBackground

Module

The imageBackground accessor is exported by the urn:org:ten60:util:image module. Import this module to gain access to the accessor.

Syntax

URI

active:imageBackground

Argument	Rules	Description
operand	Mandatory	the Java bitmap image
operator	Mandatory	A format document with the colour value

Example Usage

DPML

<instr>
  <type>imageBackground</type>
  <operand>var:myimage</operand>
  <operator>
    <imageBackground>
      <red>100</red>
      <green>100</green>
      <blue>50</blue>
    </imageBackground>
  </operator>
  <target>this:response</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:imageBackground");
req.addArgument("operand", [resource representation, aspect, or URI] );
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

Sets the background colour of the image to the solid colour specified by the operator. Can be used to set the background colour prior to serializing the image to a standard bitmap format such as PNG or GIF.

The operator document specifies the solid colour value. Its syntax is

<imageBackground>
  <red>100</red>
  <green>100</green>
  <blue>50</blue>
</imageBackground>

imageBackground accepts and returns an ImageAspect resource which holds a Java AWT bitmap image and can be pipelined into any other image tool.