LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LySelectBar

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyPanel
              extended by leon.view.LySelectBar
All Implemented Interfaces:
LyGetConstraintInterface, LyGetControllerInterface, LyGetIdInterface, LyGetLabelInterface, LyPdfInterface, LySetControllerInterface, LySetLabelInterface, LySetWaitingInterface, LyUpdateViewContentInterface

public class LySelectBar
extends LyPanel
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LyGetControllerInterface, LySetControllerInterface, LyGetConstraintInterface

The LySelectBar class is a generated Java implementation that corresponds to the element SELECTBAR of the descriptive grammar of the views (views.dtd). <SELECTBAR> : Navigation bar A navigation bar allows displaying a set of page numbers (or page names) in order to go directly to the selected page. This bar must be associated to an area presenting paginated data (a long list for example).

See Also:
See also tag SELECTBAR of grammar leon_views.dtd.

Nested Class Summary
 
Nested classes/interfaces inherited from class leon.view.LyComponent
LyComponent.EventType
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.view.LyComponent
_nbComponents, INIT_RESOURCE_ID, INTERNAL_ID_SEP, REWRITING_MODE, SEP_ID
 
Constructor Summary
LySelectBar(java.lang.String id)
          Constructor with all required attributes.
 
Method Summary
 void addSelectItem(LySelectItem selectItem)
          Adds a sub-component selectItem.
 void addSep()
          Adds a separator.
 LyComponent cloneComponent()
          Method for cloning a component.
 java.lang.String getColor()
          Gets value of color.
 LyComponent getComponent(int i)
          Get sub-component Component of index i.
 int getComponentCount()
          Get sub-component Component count.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getController()
          Gets value of controller.
 java.lang.String getDisabledColor()
          Gets value of disabledColor.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 java.lang.String getFontTitle()
          Gets value of fontTitle.
 LyFormField getFormField()
          Get sub-component FormField.
 java.lang.String getHighlightColor()
          Gets value of highlightColor.
 java.lang.String getHrefColor()
          Gets value of hrefColor.
 java.lang.String getId()
          Gets value of id.
 int getItemCount()
          Gets value of itemCount.
 java.lang.String getLabel()
          Gets value of label.
 java.lang.String getPageFirstImage()
          Gets value of pageFirstImage.
 java.lang.String getPageLastImage()
          Gets value of pageLastImage.
 java.lang.String getPageNextImage()
          Gets value of pageNextImage.
 java.lang.String getPagePreviousImage()
          Gets value of pagePreviousImage.
 java.lang.String getPageShowNextImage()
          Gets value of pageShowNextImage.
 java.lang.String getPageShowPreviousImage()
          Gets value of pageShowPreviousImage.
 int getStartItem()
          Gets value of startItem.
 LySelectBar getTemplate()
          Gets value of template.
 java.lang.String getVisitedColor()
          Gets value of visitedColor.
 void insertSelectItem(LySelectItem selectItem, int pos)
          Inserts a sub-component selectItem at given position.
 void insertSep(int pos)
          Inserts a separator at the given position.
 boolean isDefaultColor()
          Checks whether the color attribute is valuated to the default value.
 boolean isDefaultDisabledColor()
          Checks whether the disabledColor attribute is valuated to the default value.
 boolean isDefaultFont()
          Checks whether the font attribute is valuated to the default value.
 boolean isDefaultFontColor()
          Checks whether the fontColor attribute is valuated to the default value.
 boolean isDefaultFontTitle()
          Checks whether the fontTitle attribute is valuated to the default value.
 boolean isDefaultHighlightColor()
          Checks whether the highlightColor attribute is valuated to the default value.
 boolean isDefaultHrefColor()
          Checks whether the hrefColor attribute is valuated to the default value.
 boolean isDefaultPageFirstImage()
          Checks whether the pageFirstImage attribute is valuated to the default value.
 boolean isDefaultPageLastImage()
          Checks whether the pageLastImage attribute is valuated to the default value.
 boolean isDefaultPageNextImage()
          Checks whether the pageNextImage attribute is valuated to the default value.
 boolean isDefaultPagePreviousImage()
          Checks whether the pagePreviousImage attribute is valuated to the default value.
 boolean isDefaultPageShowNextImage()
          Checks whether the pageShowNextImage attribute is valuated to the default value.
 boolean isDefaultPageShowPreviousImage()
          Checks whether the pageShowPreviousImage attribute is valuated to the default value.
 boolean isDefaultVisitedColor()
          Checks whether the visitedColor attribute is valuated to the default value.
 void removeSelectItem(LySelectItem selectItem)
          Removes a sub-component selectItem.
 void removeSep(int pos)
          Removes a separator at the given position.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 void setController(java.lang.String controller)
          Initializes attribute controller to the given value.
 void setDisabledColor(java.lang.String disabledColor)
          Initializes attribute disabledColor to the given value.
 void setFont(java.lang.String font)
          Initializes attribute font to the given value.
 void setFontColor(java.lang.String fontColor)
          Initializes attribute fontColor to the given value.
 void setFontTitle(java.lang.String fontTitle)
          Initializes attribute fontTitle to the given value.
 void setFormField(LyFormField formField)
          Sets sub-component formField.
 void setHighlightColor(java.lang.String highlightColor)
          Initializes attribute highlightColor to the given value.
 void setHrefColor(java.lang.String hrefColor)
          Initializes attribute hrefColor to the given value.
 void setItemCount(int itemCount)
          Initializes attribute itemCount to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label to the given value.
 void setPageFirstImage(java.lang.String pageFirstImage)
          Initializes attribute pageFirstImage to the given value.
 void setPageLastImage(java.lang.String pageLastImage)
          Initializes attribute pageLastImage to the given value.
 void setPageNextImage(java.lang.String pageNextImage)
          Initializes attribute pageNextImage to the given value.
 void setPagePreviousImage(java.lang.String pagePreviousImage)
          Initializes attribute pagePreviousImage to the given value.
 void setPageShowNextImage(java.lang.String pageShowNextImage)
          Initializes attribute pageShowNextImage to the given value.
 void setPageShowPreviousImage(java.lang.String pageShowPreviousImage)
          Initializes attribute pageShowPreviousImage to the given value.
 void setStartItem(int startItem)
          Sets attribute startItem to the given value.
 void setTemplate(LySelectBar template)
          Initializes attribute template to the given value.
 void setVisitedColor(java.lang.String visitedColor)
          Initializes attribute visitedColor to the given value.
 void writeXml(java.io.PrintWriter pw, boolean debug)
          Method to rewrite XML corresponding to this component.
 
