Back to index

wims  3.65+svn20090927
Public Member Functions | Protected Attributes
fr.ove.openmath.jome.ctrlview.bidim.OneFormulaLayout Class Reference

A layout manager that lays the display of a formula. More...

Inheritance diagram for fr.ove.openmath.jome.ctrlview.bidim.OneFormulaLayout:
Inheritance graph
[legend]
Collaboration diagram for fr.ove.openmath.jome.ctrlview.bidim.OneFormulaLayout:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Dimension computeAttributes ()
 Computes the size of the display according to its children size (if any), and its different attributes.
void selectDisplay ()
 Selects the display (and its children if any)
void deselectDisplay ()
 Deselects the display.
void validateSelection ()
 Checks the validity of the selection.
void validateDeselection (Display display)
 Checks the validity of the deselection.
void rebuildDisplay ()
 The display needs to be rebuilt.
void layoutContainer (Container parent)
void initDisplay (Display displayToLay)
 According to the operator, the layout manager has to add some components (e.g.
boolean selectLeftDisplay ()
 Returns true if during the selection, the display which is located to the left of the display that the instance lays, must be selected too.
boolean selectRightDisplay ()
 Returns true if during the selection, the display which is located to the right of the display that the instance lays, must be selected too.
void updateLevel (int level)
 Updates the level of the display laid out.
void addLayoutComponent (String name, Component comp)
 Adds the specified component with the specified name to the layout.
void addLayoutComponent (Component comp, Object constraints)
 Adds the specified component to the layout, using the specified constraint object.
void removeLayoutComponent (Component comp)
 Removes the specified component from the layout.
Dimension minimumLayoutSize (Container parent)
 Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.
Dimension preferredLayoutSize (Container parent)
 Calculates the preferred size dimensions for the specified panel given the components in the specified parent container.
Dimension maximumLayoutSize (Container target)
 Returns the maximum size of this component.
float getLayoutAlignmentX (Container target)
 Returns the alignment along the x axis.
float getLayoutAlignmentY (Container target)
 Returns the alignment along the y axis.
void invalidateLayout (Container target)
 Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Protected Attributes

Display displayToLay = null
 The display laid out by the instance.

Detailed Description

A layout manager that lays the display of a formula.

Author:
© 1999 DIRAT Laurent
Version:
2.0 22/07/1999

Definition at line 43 of file OneFormulaLayout.java.


Member Function Documentation

void fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.addLayoutComponent ( String  name,
Component  comp 
) [inline, inherited]

Adds the specified component with the specified name to the layout.

Parameters:
namethe component name
compthe component to be added

Definition at line 189 of file DisplayLayout.java.

                                                                {
    }
void fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.addLayoutComponent ( Component  comp,
Object  constraints 
) [inline, inherited]

Adds the specified component to the layout, using the specified constraint object.

Parameters:
compthe component to be added
constraintswhere/how the component is added to the layout.

Definition at line 236 of file DisplayLayout.java.

                                                                       {
           if (!(constraints instanceof Display))
              throw new IllegalArgumentException("The component to add must be a Display instance !!!");
    }

Computes the size of the display according to its children size (if any), and its different attributes.

Returns:
the size of the display.

Implements fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 49 of file OneFormulaLayout.java.

                                         {
        int width = 10;  // Ca c'est parce que c'est la taille préferée du display de la formule
        int height = 10; // faudra voir de modifier ça de manière plus propre.
        
        if (displayToLay.getComponentCount() != 0) {
            updateLevel(displayToLay.getLevel());
            Display display = (Display) displayToLay.getComponent(0);
            display.setSize(display.getPreferredSize());
            width = 2*display.getShiftX() + display.getWidth();
            height = 2*display.getShiftY() + display.getHeight();

            displayToLay.setAscent(display.getShiftY() + display.getAscent());
            displayToLay.setDescent(height - display.getAscent());
            
            displayToLay.setSize(width , height);
            displayToLay.setComputeAttributes(false);
        }
        
        return new Dimension(width , height);
    }

Here is the call graph for this function:

Deselects the display.

Parameters:
thedisplay to deselect.

Reimplemented from fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 91 of file OneFormulaLayout.java.

                                  {
        Display display = (Display) displayToLay.getComponent(0);
        display.deselect();
        
        SelectionEvent selEvt = new SelectionEvent(display);
        selEvt.setAction(SelectionEvent.PURGE, null);
        display.fireSelectionEvent(selEvt);
    }

Here is the call graph for this function:

float fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.getLayoutAlignmentX ( Container  target) [inline, inherited]

Returns the alignment along the x axis.

This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Definition at line 258 of file DisplayLayout.java.

                                                       {
        return 0.0f;
    }
float fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.getLayoutAlignmentY ( Container  target) [inline, inherited]

Returns the alignment along the y axis.

This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Definition at line 269 of file DisplayLayout.java.

                                                       {
        return 0.0f;
    }
void fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.initDisplay ( Display  displayToLay) [inline, inherited]

According to the operator, the layout manager has to add some components (e.g.

brackets, ...) or has to perform some "re-oganisation" before rendering.
As soon as the layout manager is set to the display, this mehtod MUST be called with the display laid out as parameter. This method serves as well as a registering method. So all sub-classes of the instance MUST call super.initDisplay(displayToLay).

Parameters:
displayToLaythe display laid by the instance

Reimplemented in fr.ove.openmath.jome.ctrlview.bidim.EnclosingLayout, fr.ove.openmath.jome.ctrlview.bidim.SuperposedOperatorLayout, fr.ove.openmath.jome.ctrlview.bidim.VarDiffLayout, fr.ove.openmath.jome.ctrlview.bidim.MapsArrayLayout, fr.ove.openmath.jome.ctrlview.bidim.MapsToSigmaLayout, fr.ove.openmath.jome.ctrlview.bidim.IntegralLayout, fr.ove.openmath.jome.ctrlview.bidim.Mfd2SubstitutionLayout, fr.ove.openmath.jome.ctrlview.bidim.HorizontalListLayout, fr.ove.openmath.jome.ctrlview.bidim.DifferentiationLayout, fr.ove.openmath.jome.ctrlview.bidim.IntervalLayout, fr.ove.openmath.jome.ctrlview.bidim.LambdaExpLayout, fr.ove.openmath.jome.ctrlview.bidim.BetweenOperatorLayout, fr.ove.openmath.jome.ctrlview.bidim.EnumerationLayout, fr.ove.openmath.jome.ctrlview.bidim.FunctionLayout, fr.ove.openmath.jome.ctrlview.bidim.RootLayout, fr.ove.openmath.jome.ctrlview.bidim.LimitLayout, and fr.ove.openmath.jome.ctrlview.bidim.UnaryOperatorLayout.

Definition at line 58 of file DisplayLayout.java.

Here is the caller graph for this function:

void fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.invalidateLayout ( Container  target) [inline, inherited]

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Definition at line 277 of file DisplayLayout.java.

                                                   {
    }

Definition at line 134 of file OneFormulaLayout.java.

                                                   {
        // Ca c'est parce que c'est le layout manager de la formule. Et comme personne ne dit au container
        // contenant la formule, que la taille de la formule a besoin d'être recalculée, il faut bien le
        // faire qque part. Chaque display informe son père qu'il doit être recalculé, mais la formule ne
        // le fait pas pour le sien.
        parent.setSize(parent.getPreferredSize());
        
        if (parent.getComponentCount() != 0) {
            // On est obligé de faire ce test car comme lorsque la formule est "vide", on ne met pas template,
            // parent ne contient aucun display fils.
            
            Display display = (Display) parent.getComponent(0);
            display.setSize(display.getPreferredSize());
            display.setLocation(display.getShiftX(), display.getShiftY());

            // On place maintenant les éventuels display enfants du display courant
            display.doLayout();
        }
    }

Here is the call graph for this function:

Dimension fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.maximumLayoutSize ( Container  target) [inline, inherited]

Returns the maximum size of this component.

See also:
java.awt.Component::getMinimumSize()
java.awt.Component::getPreferredSize()
LayoutManager

Definition at line 247 of file DisplayLayout.java.

                                                         {
        return preferredLayoutSize(target);
    }

Here is the call graph for this function:

Dimension fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.minimumLayoutSize ( Container  parent) [inline, inherited]

Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.

Parameters:
parentthe component to be laid out
See also:
preferredLayoutSize

Definition at line 205 of file DisplayLayout.java.

                                                         {
        return preferredLayoutSize(parent);
    }

Here is the call graph for this function:

Dimension fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.preferredLayoutSize ( Container  parent) [inline, inherited]

Calculates the preferred size dimensions for the specified panel given the components in the specified parent container.

Parameters:
parentthe component to be laid out
See also:
minimumLayoutSize

Definition at line 216 of file DisplayLayout.java.

                                                           {
        if (((Display) parent).getComputeAttributes())
            return computeAttributes();
        else
            return parent.getSize();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

The display needs to be rebuilt.

We do this.

Implements fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 116 of file OneFormulaLayout.java.

                                 {
        // La taille des displays est probablement différente de ceux qui étaient
        // précédemment. On demande alors le recalcul des display ancêtres.
        displayToLay.computeAncestorsAttributes();
    }

Here is the call graph for this function:

Removes the specified component from the layout.

Parameters:
compthe component ot be removed

Definition at line 196 of file DisplayLayout.java.

                                                      {
    }

Selects the display (and its children if any)

Parameters:
thedisplay to select.

Reimplemented from fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 74 of file OneFormulaLayout.java.

                                {
        Display display = (Display) displayToLay.getComponent(0);
        display.select();
        
        SelectionEvent selEvt = new SelectionEvent(display);
        // On purge la liste des éléments sélectionnés.
        selEvt.setAction(SelectionEvent.PURGE, null);
        display.fireSelectionEvent(selEvt);
        selEvt.setAction(SelectionEvent.ADD, display);
        display.fireSelectionEvent(selEvt);
    }

Here is the call graph for this function:

Returns true if during the selection, the display which is located to the left of the display that the instance lays, must be selected too.

false otherwise.

Reimplemented in fr.ove.openmath.jome.ctrlview.bidim.LeftAssocPrefixedUnaryOperatorLayout, and fr.ove.openmath.jome.ctrlview.bidim.StringLayout.

Definition at line 68 of file DisplayLayout.java.

                                       {
        return false;
    }

Here is the caller graph for this function:

Returns true if during the selection, the display which is located to the right of the display that the instance lays, must be selected too.

false otherwise.

Reimplemented in fr.ove.openmath.jome.ctrlview.bidim.StringLayout.

Definition at line 77 of file DisplayLayout.java.

                                        {
        return false;
    }

Here is the caller graph for this function:

void fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.updateLevel ( int  level) [inline, inherited]

Updates the level of the display laid out.

Parameters:
displaythe display laid out
levelthe level put to the display.

Reimplemented in fr.ove.openmath.jome.ctrlview.bidim.LimitLayout, fr.ove.openmath.jome.ctrlview.bidim.RootLayout, fr.ove.openmath.jome.ctrlview.bidim.IntegralLayout, fr.ove.openmath.jome.ctrlview.bidim.MapsArrayLayout, fr.ove.openmath.jome.ctrlview.bidim.MapsToSigmaLayout, fr.ove.openmath.jome.ctrlview.bidim.ScriptLayout, and fr.ove.openmath.jome.ctrlview.bidim.AbstractStringLayout.

Definition at line 126 of file DisplayLayout.java.

                                       {
        Display tmp;
        
        if (displayToLay.getUpdateLevel()) {
            // On met le niveau adéquat
            displayToLay.setLevel(level);
            // On scale le display en fonction du niveau
            displayToLay.scaleDisplay();
            // On n'a plus besoin de mettre à jour le niveau de l'instance
            displayToLay.setUpdateLevel(false);
            // Le comportement par défaut est que les displays enfant de l'instance courante
            // ont le même niveau que leur père.
            int count = displayToLay.getComponentCount();
            for (int i = 0; i < count; i++) {
                tmp = (Display) displayToLay.getComponent(i);
                ((DisplayLayout) tmp.getLayout()).updateLevel(level);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Checks the validity of the deselection.

Parameters:
displaythe display to deselect.

Implements fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 110 of file OneFormulaLayout.java.

                                                     {
    }

Checks the validity of the selection.

Implements fr.ove.openmath.jome.ctrlview.bidim.DisplayLayout.

Definition at line 103 of file OneFormulaLayout.java.

                                    {
    }

Member Data Documentation

The display laid out by the instance.

Definition at line 47 of file DisplayLayout.java.


The documentation for this class was generated from the following file: