LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyView

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyView
All Implemented Interfaces:
LyGetBoundsInterface, LyGetControllerInterface, LyGetIdInterface, LySetBoundsInterface, LySetVisibleInterface, LySetWaitingInterface
Direct Known Subclasses:
LyDialogBase, LyFrameBase

public abstract class LyView
extends LyComponent
implements LyGetIdInterface, LyGetControllerInterface, LySetVisibleInterface, LyGetBoundsInterface, LySetBoundsInterface, LySetWaitingInterface

This class implements the common description of a Frame object and a Dialog object as described in the dtd.

See Also:
LyComponent

Nested Class Summary
 
Nested classes/interfaces inherited from class leon.view.LyComponent
LyComponent.EventType
 
Field Summary
static java.lang.String __VERSION
           
static int _nbViews
          Number of views for debug.
 
Fields inherited from class leon.view.LyComponent
_nbComponents, INIT_RESOURCE_ID, INTERNAL_ID_SEP, REWRITING_MODE, SEP_ID
 
Constructor Summary
LyView()
          Default constructor.
LyView(LyEnvironment environment)
          Constructor.
 
Method Summary
 void free()
          Free this view.
abstract  LyArea getArea()
          Get sub-component Area.
abstract  java.lang.String getController()
          Gets value of controller.
 LyEnvironment getEnvironment()
          Returns the component environment.
abstract  java.lang.String getId()
          Gets value of id.
 int[] getLocation()
          Accessor to the location.
abstract  int getMinHeight()
          Gets value of minHeight.
abstract  int getMinWidth()
          Gets value of minWidth.
 int[] getSize()
          Accessor to the Size.
abstract  boolean isResizable()
          Checks if value of attribute resizable is set.
 boolean isVisible()
          Checks if the component is visible or not.
abstract  void setArea(LyArea area)
          Sets sub-component area.
 void setEnvironment(LyEnvironment environment)
           
abstract  void setLabel(java.lang.String label)
          Sets title of this view.
 void setLocation(int x, int y)
          Accessor to the location.
abstract  void setResizable(boolean resizable)
          Change resizable state on this view.
 void setSize(int w, int h)
          Accessor to the Size.
 void setVisible(boolean status)
          Shows or hides the component/node.
 void setWaiting(boolean status)
          Update the waiting status of current view.
 void writeXml(java.lang.String file, boolean debug, boolean fullView)
          Write XML description of this view.
 
Methods inherited from class leon.view.LyComponent
addComponent, addData, addEventFunction, clearChildrenBounds, cloneComponent, freeze, getBounds, getChild, getChildCount, getChildFromCache, getChildrenBounds, getComponent, getComponent, getComponent, getComponent, getComponent, getComponentAt, getComponentAt, getComponentByInternalId, getComponentByLabel, getComponents, getComponentWithModel, getData, getDatas, getEventFunctions, getIdCode, getInternalId, getInternalView, getInternalView, getLock, getModel, getParent, getParentArea, getParentForm, getParentFormFieldId, getParentSplitter, getParentSplitter, getParentTab, getParentTab, getParentTabs, getParentTabs, getParentView, getRootController, getSetVisibleParent, getTag, getViewManager, isFreed, isFreeing, registerChildrenBounds, removeComponent, reset, resetChildrenCache, resetEventFunctions, setDatas, setInternalView, useEventDefaultFunction, writeXml, writeXml
 
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
See Also:
Constant Field Values

_nbViews

public static int _nbViews
Number of views for debug.

Constructor Detail

LyView

public LyView()
Default constructor.


LyView

public LyView(LyEnvironment environment)
Constructor.

Method Detail

setEnvironment

public void setEnvironment(LyEnvironment environment)

getEnvironment

public LyEnvironment getEnvironment()
Description copied from class: LyComponent
Returns the component environment.

Overrides:
getEnvironment in class LyComponent

setVisible

public void setVisible(boolean status)
Shows or hides the component/node.

Specified by:
setVisible in interface LySetVisibleInterface
Overrides:
setVisible in class LyComponent
Parameters:
status - new visibility status
See Also:
LySetVisibleInterface.setVisible(boolean)

isVisible

public boolean isVisible()
Checks if the component is visible or not.

Returns:
true if the component is showing (a visible component is never freed()).
See Also:
LySetVisibleInterface.setVisible(boolean)

setLocation

public void setLocation(int x,
                        int y)
Accessor to the location.

Specified by:
setLocation in interface LySetBoundsInterface
See Also:
LySetBoundsInterface.setLocation(int, int)

setSize

public void setSize(int w,
                    int h)
Accessor to the Size.

Specified by:
setSize in interface LySetBoundsInterface
See Also:
LySetBoundsInterface.setSize(int, int)

getLocation

public int[] getLocation()
Accessor to the location.

Specified by:
getLocation in interface LyGetBoundsInterface
See Also:
LyGetBoundsInterface.getLocation()

getSize

public int[] getSize()
Accessor to the Size.

Specified by:
getSize in interface LyGetBoundsInterface
See Also:
LyGetBoundsInterface.getSize()

setWaiting

public void setWaiting(boolean status)
Update the waiting status of current view.

Specified by:
setWaiting in interface LySetWaitingInterface
Parameters:
status - the new status
See Also:
LySetWaitingInterface.setWaiting(boolean)

free

public void free()
Free this view.

Overrides:
free in class LyComponent

getId

public abstract java.lang.String getId()
Gets value of id.

Specified by:
getId in interface LyGetIdInterface
Overrides:
getId in class LyComponent
Returns:
value of id

getController

public abstract java.lang.String getController()
Gets value of controller.

Specified by:
getController in interface LyGetControllerInterface
Returns:
value of controller

getArea

public abstract LyArea getArea()
Get sub-component Area.

Returns:
sub-component Area

setArea

public abstract void setArea(LyArea area)
Sets sub-component area.

Parameters:
area - New value of area
Throws:
java.lang.IllegalArgumentException - if area is null

setResizable

public abstract void setResizable(boolean resizable)
Change resizable state on this view.


isResizable

public abstract boolean isResizable()
Checks if value of attribute resizable is set.

Returns:
true if resizable is set, false otherwise.

getMinWidth

public abstract int getMinWidth()
Gets value of minWidth.

Returns:
value of minWidth.

getMinHeight

public abstract int getMinHeight()
Gets value of minHeight.

Returns:
value of minHeight.

setLabel

public abstract void setLabel(java.lang.String label)
Sets title of this view.


writeXml

public void writeXml(java.lang.String file,
                     boolean debug,
                     boolean fullView)
Write XML description of this view.

Parameters:
file - the path of the file
debug - True if view is dumped for debug.
fullView - True if the full view is dumped or only its content.

(c) January 2013 - W4 S.A.

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