Methods inherited from class leon.view.LyPanel
generatePdf, getLastModified, isIdle, isScrollable, print, setIdle, setLastModified, setPopupMenu, setWaiting
 
Methods inherited from class leon.view.LyFieldItem
addBeanData, buildBean, free, getBean, getBeanComponent, getBeanData, getBeanDatas, getChild, getChildCount, getErrorMessage, getFieldValue, getValue, setBean, setBeanComponent, setBeanDatas, setFieldValue, updateViewContent, validateInput
 
Methods inherited from class leon.view.LyComponent
addComponent, addData, addEventFunction, clearChildrenBounds, freeze, getBounds, getChildFromCache, getChildrenBounds, getComponent, getComponent, getComponent, getComponent, getComponent, getComponentAt, getComponentAt, getComponentByInternalId, getComponentByLabel, getComponents, getComponentWithModel, getData, getDatas, getEnvironment, 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, setVisible, useEventDefaultFunction, 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
Constructor Detail

LySelectBar

public LySelectBar(java.lang.String id)
Constructor with all required attributes.

Parameters:
id - Identifier of the navigation bar.
Method Detail

cloneComponent

public LyComponent cloneComponent()
Method for cloning a component.

Specified by:
cloneComponent in class LyComponent

getId

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

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

getTemplate

public LySelectBar getTemplate()
Gets value of template.

Returns:
value of template.

getLabel

public java.lang.String getLabel()
Gets value of label.

Specified by:
getLabel in interface LyGetLabelInterface
Returns:
value of label.

getStartItem

public int getStartItem()
Gets value of startItem.

Returns:
value of startItem.

getItemCount

public int getItemCount()
Gets value of itemCount.

Returns:
value of itemCount.

getController

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

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

getColor

public java.lang.String getColor()
Gets value of color.

Returns:
value of color.

isDefaultColor

public boolean isDefaultColor()
Checks whether the color attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getHrefColor

