Java Doc for Area.java in  » Chart » Chart2D_1.9.6k » net » sourceforge » chart2d » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Basic Sizing and Colors:
The typical bordered area class will simply paint a border of a specified thickness within an area, where the inner edges of the area touch the outer edges of the border. This class can do much more. Each border can be set to a different thickness and color. This introduces the problem of handling the corners of the borders. If the left border has color green, and the top border has color red, which color is the top left corner? Each corner can be associated with any adjacent border.

Inner Space And Gaps:
Sometimes, some space between the thing bordered and the border is desired. That is, if bordering some text, then having some space between the text and the border may be desirable. The thickness of the gap between the the left, right, top, and bottom borders may each be individually set. The location and size of this inner space may be obtained directly.

Resizing And Growing Borders And Gaps:
The borders and gaps can automatically grow when the size is changed. In order to maintain the look of zooming in on something, the borders and gaps can grow with the resizing of the area. For example, if the area grows in the horizontal direction, then the left and right borders and gaps will grow respective of the amount of change in the area width, depending on this classes settings. If keeping any of the borders equal to any of the others is desireable, such as a "grow only when all grow" policy, then any border may be associated with any other border. The sizes of the associated borders will be equal to the least of them.

More Basics:
This area can have a background color, or no background at all. And each border and gap can be set to not exist, individually.

Locating: Automatically and Manually:
Sometimes the size of component to be bordered cannot be known until after the borders and gaps have been calculated (relevant when using growing borders and gaps). This class allows the available space, after subtracting borders and gaps, to obtained. The size of the component to be bordered can then be calculated, making sure it fits within this space. The size of the component can be passed to this class, this class will place the gaps and borderes around the component for a (near) perfect fit. This means that where to place this bordered area within the maximum area is an open question. This class allows options of automatic centering (both horizontally and vertically, justifying to the left, right, top, and/or bottom edges of the maximum area, and doing nothing such that the area can be manually set, and any combination thereof.

Examples:

• No Growing And Border Encloses Maximum Area:
  setAutoSizes (true, true);
• Growing And Border Encloses Maximum Area:
  setAutoSizes (false, true);
• No Growing, Border Encloses Minimum Area, And Centered:
  setAutoSizes (true, false);
setAutoJustifys (true, true);
setJustifications (CENTER, CENTER);
• Growing, Border Encloses Minimum Area, And Manually Located:
  setAutoSizes (false, false);
setAutoJustifys (false, false);

Details Of Growing:
Growing is based on "model" sizes. By default, everything has a model size (the area, the borders, and the gaps). The defaults currently are the first maximum size setting for the area, 2 (for all borders), and 2 (for all gaps). Growing is accomplished by dividing the maximum area size by the model area size and applying this ratio the border and gap thicknesses. If growing in the horizontal direction, the width sizes are used. If growing in the vertical direction, the height sizes are used. If growing in both directions, then both are calculated and the lesser is used. However, all of these values can be changed. Ideally, one would set the model area size to your normal viewing size, and all of the inner components model sizes (borders and thicknesses) to the best sizes at this model area size. However, just setting the model area size to the normal viewing size of the area most likely will be sufficient. Generally, the initial size is the normal size, do set the model size to the initial size, use the resetAreaModel method before setting the maximum size. When you set the maximum size, the area model size will automatically reset itself to this size.

Notes:

• This class assumes no null values. Pass zero based values intead. For example, new Point() instead of null.
• Both Growing and shrinking are supported, and are the same. When is written, in these comments, gowing and shrinking is meant.