/// <summary>
/// Gets the <see cref="cursorZone"/> with the specified role. If the role supports multiple entries then specify index to choose what zone to get.
/// </summary>
/// <value>
/// The <see cref="cursorZone"/>.
/// </value>
/// <param name="role">The role.</param>
/// <param name="index">The index.</param>
/// <returns></returns>
public cursorZone this[cursorZoneRole role, Int32 index = 0]
{
get
{
String key = "";
if (role == cursorZoneRole.section || role == cursorZoneRole.column)
{
if (index > 0)
{
key = role.ToString() + index.ToString();
}
else
{
key = role.ToString();
}
return(items[key]);
}
else
{
key = role.ToString();
if (items.ContainsKey(key))
{
return(items[key]);
}
}
return(null);
}
}
/// <summary>
/// Adds a zone into collection. Null <c>zone</c> will be ignored.
/// </summary>
/// <remarks>
/// <para>If role is supports multiple items (column, section) on existing zone for the role it will create indexed key.</para>
/// <para>If its a singular (footer, header, master) role it will replace any existing.</para>
/// <para>If <c>master</c> zone is set, all zones will have the <c>master</c> zone set as parent.</para>
/// <para>You may set the <c>master</c> zone with constructor or any time later with Add() call - it will automatically set parent for existing zones</para>
/// </remarks>
/// <param name="role">The role for the zone</param>
/// <param name="zone">The zone to add into collection</param>
/// <returns>Key that was finally used for the zone. Possibly important in case of roles supporting multiple entries</returns>
public String Add(cursorZoneRole role, cursorZone zone)
{
if (zone == null)
{
return("");
}
String key = role.ToString();
Int32 c = 0;
if (role == cursorZoneRole.section || role == cursorZoneRole.column)
{
while (items.ContainsKey(key))
{
c++;
key = role.ToString() + c.ToString();
}
}
else if (role == cursorZoneRole.master)
{
foreach (KeyValuePair <String, cursorZone> pair in items)
{
if (pair.Key != "master")
{
pair.Value.parent = zone;
}
}
}
if (items.ContainsKey("master"))
{
var master = this[cursorZoneRole.master];
if (master != zone)
{
zone.parent = master;
}
}
if (items.ContainsKey(key))
{
items[key] = zone;
}
else
{
items.Add(key, zone);
}
return(key);
}
/// <summary>
/// Gets the boundary rectangle to hold all subzones with the specified role.
/// </summary>
/// <param name="role">The role of subzone or subzones to select</param>
/// <param name="scope">The scope to look into for each subzone</param>
/// <returns></returns>
public selectRangeArea getBoundaryOf(cursorZoneRole role, textCursorZone scope = textCursorZone.innerZone)
{
selectRangeArea range = null; //new selectRangeArea(0,0,0,0);
String key = role.ToString();
foreach (KeyValuePair <string, cursorZone> z in items)
{
if (z.Key.StartsWith(key, StringComparison.InvariantCultureIgnoreCase))
{
if (range == null)
{
range = z.Value.selectRangeArea(scope);
}
else
{
range.expandToWrap(z.Value.selectRangeArea(scope));
}
}
}
return(range);
}