public java.lang.String getHrefColor()
Gets value of hrefColor.

Returns:
value of hrefColor.

isDefaultHrefColor

public boolean isDefaultHrefColor()
Checks whether the hrefColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getDisabledColor

public java.lang.String getDisabledColor()
Gets value of disabledColor.

Returns:
value of disabledColor.

isDefaultDisabledColor

public boolean isDefaultDisabledColor()
Checks whether the disabledColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getFont

public java.lang.String getFont()
Gets value of font.

Returns:
value of font.

isDefaultFont

public boolean isDefaultFont()
Checks whether the font attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getFontColor

public java.lang.String getFontColor()
Gets value of fontColor.

Returns:
value of fontColor.

isDefaultFontColor

public boolean isDefaultFontColor()
Checks whether the fontColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getHighlightColor

public java.lang.String getHighlightColor()
Gets value of highlightColor.

Returns:
value of highlightColor.

isDefaultHighlightColor

public boolean isDefaultHighlightColor()
Checks whether the highlightColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getVisitedColor

public java.lang.String getVisitedColor()
Gets value of visitedColor.

Returns:
value of visitedColor.

isDefaultVisitedColor

public boolean isDefaultVisitedColor()
Checks whether the visitedColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getFontTitle

public java.lang.String getFontTitle()
Gets value of fontTitle.

Returns:
value of fontTitle.

isDefaultFontTitle

public boolean isDefaultFontTitle()
Checks whether the fontTitle attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPageFirstImage

public java.lang.String getPageFirstImage()
Gets value of pageFirstImage.

Returns:
value of pageFirstImage.

isDefaultPageFirstImage

public boolean isDefaultPageFirstImage()
Checks whether the pageFirstImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPagePreviousImage

public java.lang.String getPagePreviousImage()
Gets value of pagePreviousImage.

Returns:
value of pagePreviousImage.

isDefaultPagePreviousImage

public boolean isDefaultPagePreviousImage()
Checks whether the pagePreviousImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPageShowPreviousImage

public java.lang.String getPageShowPreviousImage()
Gets value of pageShowPreviousImage.

Returns:
value of pageShowPreviousImage.

isDefaultPageShowPreviousImage

public boolean isDefaultPageShowPreviousImage()
Checks whether the pageShowPreviousImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPageLastImage

public java.lang.String getPageLastImage()
Gets value of pageLastImage.

Returns:
value of pageLastImage.

isDefaultPageLastImage

public boolean isDefaultPageLastImage()
Checks whether the pageLastImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPageNextImage

public java.lang.String getPageNextImage()
Gets value of pageNextImage.

Returns:
value of pageNextImage.

isDefaultPageNextImage

public boolean isDefaultPageNextImage()
Checks whether the pageNextImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPageShowNextImage

public java.lang.String getPageShowNextImage()
Gets value of pageShowNextImage.

Returns:
value of pageShowNextImage.

isDefaultPageShowNextImage

public boolean isDefaultPageShowNextImage()
Checks whether the pageShowNextImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getComponent

public LyComponent getComponent(int i)
Get sub-component Component of index i.

Parameters:
i - the index of the Component to get.
Returns:
sub-component Component of index i.

getComponentCount

public int getComponentCount()
Get sub-component Component count.

Returns:
sub-component Component count.

getFormField

public LyFormField getFormField()
Get sub-component FormField.

Returns:
sub-component FormField.

getConstraint

public LyConstraint getConstraint()
Get sub-component Constraint.

Specified by:
getConstraint in interface LyGetConstraintInterface
Returns:
sub-component Constraint.

setTemplate

