LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view.win.swing
Class LySwingHeader

java.lang.Object
  extended by leon.view.graphic.LyGraphicalObject
      extended by leon.view.win.swing.LySwingObject
          extended by leon.view.win.swing.LySwingHeader
All Implemented Interfaces:
LyGetIdInterface, LyGetLabelInterface, LyGraphicalComponent, LyGraphicalHeader, LyViewComponent, LyFreeInterface, LySwingComponent

public class LySwingHeader
extends LySwingObject
implements LyGetLabelInterface, LyGetIdInterface, LyGraphicalHeader

This class implements the Header object (as described in the dtd) for swing viewer.

See Also:
LyHeader

Field Summary
static java.lang.String __VERSION
           
 
Constructor Summary
LySwingHeader(LyHeader header)
          Class constructor of a Header object for the Swing target.
 
Method Summary
 short getAlign()
          Gets the align property of this header.
 java.lang.String getId()
          (non-Javadoc).
 java.awt.Image getImage()
          Return the image associated to the header.
 java.lang.String getLabel()
          (non-Javadoc).
 int getSort()
          Gets the header sort level.
 java.awt.Font getSortableHeaderFont()
          Gets the sortable header font.
 java.lang.String getTooltip()
          Gets the header tooltip.
 void initialize()
          Initializes the _sortableHeaderFont to null.
 boolean isFixed()
          Gets the fixed property of this header.
 boolean isIncreasing()
          Gets the increasing property of this header.
 boolean isResizable()
          Gets the resizable property of this header.
 boolean isSortable()
          Gets the sortable property of this header.
 boolean isWrap()
          Gets the wrapped property of this header.
 void setBorderColor(java.lang.String borderColor)
          (Modification) Accessor.
 void setBorderWidth(int borderWidth)
          (Modification) Accessor.
 void setColumnWidth(double columnWidth)
          Sets attribute columnWidth to the given value.
 void setContent()
          Nothing is done here, as a header has no content.
 void setFixed(boolean fixed)
          (non-Javadoc).
 void setIncreasing(boolean increasing)
          (non-Javadoc).
 void setSort(int sort)
          (non-Javadoc).
 
Methods inherited from class leon.view.win.swing.LySwingObject
getBounds, getChildrenBounds, getComponent, getDefaultFrame
 
Methods inherited from class leon.view.graphic.LyGraphicalObject
expand, free, getController, getEnv, getEnvironment, getIdCode, getIntResource, getMessage, getMessage, getResource, getString, getString, getString, getViewComponent, getViewManager, isFreed, isFreeing, isImageAnimated, processDemand, processDemand, testResource, translate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface leon.view.graphic.LyGraphicalComponent
free, getViewComponent
 

Field Detail

__VERSION

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

LySwingHeader

public LySwingHeader(LyHeader header)
Class constructor of a Header object for the Swing target.

Parameters:
header - a HEADER component defined for every type of view targets. This header is initialized specificaly for the Swing view.
Method Detail

initialize

public void initialize()
Initializes the _sortableHeaderFont to null.


setContent

public void setContent()
Nothing is done here, as a header has no content.


setIncreasing

public void setIncreasing(boolean increasing)
(non-Javadoc).

Specified by:
setIncreasing in interface LyGraphicalHeader
Parameters:
increasing - Boolean indicating if attribute increasing is set or unset.
See Also:
LyGraphicalHeader.setIncreasing(boolean)

setFixed

public void setFixed(boolean fixed)
(non-Javadoc).

Specified by:
setFixed in interface LyGraphicalHeader
Parameters:
fixed - Boolean indicating if attribute fixed is set or unset.
See Also:
LyGraphicalHeader.setFixed(boolean)

setSort

public void setSort(int sort)
(non-Javadoc).

Specified by:
setSort in interface LyGraphicalHeader
Parameters:
sort - New value of sort.
See Also:
LyGraphicalHeader.setSort(int)

setBorderColor

public void setBorderColor(java.lang.String borderColor)
(Modification) Accessor.

Specified by:
setBorderColor in interface LyGraphicalHeader
Parameters:
borderColor - New value of borderColor.
See Also:
LyGraphicalHeader.setBorderColor(String)

setBorderWidth

public void setBorderWidth(int borderWidth)
(Modification) Accessor.

Specified by:
setBorderWidth in interface LyGraphicalHeader
Parameters:
borderWidth - New value of borderWidth.
See Also:
LyGraphicalHeader.setBorderWidth(int)

getTooltip

public java.lang.String getTooltip()
Gets the header tooltip.

Returns:
the label to display

getLabel

public java.lang.String getLabel()
(non-Javadoc).

Specified by:
getLabel in interface LyGetLabelInterface
See Also:
LyGetLabelInterface.getLabel()

getImage

public java.awt.Image getImage()
Return the image associated to the header.

Returns:
the image associated to the header or null if no image is associated to the header.

getId

public java.lang.String getId()
(non-Javadoc).

Specified by:
getId in interface LyGetIdInterface
See Also:
LyGetIdInterface.getId()

getSort

public int getSort()
Gets the header sort level.

Returns:
the sort level of this header
See Also:
setSort(int)

isIncreasing

public boolean isIncreasing()
Gets the increasing property of this header.

Returns:
true if increasing is set for the header

isSortable

public boolean isSortable()
Gets the sortable property of this header.

Returns:
true if the header is sortable

isResizable

public boolean isResizable()
Gets the resizable property of this header.

Returns:
true if the header is resizable

isFixed

public boolean isFixed()
Gets the fixed property of this header.

Returns:
true if the header is fixed

isWrap

public boolean isWrap()
Gets the wrapped property of this header.

Returns:
true if the header is wrapped

getAlign

public short getAlign()
Gets the align property of this header.

Returns:
LyHeader#Align.CENTER, LyHeader#Align.LEFT or LyHeader#Align.RIGHT depending on the align property of the header

getSortableHeaderFont

public java.awt.Font getSortableHeaderFont()
Gets the sortable header font.

Returns:
the sortable header font, or null if unspecified

setColumnWidth

public void setColumnWidth(double columnWidth)
Sets attribute columnWidth to the given value.

Specified by:
setColumnWidth in interface LyGraphicalHeader
Parameters:
columnWidth - New value of columnWidth.

(c) January 2013 - W4 S.A.

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