net.sf.latexdraw.instruments
Class ShapeDotCustomiser

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.ShapeDotCustomiser
All Implemented Interfaces:
ActionHandler, Preferenciable, Modifiable, Reinitialisable, UndoHandler

public class ShapeDotCustomiser
extends ShapePropertyCustomiser

This instrument modifies dot parameters.

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.

08/10/2011

Since:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
private static class ShapeDotCustomiser.FillingButton2PencilFilling
          This link maps a colour button to the pencil.
private static class ShapeDotCustomiser.FillingButton2SelectionFilling
          This link maps a colour button to the pencil.
private static class ShapeDotCustomiser.List2PencilDotStyle
          This link maps a list to a ModifyPencil action.
private static class ShapeDotCustomiser.List2SelectionDotStyle
          This link maps a list to a ModifyShape action.
private static class ShapeDotCustomiser.Spinner2PencilDotSize
          This link maps a spinner to a ModifyPencil action.
private static class ShapeDotCustomiser.Spinner2SelectionDotSize
          This link maps a spinner to a ModifyPencil action.
 
Field Summary
protected  MComboBox dotCB
          Allows the selection of a dot shape.
protected  MSpinner dotSizeField
          Allows to define the size of a dot.
protected  MColorButton fillingB
          Changes the colour of the filling of the dot.
 
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
ShapeDotCustomiser(UIComposer<?> composer, Hand hand, Pencil pencil)
          Creates the instrument.
 
Method Summary
static MComboBox createDotStyleChoice()
          Creates a list of the different styles of the dot.
 MComboBox getDotCB()
           
 MSpinner getDotSizeField()
           
 MColorButton getFillingB()
           
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

dotSizeField

protected MSpinner dotSizeField
Allows to define the size of a dot.


dotCB

protected MComboBox dotCB
Allows the selection of a dot shape.


fillingB

protected MColorButton fillingB
Changes the colour of the filling of the dot.

Constructor Detail

ShapeDotCustomiser

public ShapeDotCustomiser(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

initialiseWidgets

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

Specified by:
initialiseWidgets in class WidgetInstrument

createDotStyleChoice

public static MComboBox createDotStyleChoice()
Creates a list of the different styles of the dot.

Returns:
The created list.

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.

initialiseLinks

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

Specified by:
initialiseLinks in class Instrument

getDotSizeField

public MSpinner getDotSizeField()
Returns:
The dot size field.
Since:
3.0

getDotCB

public MComboBox getDotCB()
Returns:
The dot style combo box.
Since:
3.0

getFillingB

public MColorButton getFillingB()
Returns:
the button that changes the colour of the filling of dots.
Since:
3.0