private static void PositionAlignContent(StandardContentMemento memento,
IPaletteContent paletteContent,
PaletteState state,
RightToLeft rtl,
PaletteRelativeAlign alignH,
PaletteRelativeAlign alignV,
int cellX,
int cellY,
int cellWidth,
int cellHeight,
int spacingGap)
{
// Create client rectangle covering cell size
Rectangle cellRect = new Rectangle(cellX, cellY, cellWidth, cellHeight);
PaletteRelativeAlign drawHImage = paletteContent.GetContentImageH(state);
PaletteRelativeAlign drawVImage = paletteContent.GetContentImageV(state);
PaletteRelativeAlign drawHShort = paletteContent.GetContentShortTextH(state);
PaletteRelativeAlign drawVShort = paletteContent.GetContentShortTextV(state);
PaletteRelativeAlign drawHLong = paletteContent.GetContentLongTextH(state);
PaletteRelativeAlign drawVLong = paletteContent.GetContentLongTextV(state);
PaletteRelativeAlign posHImage = drawHImage;
PaletteRelativeAlign posHShort = drawHShort;
PaletteRelativeAlign posHLong = drawHLong;
// If positioning in the center, then need extra processing
if (alignH == PaletteRelativeAlign.Center)
{
// Find number of content and width of those in this cell
int totalWidth = 0;
int totalItems = 0;
if (memento.DrawImage && (drawHImage == alignH) && (drawVImage == alignV))
{
totalWidth += memento.ImageRect.Width;
totalItems++;
}
if (memento.DrawShortText && (drawHShort == alignH) && (drawVShort == alignV))
{
totalWidth += memento.ShortTextRect.Width;
totalItems++;
}
if (memento.DrawLongText && (drawHLong == alignH) && (drawVLong == alignV))
{
totalWidth += memento.LongTextRect.Width;
totalItems++;
}
// If more than one item is to be positioned
if (totalItems > 1)
{
// Add on required number of spacing gaps
totalWidth += (totalItems - 1) * spacingGap;
// Then center the space for the content
int halfWidth = (cellRect.Width - totalWidth) / 2;
cellRect.Width -= (halfWidth * 2);
cellRect.X += halfWidth;
// Ensure all content are placed near, so they fit exactly
posHImage = posHShort = posHLong = PaletteRelativeAlign.Near;
}
}
// Do we need to position the image?
if (memento.DrawImage && (drawHImage == alignH) && (drawVImage == alignV))
memento.ImageRect.Location = PositionCellContent(rtl, posHImage, drawVImage, memento.ImageRect.Size, spacingGap, ref cellRect);
// Do we need to position the short text?
if (memento.DrawShortText && (drawHShort == alignH) && (drawVShort == alignV))
memento.ShortTextRect.Location = PositionCellContent(rtl, posHShort, drawVShort, memento.ShortTextRect.Size, spacingGap, ref cellRect);
// Do we need to position the long text?
if (memento.DrawLongText && (drawHLong == alignH) && (drawVLong == alignV))
memento.LongTextRect.Location = PositionCellContent(rtl, posHLong, drawVLong, memento.LongTextRect.Size, spacingGap, ref cellRect);
}
private static void AllocateShortTextSpace(ViewLayoutContext context,
Graphics g,
StandardContentMemento memento,
IPaletteContent paletteContent,
IContentValues contentValues,
PaletteState state,
Rectangle displayRect,
RightToLeft rtl,
int spacingGap,
ref Size[,] allocation,
bool composition,
bool glowing)
{
// By default, we cannot draw the text
memento.DrawShortText = false;
// Get the defined text for display
string shortText = contentValues.GetShortText();
// Is there any text to be drawn?
if ((shortText != null) && (shortText.Length > 0))
{
// If the text is not allowed to span multiple lines
if (paletteContent.GetContentShortTextMultiLine(state) == InheritBool.False)
{
// Replace any carriage returns and newlines with just spaces
shortText = shortText.Replace("\r\n", " ");
shortText = shortText.Replace("\n", " ");
shortText = shortText.Replace("\r", " ");
}
// Convert from alignment enums to integers
int alignHIndex = RightToLeftIndex(rtl, paletteContent.GetContentShortTextH(state));
int alignVIndex = (int)paletteContent.GetContentShortTextV(state);
// Cache the rendering hint used
memento.ShortTextHint = CommonHelper.PaletteTextHintToRenderingHint(paletteContent.GetContentShortTextHint(state));
memento.ShortTextTrimming = paletteContent.GetContentShortTextTrim(state);
bool fontChanged = false;
Font textFont = paletteContent.GetContentShortTextFont(state);
// Get the appropriate font to use in the caption area
if (paletteContent.GetContentStyle() == PaletteContentStyle.HeaderForm)
{
Font captionFont = ContentFontForButtonForm(context, textFont);
fontChanged = (captionFont != textFont);
textFont = captionFont;
}
// Get a pixel accurate measure of text drawing space needed
memento.ShortTextMemento = AccurateText.MeasureString(g,
rtl,
shortText,
textFont,
memento.ShortTextTrimming,
paletteContent.GetContentShortTextMultiLineH(state),
paletteContent.GetContentShortTextPrefix(state),
memento.ShortTextHint,
composition,
glowing,
fontChanged);
// Space required for short text starts with the text width itself
Size requiredSpace = memento.ShortTextMemento.Size;
// Find the space available given our required alignment
if (AllocateAlignmentSpace(alignHIndex, alignVIndex,
allocation, displayRect,
spacingGap, memento.ShortTextTrimming,
ref requiredSpace))
{
// Allocate the actual space used up
// Cache the actual draw size of the text
memento.ShortTextRect.Size = requiredSpace;
// Mark the memento to draw the short text
memento.DrawShortText = true;
}
}
}
/// <summary>
/// Perform layout calculations on the provided content.
/// </summary>
/// <param name="context">Layout context.</param>
/// <param name="availableRect">Display area available for laying out.</param>
/// <param name="palette">Content palette details.</param>
/// <param name="values">Content values.</param>
/// <param name="orientation">Visual orientation of the content.</param>
/// <param name="state">State associated with rendering.</param>
/// <param name="composition">Should draw on a composition element.</param>
/// <param name="glowing">If composition, should glowing be drawn.</param>
/// <returns>Memento with cached information.</returns>
public override IDisposable LayoutContent(ViewLayoutContext context,
Rectangle availableRect,
IPaletteContent palette,
IContentValues values,
VisualOrientation orientation,
PaletteState state,
bool composition,
bool glowing)
{
Debug.Assert(context != null);
Debug.Assert(palette != null);
Debug.Assert(values != null);
// Validate parameter references
if (context == null) throw new ArgumentNullException("context");
if (palette == null) throw new ArgumentNullException("palette");
Debug.Assert(context.Control != null);
Debug.Assert(!context.Control.IsDisposed);
// Remember the original value, for use later
Rectangle cacheDisplayRect = availableRect;
// Grab the padding for the content
Padding borderPadding = palette.GetContentPadding(state);
// Is the content intended for a vertical drawing orientation?
bool vertical = (orientation == VisualOrientation.Left) ||
(orientation == VisualOrientation.Right);
// If we need to apply in a vertical orientation
if (vertical)
{
// Our algorithm only works by assuming a left to right horizontal
// orientation, so we adjust the display rect to that orientation
// and then at the end adjust the memento produced back to the
// required orientation again. 'AdjustForOrientation'
int temp = availableRect.Width;
availableRect.Width = availableRect.Height;
availableRect.Height = temp;
}
// Apply padding to the rectangle
availableRect.X += borderPadding.Left;
availableRect.Y += borderPadding.Top;
availableRect.Width -= borderPadding.Horizontal;
availableRect.Height -= borderPadding.Vertical;
// If we need to apply in a vertical orientation
if (vertical)
{
// This is the display rect we need to use in 'AdjustForOrientation'
// and cache it for later. The displayRect itself is modified during
// the below process and so cannot be used directly.
int temp = cacheDisplayRect.Width;
cacheDisplayRect.Width = cacheDisplayRect.Height;
cacheDisplayRect.Height = temp;
}
// Track the allocated space in each grid position
Size[,] allocation = new Size[3, 3] { { Size.Empty, Size.Empty, Size.Empty },
{ Size.Empty, Size.Empty, Size.Empty },
{ Size.Empty, Size.Empty, Size.Empty } };
// Create a memento to return to caller
StandardContentMemento memento = new StandardContentMemento();
// Cache the size of a spacing gap
int spacingGap = palette.GetContentAdjacentGap(state);
// Drawing vertical means we can ignore right to left, otherwise get value from control
RightToLeft rtl = (vertical ? RightToLeft.No : context.Control.RightToLeft);
// Allocate space for each required content in turn
AllocateImageSpace(memento, palette, values, state, availableRect, rtl, ref allocation);
AllocateShortTextSpace(context, context.Graphics, memento, palette, values, state, availableRect, rtl, spacingGap, ref allocation, composition, glowing);
AllocateLongTextSpace(context, context.Graphics, memento, palette, values, state, availableRect, rtl, spacingGap, ref allocation, composition, glowing);
// Find the width of the columns and heights of the rows
int[] colWidths = AllocatedColumnWidths(allocation, -1);
int[] rowHeights = AllocatedRowHeights(allocation);
// Add up total allocated for rows and columns
int allocatedWidth = AllocatedTotalWidth(allocation, -1, -1, spacingGap);
int allocatedHeight = AllocatedTotalHeight(allocation);
// Excess width to allocate?
if (allocatedWidth < availableRect.Width)
ApplyExcessSpace(availableRect.Width - allocatedWidth, ref colWidths);
// Excess height to allocate?
if (allocatedHeight < availableRect.Height)
rowHeights[1] += (availableRect.Height - allocatedHeight);
// Find x positions and y positions
int col0 = availableRect.Left;
int col1 = col0 + colWidths[0];
// Do we need to add a spacing gap after the first column?
if (((colWidths[0] > 0) && (colWidths[1] > 0)) ||
((colWidths[0] > 0) && (colWidths[1] == 0) && (colWidths[2] > 0)))
col1 += spacingGap;
int col2 = col1 + colWidths[1];
// Do we need to add a spacing gap after the second column?
if ((colWidths[1] > 0) && (colWidths[2] > 0))
col2 += spacingGap;
int row0 = availableRect.Top;
int row1 = row0 + rowHeights[0];
int row2 = row1 + rowHeights[1];
// Decide on the ordering of the alignment to position
PaletteRelativeAlign aAlign = (rtl == RightToLeft.Yes ? PaletteRelativeAlign.Far : PaletteRelativeAlign.Near);
PaletteRelativeAlign bAlign = PaletteRelativeAlign.Center;
PaletteRelativeAlign cAlign = (rtl == RightToLeft.Yes ? PaletteRelativeAlign.Near : PaletteRelativeAlign.Far);
// Size and position the contents of each aligned cell
PositionAlignContent(memento, palette, state, rtl, aAlign, PaletteRelativeAlign.Near, col0, row0, colWidths[0], rowHeights[0], spacingGap);
PositionAlignContent(memento, palette, state, rtl, aAlign, PaletteRelativeAlign.Center, col0, row1, colWidths[0], rowHeights[1], spacingGap);
PositionAlignContent(memento, palette, state, rtl, aAlign, PaletteRelativeAlign.Far, col0, row2, colWidths[0], rowHeights[2], spacingGap);
PositionAlignContent(memento, palette, state, rtl, bAlign, PaletteRelativeAlign.Near, col1, row0, colWidths[1], rowHeights[0], spacingGap);
PositionAlignContent(memento, palette, state, rtl, bAlign, PaletteRelativeAlign.Center, col1, row1, colWidths[1], rowHeights[1], spacingGap);
PositionAlignContent(memento, palette, state, rtl, bAlign, PaletteRelativeAlign.Far, col1, row2, colWidths[1], rowHeights[2], spacingGap);
PositionAlignContent(memento, palette, state, rtl, cAlign, PaletteRelativeAlign.Near, col2, row0, colWidths[2], rowHeights[0], spacingGap);
PositionAlignContent(memento, palette, state, rtl, cAlign, PaletteRelativeAlign.Center, col2, row1, colWidths[2], rowHeights[1], spacingGap);
PositionAlignContent(memento, palette, state, rtl, cAlign, PaletteRelativeAlign.Far, col2, row2, colWidths[2], rowHeights[2], spacingGap);
// Ask the memento to adjust itself for the required orientation
memento.AdjustForOrientation(orientation, cacheDisplayRect);
return memento;
}
private static void AllocateImageSpace(StandardContentMemento memento,
IPaletteContent paletteContent,
IContentValues contentValues,
PaletteState state,
Rectangle displayRect,
RightToLeft rtl,
ref Size[,] allocation)
{
// By default, we cannot draw the image
memento.DrawImage = false;
// Get the image details
memento.Image = contentValues.GetImage(state);
memento.ImageTransparentColor = contentValues.GetImageTransparentColor(state);
// Is there any image to be drawn?
if (memento.Image != null)
{
try
{
// Cache the size of the image
memento.ImageRect.Size = memento.Image.Size;
// Check for enough space to show all of the image
if ((displayRect.Width >= memento.ImageRect.Width) &&
(displayRect.Height >= memento.ImageRect.Height))
{
// Convert from alignment enums to integers
int alignHIndex = RightToLeftIndex(rtl, paletteContent.GetContentImageH(state));
int alignVIndex = (int)paletteContent.GetContentImageV(state);
// Bump the allocated space in the destination grid cell
allocation[alignHIndex, alignVIndex].Width += memento.ImageRect.Width;
allocation[alignHIndex, alignVIndex].Height += memento.ImageRect.Height;
// Yes, we do want to draw the image/icon
memento.DrawImage = true;
}
}
catch
{
// Image is not valid, so do not use it!
memento.Image = null;
memento.DrawImage = false;
}
}
}
/// <summary>
/// Get the preferred size for drawing the content.
/// </summary>
/// <param name="context">Layout context.</param>
/// <param name="palette">Content palette details.</param>
/// <param name="values">Content values.</param>
/// <param name="orientation">Visual orientation of the content.</param>
/// <param name="state">State associated with rendering.</param>
/// <param name="composition">Should draw on a composition element.</param>
/// <param name="glowing">If composition, should glowing be drawn.</param>
/// <returns>Preferred size.</returns>
public override Size GetContentPreferredSize(ViewLayoutContext context,
IPaletteContent palette,
IContentValues values,
VisualOrientation orientation,
PaletteState state,
bool composition,
bool glowing)
{
Debug.Assert(context != null);
Debug.Assert(palette != null);
Debug.Assert(values != null);
// Validate parameter references
if (context == null) throw new ArgumentNullException("context");
if (palette == null) throw new ArgumentNullException("palette");
Debug.Assert(context.Control != null);
Debug.Assert(!context.Control.IsDisposed);
// Provide a maximum sized rectangle for placing content into, in
// order to work out how much of the space is actually allocated
Rectangle displayRect = new Rectangle(Point.Empty, new Size(int.MaxValue, int.MaxValue));
// Track the allocated space in each grid position
Size[,] allocation = new Size[3, 3] { { Size.Empty, Size.Empty, Size.Empty },
{ Size.Empty, Size.Empty, Size.Empty },
{ Size.Empty, Size.Empty, Size.Empty } };
// Create a memento for storing calculations
using (StandardContentMemento memento = new StandardContentMemento())
{
// Cache the size of a spacing gap
int spacingGap = palette.GetContentAdjacentGap(state);
// Is the content intended for a vertical drawing orientation?
bool vertical = (orientation == VisualOrientation.Left) ||
(orientation == VisualOrientation.Right);
// Drawing vertical means we can ignore right to left, otherwise get value from control
RightToLeft rtl = (vertical ? RightToLeft.No : context.Control.RightToLeft);
// Allocate space for each required content in turn
AllocateImageSpace(memento, palette, values, state, displayRect, rtl, ref allocation);
AllocateShortTextSpace(context, context.Graphics, memento, palette, values, state, displayRect, rtl, spacingGap, ref allocation, composition, glowing);
AllocateLongTextSpace(context, context.Graphics, memento, palette, values, state, displayRect, rtl, spacingGap, ref allocation, composition, glowing);
// Add up total allocated for rows and columns
int allocatedWidth = AllocatedTotalWidth(allocation, -1, -1, spacingGap);
int allocatedHeight = AllocatedTotalHeight(allocation);
// Grab the padding for the content
Padding borderPadding = palette.GetContentPadding(state);
// For the form level buttons we have to calculate the correct padding based on caption area
PaletteContentStyle contentStyle = palette.GetContentStyle();
if ((contentStyle == PaletteContentStyle.ButtonForm) ||
(contentStyle == PaletteContentStyle.ButtonFormClose))
borderPadding = ContentPaddingForButtonForm(borderPadding, context, allocatedHeight);
// The preferred size needed depends on the orientation.
switch (orientation)
{
case VisualOrientation.Top:
case VisualOrientation.Bottom:
// Preferred size is the allocated space for the content plus the border padding
return new Size(allocatedWidth + borderPadding.Horizontal,
allocatedHeight + borderPadding.Vertical);
case VisualOrientation.Left:
case VisualOrientation.Right:
// Preferred size is the allocated space for the content plus the border padding
return new Size(allocatedHeight + borderPadding.Vertical,
allocatedWidth + borderPadding.Horizontal);
default:
// Should never happen!
Debug.Assert(false);
return Size.Empty;
}
}
}
