net.sf.latexdraw.instruments
Class ShapeGridCustomiser

java.lang.Object
  extended by org.malai.instrument.Instrument
      extended by org.malai.instrument.WidgetInstrument
          extended by net.sf.latexdraw.instruments.ShapePropertyCustomiser
              extended by net.sf.latexdraw.instruments.ShapeGridCustomiser
All Implemented Interfaces:
ActionHandler, Preferenciable, Modifiable, Reinitialisable, UndoHandler

public class ShapeGridCustomiser
extends ShapePropertyCustomiser

This instrument modifies the parameters of grids and axes.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
LaTeXDraw is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

12/23/2011

Since:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
private static class ShapeGridCustomiser.CheckBox2ModifyPencilGrid
          The link that maps a checkbox to an action that modifies the pencil.
private static class ShapeGridCustomiser.CheckBox2ModifySelectionGrid
          The link that maps a checkbox to an action that modifies the selection.
private static class ShapeGridCustomiser.CheckBox4ShapeGridCust<A extends ShapePropertyAction>
           
private static class ShapeGridCustomiser.Spinner2ModifyGridCoords<A extends ShapePropertyAction>
           
private static class ShapeGridCustomiser.Spinner2ModifyPencilGridCoords
          The link that maps a spinner to an action that modifies the pencil.
private static class ShapeGridCustomiser.Spinner2ModifySelectionGridCoords
          The link that maps a spinner to an action that modifies the selected shapes.
 
Field Summary
protected  MSpinner labelsSizeS
          The field that sets the size of the labels of the grid.
protected  MToggleButton labelsXInvertedCB
          The field that defines the X-coordinates of the labels.
protected  MToggleButton labelsYInvertedCB
          The field that defines the Y-coordinates of the labels.
protected  MSpinner xEndS
          The field that sets the X-coordinate of the ending point of the grid.
protected  MSpinner xOriginS
          The field that sets the X-coordinate of the origin point of the grid.
protected  MSpinner xStartS
          The field that sets the X-coordinate of the starting point of the grid.
protected  MSpinner yEndS
          The field that sets the Y-coordinate of the ending point of the grid.
protected  MSpinner yOriginS
          The field that sets the Y-coordinate of the origin point of the grid.
protected  MSpinner yStartS
          The field that sets the Y-coordinate of the starting point of the grid.
 
Fields inherited from class net.sf.latexdraw.instruments.ShapePropertyCustomiser
hand, pencil
 
Fields inherited from class org.malai.instrument.WidgetInstrument
composer
 
Fields inherited from class org.malai.instrument.Instrument
activated, eventables, links, modified
 
Constructor Summary
ShapeGridCustomiser(UIComposer<?> composer, Hand hand, Pencil pencil)
          Creates the instrument.
 
Method Summary
 MSpinner getLabelsSizeS()
           
 MToggleButton getLabelsXInvertedCB()
           
 MToggleButton getLabelsYInvertedCB()
           
 MSpinner getxEndS()
           
 MSpinner getxOriginS()
           
 MSpinner getxStartS()
           
 MSpinner getyEndS()
           
 MSpinner getyOriginS()
           
 MSpinner getyStartS()
           
protected  void initialiseLinks()
          Initialises the links of the instrument.
protected  void initialiseWidgets()
          Initialises the widgets of the instrument.
protected  void setWidgetsVisible(boolean visible)
          Sets the widgets of the instrument visible or not.
protected  void update(IShape shape)
          Updates the widgets using the given shape.
 
Methods inherited from class net.sf.latexdraw.instruments.ShapePropertyCustomiser
getHand, getPencil, onActionExecuted, onUndoableRedo, onUndoableUndo, setActivated, update
 
Methods inherited from class org.malai.instrument.WidgetInstrument
getComposer, setActivated
 
Methods inherited from class org.malai.instrument.Instrument
addEventable, addLink, clearEvents, getLinks, getSizeLinks, hasLinks, interimFeedback, isActivated, isModified, load, onActionAborted, onActionAdded, onActionCancelled, onActionDone, onUndoableAdded, reinit, removeLink, save, setModified
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

xStartS

protected MSpinner xStartS
The field that sets the X-coordinate of the starting point of the grid.


yStartS

protected MSpinner yStartS
The field that sets the Y-coordinate of the starting point of the grid.


xEndS

protected MSpinner xEndS
The field that sets the X-coordinate of the ending point of the grid.


yEndS

protected MSpinner yEndS
The field that sets the Y-coordinate of the ending point of the grid.


labelsSizeS

protected MSpinner labelsSizeS
The field that sets the size of the labels of the grid.


labelsYInvertedCB

protected MToggleButton labelsYInvertedCB
The field that defines the Y-coordinates of the labels.


labelsXInvertedCB

protected MToggleButton labelsXInvertedCB
The field that defines the X-coordinates of the labels.


xOriginS

protected MSpinner xOriginS
The field that sets the X-coordinate of the origin point of the grid.


yOriginS

protected MSpinner yOriginS
The field that sets the Y-coordinate of the origin point of the grid.

Constructor Detail

ShapeGridCustomiser

public ShapeGridCustomiser(UIComposer<?> composer,
                           Hand hand,
                           Pencil pencil)
Creates the instrument.

Parameters:
composer - The composer that manages the widgets of the instrument.
hand - The Hand instrument.
pencil - The Pencil instrument.
Throws:
java.lang.IllegalArgumentException - If one of the given parameters is null.
Since:
3.0
Method Detail

update

protected void update(IShape shape)
Description copied from class: ShapePropertyCustomiser
Updates the widgets using the given shape.

Specified by:
update in class ShapePropertyCustomiser
Parameters:
shape - The shape used to update the widgets. If null, nothing is performed.

setWidgetsVisible

protected void setWidgetsVisible(boolean visible)
Description copied from class: ShapePropertyCustomiser
Sets the widgets of the instrument visible or not.

Specified by:
setWidgetsVisible in class ShapePropertyCustomiser
Parameters:
visible - True: they are visible.

initialiseWidgets

protected void initialiseWidgets()
Description copied from class: WidgetInstrument
Initialises the widgets of the instrument.

Specified by:
initialiseWidgets in class WidgetInstrument

initialiseLinks

protected void initialiseLinks()
Description copied from class: Instrument
Initialises the links of the instrument.

Specified by:
initialiseLinks in class Instrument

getxStartS

public MSpinner getxStartS()
Returns:
The field that sets the X-coordinate of the starting point of the grid.
Since:
3.0

getyStartS

public MSpinner getyStartS()
Returns:
The field that sets the Y-coordinate of the starting point of the grid.
Since:
3.0

getxEndS

public MSpinner getxEndS()
Returns:
The field that sets the X-coordinate of the ending point of the grid.
Since:
3.0

getyEndS

public MSpinner getyEndS()
Returns:
The field that sets the Y-coordinate of the ending point of the grid.
Since:
3.0

getxOriginS

public MSpinner getxOriginS()
Returns:
The field that sets the X-coordinate of the origin point of the grid.
Since:
3.0

getyOriginS

public MSpinner getyOriginS()
Returns:
The field that sets the Y-coordinate of the origin point of the grid.
Since:
3.0

getLabelsSizeS

public MSpinner getLabelsSizeS()
Returns:
The field that sets the size of the labels of the grid.
Since:
3.0

getLabelsYInvertedCB

public MToggleButton getLabelsYInvertedCB()
Returns:
The field that defines the Y-coordinates of the labels.
Since:
3.0

getLabelsXInvertedCB

public MToggleButton getLabelsXInvertedCB()
Returns:
The field that defines the X-coordinates of the labels.
Since:
3.0