LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.control.builder
Class LyAreaBuilder

java.lang.Object
  extended by leon.control.builder.LyBuilder
      extended by leon.control.builder.LyAreaBuilder
Direct Known Subclasses:
LyCanvasBuilder, LyChartBuilder, LyCreateStickerBuilder, LyExportBuilder, LyFilterEditorBuilder, LyFormBuilder, LyGraphicalChartBuilder, LyImportBuilder, LyMailBuilder, LyMultiAreaBuilder, LyOutlineBuilder, LyPanelBuilder, LyReportingBuilder, LyShowUrlBuilder, LySortWizardBuilder, LyTabAreaBuilder, LyTextBuilder, LyUserInputBuilder, LyWaitBuilder

public abstract class LyAreaBuilder
extends LyBuilder

This class implements a basic builder for all controller based on a LyAreaController. It handles all common components (toolbar, titlebar messages bar, menubar...)

See Also:
LyAreaController

Field Summary
static java.lang.String __VERSION
          File version
 
Constructor Summary
LyAreaBuilder(LyController parent)
          Default constructor.
 
Method Summary
 LyComponent buildComponent()
          Builds the view component for the specified parent controller.
 void completeMenuBar(LyMenuBar menuBar, int level)
          This method is invoked to enable the the area to complete the menuBar of the view and add its own menu items.
 void completeMessages(LyMessages messages, int level)
          This method is invoked to enable the the area(s) to complete the message bar of the view and add its own message items.
 java.lang.String getRightLabel()
          Gets right label set by setTitleBarParameters.
 void setTitleBarParameters(java.lang.String leftLabel, java.lang.String centerLabel, java.lang.String rightLabel, java.lang.String leftImage, java.lang.String rightImage)
          Deprecated. Use behavior
 LyArea updateSelectFile(java.lang.String prefix)
          Updates the list of all data files.
 void updateTitleBar()
          Update titlebar and set default content.
 
Methods inherited from class leon.control.builder.LyBuilder
build, getComponent, getParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Constructor Detail

LyAreaBuilder

public LyAreaBuilder(LyController parent)
Default constructor.

Parameters:
parent - parent controller
Method Detail

buildComponent

public LyComponent buildComponent()
Builds the view component for the specified parent controller.

Overrides:
buildComponent in class LyBuilder
Returns:
the view Component

setTitleBarParameters

public void setTitleBarParameters(java.lang.String leftLabel,
                                  java.lang.String centerLabel,
                                  java.lang.String rightLabel,
                                  java.lang.String leftImage,
                                  java.lang.String rightImage)
Deprecated. Use behavior

This method allows to set title labels and icons.

Parameters:
leftLabel - the left label
centerLabel - the center label
rightLabel - the right label
leftImage - the left image
rightImage - the right image

updateTitleBar

public void updateTitleBar()
Update titlebar and set default content.


updateSelectFile

public LyArea updateSelectFile(java.lang.String prefix)
Updates the list of all data files.

Parameters:
prefix - The prefix of the files.
Returns:
an area containing the list of files.

completeMenuBar

public void completeMenuBar(LyMenuBar menuBar,
                            int level)
This method is invoked to enable the the area to complete the menuBar of the view and add its own menu items. Default implementation invokes the method on the builder instance.

Parameters:
menuBar - the menuBar structure
level - : level of current Controller. one of the LEVEL_XXX contants in LyViewController
See Also:
LyViewController

completeMessages

public void completeMessages(LyMessages messages,
                             int level)
This method is invoked to enable the the area(s) to complete the message bar of the view and add its own message items. Default implementation invokes the method on the builder instance.

Parameters:
messages - the message bar structure
level - : level of current Controller. one of the LEVEL_XXX contants. in LyViewController
See Also:
LyViewController

getRightLabel

public final java.lang.String getRightLabel()
Gets right label set by setTitleBarParameters.

Returns:
the right label

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com