LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LySticker

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyObjectInfo
              extended by leon.info.LySticker
All Implemented Interfaces:
java.lang.Cloneable, LyExtraInfoInterface, LyCommentInterface

public final class LySticker
extends LyObjectInfo
implements LyExtraInfoInterface

This class represents a sticker. It contains the following attributes : - the action on which the sticker is displayed, - the owner of this sticker, - the object on which the sticker is displayed, - the content of the sticker, - the x position of the sticker, - the y position of the sticker, - the width of the sticker, - the height of the sticker.

See Also:
LyObjectInfo

Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.info.LyObjectInfo
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL
 
Constructor Summary
LySticker(java.lang.String id, java.lang.String user, LyAction action, java.lang.String objectId, java.lang.String content, int x, int y, int width, int height)
          Constructor for a sticker.
 
Method Summary
 LySticker cloneSticker()
          Clone a sticker.
 boolean deleteFile()
          Method for deleting sticker file.
 void free()
          Method for freeing extra info (and sub-infos).
 LyAction getAction()
          Get the action referred by this sticker.
 java.lang.String getContent()
          Get the content of this sticker.
 int getHeight()
          Get the height of this sticker.
 java.lang.String getObjectId()
          Get the object id referred by this sticker.
 java.lang.String getUser()
          Get owner of this sticker.
 int getWidth()
          Get the width of this sticker.
 int getX()
          Get the x position of this sticker.
 int getY()
          Get the y position of this sticker.
 boolean saveFile(LyXmlWriterInterface writer)
          Method for saving sticker file.
 void setAction(LyAction action)
          Sets the action referred by this sticker.
 void setContent(java.lang.String content)
          Set the content of the sticker.
 void setHeight(int height)
          Set the height of the sticker.
 void setWidth(int width)
          Set the width of the sticker.
 void setX(int x)
          Set the x position of the sticker.
 void setY(int y)
          Set the y position of the sticker.
 void writeXml(java.io.PrintWriter pw)
          Writes XML corresponding to this sticker element.
 void writeXml(java.io.PrintWriter pw, boolean header, boolean body)
          Method to rewrite XML corresponding to this component.
 
Methods inherited from class leon.info.LyObjectInfo
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName
 
Methods inherited from class leon.info.LyInfo
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
Methods inherited from class leon.info.LyTag
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface leon.info.infointerface.LyExtraInfoInterface
getFile, setFile
 
Methods inherited from interface leon.parser.LyCommentInterface
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values
Constructor Detail

LySticker

public LySticker(java.lang.String id,
                 java.lang.String user,
                 LyAction action,
                 java.lang.String objectId,
                 java.lang.String content,
                 int x,
                 int y,
                 int width,
                 int height)
Constructor for a sticker.

Parameters:
id - the identifier of the sticker.
user - id of the user that owns the sticker.
action - action on which the sticker is displayed.
objectId - id of the object on which the sticker is displayed.
content - content of the sticker.
x - x position of the sticker.
y - y position of the sticker.
width - width of the sticker.
height - height of the sticker.
Method Detail

cloneSticker

public LySticker cloneSticker()
Clone a sticker.


free

public void free()
Method for freeing extra info (and sub-infos).

Specified by:
free in interface LyExtraInfoInterface

saveFile

public boolean saveFile(LyXmlWriterInterface writer)
Method for saving sticker file.

Specified by:
saveFile in interface LyExtraInfoInterface
Returns:
True if successful.

deleteFile

public boolean deleteFile()
Method for deleting sticker file.

Specified by:
deleteFile in interface LyExtraInfoInterface
Returns:
True if successful.

writeXml

public void writeXml(java.io.PrintWriter pw,
                     boolean header,
                     boolean body)
Method to rewrite XML corresponding to this component.

Specified by:
writeXml in interface LyExtraInfoInterface
Parameters:
pw - The printWriter on which the XML is written.
header - Boolean indicating if header must be written.
header - Boolean indicating if body must be written.

writeXml

public void writeXml(java.io.PrintWriter pw)
Writes XML corresponding to this sticker element.

Specified by:
writeXml in interface LyExtraInfoInterface
Parameters:
pw - PrintWriter on which the XML is written.

getAction

public LyAction getAction()
Get the action referred by this sticker.

Returns:
The concerned action.

getObjectId

public java.lang.String getObjectId()
Get the object id referred by this sticker.

Returns:
the object id referred by this sticker.

getContent

public java.lang.String getContent()
Get the content of this sticker.

Returns:
the content of this sticker.

getX

public int getX()
Get the x position of this sticker.

Returns:
the x position of this sticker.

getY

public int getY()
Get the y position of this sticker.

Returns:
the y position of this sticker.

getWidth

public int getWidth()
Get the width of this sticker.

Returns:
the width of this sticker.

getHeight

public int getHeight()
Get the height of this sticker.

Returns:
the height of this sticker.

getUser

public java.lang.String getUser()
Get owner of this sticker.

Specified by:
getUser in interface LyExtraInfoInterface
Returns:
The owner of this sticker.

setAction

public void setAction(LyAction action)
Sets the action referred by this sticker.

Parameters:
action - action concerned by this sticker.

setContent

public void setContent(java.lang.String content)
Set the content of the sticker.

Parameters:
content - the content of the sticker.

setX

public void setX(int x)
Set the x position of the sticker.

Parameters:
x - the x position of the sticker.

setY

public void setY(int y)
Set the y position of the sticker.

Parameters:
y - the y position of the sticker.

setWidth

public void setWidth(int width)
Set the width of the sticker.

Parameters:
width - the width of the sticker.

setHeight

public void setHeight(int height)
Set the height of the sticker.

Parameters:
height - the height of the sticker.

(c) January 2013 - W4 S.A.

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