public void setTemplate(LySelectBar template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setLabel

public void setLabel(java.lang.String label)
Sets attribute label to the given value.

Specified by:
setLabel in interface LySetLabelInterface
Overrides:
setLabel in class LyFieldItem
Parameters:
label - New value of label.

setStartItem

public void setStartItem(int startItem)
Sets attribute startItem to the given value.

Parameters:
startItem - New value of startItem.

setItemCount

public void setItemCount(int itemCount)
Initializes attribute itemCount to the given value.

Parameters:
itemCount - New value of itemCount.

setController

public void setController(java.lang.String controller)
Initializes attribute controller to the given value.

Specified by:
setController in interface LySetControllerInterface
Parameters:
controller - New value of controller.
See Also:
LySetControllerInterface.setController(java.lang.String)

setColor

public void setColor(java.lang.String color)
Initializes attribute color to the given value.

Parameters:
color - New value of color.

setHrefColor

public void setHrefColor(java.lang.String hrefColor)
Initializes attribute hrefColor to the given value.

Parameters:
hrefColor - New value of hrefColor.

setDisabledColor

public void setDisabledColor(java.lang.String disabledColor)
Initializes attribute disabledColor to the given value.

Parameters:
disabledColor - New value of disabledColor.

setFont

public void setFont(java.lang.String font)
Initializes attribute font to the given value.

Parameters:
font - New value of font.

setFontColor

public void setFontColor(java.lang.String fontColor)
Initializes attribute fontColor to the given value.

Parameters:
fontColor - New value of fontColor.

setHighlightColor

public void setHighlightColor(java.lang.String highlightColor)
Initializes attribute highlightColor to the given value.

Parameters:
highlightColor - New value of highlightColor.

setVisitedColor

public void setVisitedColor(java.lang.String visitedColor)
Initializes attribute visitedColor to the given value.

Parameters:
visitedColor - New value of visitedColor.

setFontTitle

public void setFontTitle(java.lang.String fontTitle)
Initializes attribute fontTitle to the given value.

Parameters:
fontTitle - New value of fontTitle.

setPageFirstImage

public void setPageFirstImage(java.lang.String pageFirstImage)
Initializes attribute pageFirstImage to the given value.

Parameters:
pageFirstImage - New value of pageFirstImage.

setPagePreviousImage

public void setPagePreviousImage(java.lang.String pagePreviousImage)
Initializes attribute pagePreviousImage to the given value.

Parameters:
pagePreviousImage - New value of pagePreviousImage.

setPageShowPreviousImage

public void setPageShowPreviousImage(java.lang.String pageShowPreviousImage)
Initializes attribute pageShowPreviousImage to the given value.

Parameters:
pageShowPreviousImage - New value of pageShowPreviousImage.

setPageLastImage

public void setPageLastImage(java.lang.String pageLastImage)
Initializes attribute pageLastImage to the given value.

Parameters:
pageLastImage - New value of pageLastImage.

setPageNextImage

public void setPageNextImage(java.lang.String pageNextImage)
Initializes attribute pageNextImage to the given value.

Parameters:
pageNextImage - New value of pageNextImage.

setPageShowNextImage

public void setPageShowNextImage(java.lang.String pageShowNextImage)
Initializes attribute pageShowNextImage to the given value.

Parameters:
pageShowNextImage - New value of pageShowNextImage.

addSelectItem

public void addSelectItem(LySelectItem selectItem)
Adds a sub-component selectItem.

Parameters:
selectItem - The selectItem to add to components list.

insertSelectItem

public void insertSelectItem(LySelectItem selectItem,
                             int pos)
Inserts a sub-component selectItem at given position.

Parameters:
selectItem - The selectItem to add to components list.
pos - Position where the sub-component is inserted.

removeSelectItem

public void removeSelectItem(LySelectItem selectItem)
Removes a sub-component selectItem.

Parameters:
selectItem - The selectItem to remove to components list.
Throws:
java.lang.IllegalStateException - if components list is empty.
java.lang.IllegalArgumentException - if components list doesn't contain selectItem.

addSep

public void addSep()
Adds a separator.


insertSep

public void insertSep(int pos)
Inserts a separator at the given position.

Parameters:
pos - Position where the separator is inserted.

removeSep

public void removeSep(int pos)
Removes a separator at the given position.

Parameters:
pos - Position where the separator is removed.
Throws:
java.lang.IllegalStateException - if components list is empty.
java.lang.IllegalArgumentException - if components list doesn't contain a separator at the given position.

setFormField

public void setFormField(LyFormField formField)
Sets sub-component formField.

Parameters:
formField - New value of formField

setConstraint

public void setConstraint(LyConstraint constraint)
Sets sub-component constraint.

Parameters:
constraint - New value of constraint

writeXml

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

Specified by:
writeXml in class LyComponent
Parameters:
pw - the printWriter on which the XML is written.
debug - true if debug mode (full dump).

(c) January 2013 - W4 S.A.

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